Ordered Models Statistics API

The Ordered Models Statistics API allows you to retrieve the details of all the models that were ordered through our platform. The response returns a list of all the models for a given time period.

The Ordered Models Statistics API is for for referral partners to follow up the ordered models of customers they have been forwarding to i.materialise.

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

The Ordered Models Statistics API works by retrieving data from our service. 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 Ordered Models Statistics API can be tried out over our demo page:

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

The Ordered Models Statistics API gives a detailed information about all ordered models for a specified date range that were placed with different toolIDs linked to one API code.

Request should be done using HTTP GET request to:

https://<<server-name>>/web-api/models/orderstatus

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

https://<<server-name>>/web-api/models/orderstatus?dateFrom=01-10-2016&dateTo=31-12-2016&skip=5&take=10

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

Response example in JSON

{
    "models":[
        {
            "modelId":"9796b4b6-3623-492a-9f43-464b3981cd5a",
            "uploadDate":"25-10-2016",
            "modelFileName":"10x10x10.stl",
            "totalOrdered":1,
            "totalCanceled":0,
            "totalShipped":0
        },
        {
            "modelId":"553eee43-38a4-4b55-b760-14bb7c29d650",
            "uploadDate":"25-10-2016",
            "modelFileName":"10x10x10.stl",
            "totalOrdered":1,
            "totalCanceled":0,
            "totalShipped":0
        }
    ],
    "total":78,
    "dateFrom":"01-10-2016",
    "dateTo":"02-11-2016"
}

Response example in XML

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DateFrom>01-10-2016</DateFrom>
  <DateTo>02-11-2016</DateTo>
  <Models>
    <Model>
      <ModelId>9796b4b6-3623-492a-9f43-464b3981cd5a</ModelId>
      <UploadDate>25-10-2016</UploadDate>
      <ModelFileName>10x10x10.stl</ModelFileName>
      <TotalOrdered>1</TotalOrdered>
      <TotalCanceled>0</TotalCanceled>
      <TotalShipped>0</TotalShipped>
    </Model>
    <Model>
      <ModelId>553eee43-38a4-4b55-b760-14bb7c29d650</ModelId>
      <UploadDate>25-10-2016</UploadDate>
      <ModelFileName>10x10x10.stl</ModelFileName>
      <TotalOrdered>1</TotalOrdered>
      <TotalCanceled>0</TotalCanceled>
      <TotalShipped>0</TotalShipped>
    </Model>
  </Models>
  <Total>78</Total>
</Response>

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

{
    "total":0,
    "error":{
        "message":"Value of take request parameter is less than 0,
         please choose more suitable value.",
        "code":255
    }
}

Example of Response with error in XML

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>Skip request parameter is bigger than Total, please choose more suitable value. Total is response parameter.</Message>
    <Code>253</Code>
  </Error>
  <Total>0</Total>
</Response>