Sections

• Overview
• API Usage
• Errors

Guides

Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.

Make & Model API Calls

Make Model

POST /makemodel/{storeid}/{serial}

Purpose

To return the make and model of a product using the supplied serial number.

Inputs

• storeid - The valid ID of the store making the request.
• serial - A valid serial number. This must consist only of alpha-numeric characters (a-z and 0-9) and be at least 3 characters in length.
• category - OPTIONAL - A numeric category number to identify the type of product the serial relates to. This defaults to 1. Setting this to 0 (zero) will perform the search on all product categories. At present this method supports the following product categories:-
  
  

  ID	Category Name
  1	Mobile Phone IMEI's (GSM Only) and Serials

Example Request

curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/makemodel/12345/123456123456123

Output

A JSON object containing the make and model of the handset. In the event of an error a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.

The response will contain one of two objects. If your request provided a category which was not zero then the response object will contain a "make" element and a "models". The "models" elemend will be an array containing various model values that are connected with the serial.

If zero is supplied as the category for the makemodel search then a "multiple" object will be returned. This object contain an array. Each element in this array will be identical to the object returned when a non-zero category number is supplied. However, each object will contain a the category that the discovered match is associated with.

Example Response

Response on Success:

HTTP/1.1 200 OK
Content-Type: application/json 

{
    "make": "make",
    "models": ["model 1","model 2"]
}

Response on Success (With multiple devices matching the serial.):

HTTP/1.1 200 OK
Content-Type: application/json 

{
    "multiple": 
    [
        { "make": "make 1",
          "models": ["model 1","model 2"],
          "category": 1
        }
    ],
    [
        { "make": "make 2",
          "models": ["model 1"],["model 2"],
          "category": 1
        }
    ]
}

Response on Failure:

HTTP/1.1 404 Not Found
Content-Type: application/json 

{
    "errors":
    [
        {
            "id": 404,
            "message": "{serial} is not a GSM handset IMEI. 
            Only GSM handsets can be identified at present."
        }
    ]
}