Uploaded Models Reporting 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 Reporting API gives detailed information per uploaded model for a specified date range. The Uploaded Models Reporting API gives detailed information per uploaded model for a specified date range. The models need to be tagged with a personal tool ID in order to show up in the report. Since models can be reused several times for different cart items, a model can have a status ‘cancelled’ and at the same time a status ‘ordered’, dependent of the status of the linked cart items. The Reporting API also allows seeing whether the uploaded model file was deleted from our server or not.

Request should be done using HTTP POST request to:

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

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

Example of request in JSON

 {
   "dateFrom": "2013-01-01",
   "dateTo": "2014-12-01",
   "toolId": "418674f3-f8a5-43bd-a06d-e8e95831b2d9",
   "modelId":"79507760-3ed6-4003-bbd0-4a2062124d8f"
}

Example of request in XML

 <UploadedModelsRequest>
  <DateFrom>2013-01-01</DateFrom>
  <DateTo>2014-12-01</DateTo>
  <ToolId>418674f3-f8a5-43bd-a06d-e8e95831b2d9</ToolId>
  <ModelId>0ab3f316-5df4-4a77-a01d-46210943ac56</ModelId>
</UploadedModelsRequest>

This is the list of model parameters returned into the response Models section:

Response example in JSON

{
    "modelId":"79507760-3ed6-4003-bbd0-4a2062124d8f",
    "models":[
        {
            "modelId":"79507760-3ed6-4003-bbd0-4a2062124d8f",
            "toolId":"418674f3-f8a5-43bd-a06d-e8e95831b2d9",
            "uploadDate":"2014-11-05T02:43:18.057",
            "modelFileName":"Box.stl",
            "wasDeleted":false,
            "wasOrdered":true,
            "wasCanceled":false,
            "xDimMm":10.0000000000,
            "yDimMm":10.0000000000,
            "zDimMm":10.0000000000,
            "volumeCm3":1.0000000000,
            "surfaceCm2":6.0000000000,
            "processingResult":"Succeeded"
        }
    ],
    "dateFrom":"2013-01-01",
    "dateTo":"2014-12-01",
    "toolId":"418674f3-f8a5-43bd-a06d-e8e95831b2d9"
}

Response example in XML

<UploadedModelsResponse 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>
  <ModelId>0ab3f316-5df4-4a77-a01d-46210943ac56</ModelId>
  <Models>
    <UploadedModelDto>
      <ModelId>0ab3f316-5df4-4a77-a01d-46210943ac56</ModelId>
      <ToolId>418674f3-f8a5-43bd-a06d-e8e95831b2d9</ToolId>
      <UploadDate>2014-11-07T04:06:42.467</UploadDate>
      <ModelFileName>2print_bad.stl</ModelFileName>
      <WasDeleted>false</WasDeleted>
      <WasOrdered>false</WasOrdered>
      <WasCanceled>false</WasCanceled>
      <XDimMm>73.7159000000</XDimMm>
      <YDimMm>118.8810000000</YDimMm>
      <ZDimMm>27.3087000000</ZDimMm>
      <VolumeCm3>85.2411000000</VolumeCm3>
      <SurfaceCm2>354.9360000000</SurfaceCm2>
      <ProcessingResult>StillNeedsFixing</ProcessingResult>
    </UploadedModelDto>
  </Models>
</UploadedModelsResponse>

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

{
    "error":{
        "message":"Model with ModelId=79507760-3ed6-4003-bbd0-4a2062124d8f9 has not been found or was uploaded by using another ToolId.",
        "code":207
    }
} 
 

Example of Response with error in XML

<UploadedModelsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>Wrong request body. Check if all parameters set correctly</Message>
    <Code>205</Code>
  </Error>
</UploadedModelsResponse>