Uploaded Models Statistics Report API

The Reporting API allows you to retrieve information about the uploaded models that were tagged with your personal tool IDs. This is done through 2 separate APIs:

• The Uploaded Models Reporting API which provides in depth information per model
• The Uploaded Models Statistics Report API which provides a summary per status of the models

The Order Status API is for users that want to retrieve information about their tagged models that have been uploaded to the i.materialise server. If you are using the 3D print lab connection API and the Cart API, this API will provide you in a quick way with the information of how many models were uploaded and which of them converted into an order. The Cart Ordering API users might find this API less interesting since they control the ordering flow of models from beginning till the end. The Reporting API will reflect what they already know and it can come in handy when analyzing statistics.

This API requires the personal API code. It is therefore not possible to use AJAX requests.

The Reporting API works by posting data to our service. You can use either XML or JSON formats for posting. The HTTP encoding type of a particular request depends on the type of API you are going to use. This will be described in the corresponding documentation. To specify the exact content type which your client can accept and parse, the Accept header in your request has to be set to one of the following encoding types:

• text/json
• application/json
• text/xml
• application/xml

The API code needs to be specified in the API code HTTP header.

The Reporting API can be tried out over our demo pages:

• The Uploaded Models Reporting API demo page:
  

https://i.materialise.com/api/demo/uploaded-models-reporting-api.htm

• The Uploaded Models Statistics Report API demo page:
  

https://i.materialise.com/api/demo/uploaded-models-statistics-report-api.htm

The Uploaded Models Statistics Report API gives statistics information about uploaded models. It returns how many of the uploaded models were ordered, cancelled or just uploaded within the requested date range.

If the report doesn’t return the info per model, it returns a summary of the statuses. To get info on model level, you need to use the Uploaded Models Reporting API.

Request should be done using HTTP POST request to:

https://<<server-name>>/web-api/reporting/models/uploadedstatistics

The request will look like this (parameters names are not case-sensitive):

This is the list of model parameters the requester has to pass in order to get an uploaded models statistics.

Example of request in JSON

 {
   "dateFrom": "2013-01-01",
   "dateTo": "2014-12-01",
   "toolId": "418674f3-f8a5-43bd-a06d-e8e95831b2d9"
}

Example of request in XML

 <UploadedModelsStatisticsRequest>
  <DateFrom>2013-01-01</DateFrom>
  <DateTo>2014-12-01</DateTo>
  <ToolId>418674f3-f8a5-43bd-a06d-e8e95831b2d9</ToolId>
</UploadedModelsStatisticsRequest>

This is the list of model parameters returned into the response Filter/Error sections:

If the request is processed successfully, the response looks like this:

Response example in JSON

{
    "totalUploads":36,
    "uploadsOrdered":1,
    "uploadsCancelled":0,
    "uploadedOnly":35,
    "dateFrom":"2013-01-01",
    "dateTo":"2014-12-01"
}

Response example in XML

<UploadedModelsStatisticsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DateFrom>2013-01-01</DateFrom>
  <DateTo>2014-12-01</DateTo>
  <ToolId>418674f3-f8a5-43bd-a06d-e8e95831b2d9</ToolId>
  <TotalUploads>36</TotalUploads>
  <UploadsOrdered>1</UploadsOrdered>
  <UploadsCancelled>0</UploadsCancelled>
  <UploadedOnly>35</UploadedOnly>
</UploadedModelsStatisticsResponse>

If a wrong/empty API code is used, then a 401 error is returned with the response statusText=”Unauthorized”.

The parameter “Error” is added to the request only if the request wasn’t processed successfully. The value of this parameter is set according to the table below. If the request wasn’t processed successfully, the list of models will be empty.

Example of Response with error in JSON

{
    "totalUploads":0,
    "uploadsOrdered":0,
    "uploadsCancelled":0,
    "uploadedOnly":0,
    "error":{
        "message":"Please provide DateFrom in format YYYY-MM-DD",
        "code":202
    }
}
 

Example of Response with error in XML

<UploadedModelsStatisticsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>DateFrom should be less or equal to DateTo</Message>
    <Code>204</Code>
  </Error>
  <TotalUploads>0</TotalUploads>
  <UploadsOrdered>0</UploadsOrdered>
  <UploadsCancelled>0</UploadsCancelled>
  <UploadedOnly>0</UploadedOnly>
</UploadedModelsStatisticsResponse>