Data Api
Models

Validation Requests

Models

Validation Request

Schema

{
    "id": "number",
    "manufacturer": "string",
    "model": "string",
    "range": "string",
    "url": "string (url)",
    "notes": "string",
    "reference": "string",
    "status": "number",
    "statusReason": "string"
}

Properties

  • id - SpecCheck's Id for the validation request. (Responses only)
  • manufacturer - The expected manufacturer name of the request.
  • model - The expected model name of the request.
  • range - The expected range of the requested model.
  • url - Url to additional documentation to assist the SpecCheck team.
  • notes - Additional notes to the SpecCheck team.
  • reference - Your unique reference to the request.
  • status - Current status for the request.
  • statusReason - Reason provided by SpecCheck for the status decision.

Validation Request Collection

Schema

{
    "results": [
        ... validationRequest
    ],
    "pagination": {
        "total": "number",
        "returned": "number",
        "totalPages": "number",
        "page": {
            "index": "number",
            "size": "number"
        }
    }
}

Validation Statuses

Code Name Description
100 New New request, yet to be looked at by the SpecCheck team.
200 Matched The request is valid and has been matched to equipment in the SpecCheck system.
201 Partial Match The request is valid but the Manufacturer or Model was not quite correct.
300 Rejected The request is has been rejected and is not a valid piece of equipment.
400 Duplicate The request has been matched to an existing request using the Manufacturer/Model.