Report Manager API

Authentication

In order to use the API, you need to obtain an access token with required scope audit-report:create. Please refer to the documentation about details of authentication process.

Validation

Description

This API allows to preliminary validate the report without initialing a real report processing in AI Cost Control. The endpoint has a timeout of 30 seconds. If the processing time exceeds this limit, you will receive a 408 response (Request Timeout).

Endpoint URLs

Production: https://entry.scalepoint.com/forsi-report-manager/api/validate

Sandbox: https://sandbox.scalepoint.com/forsi-report-manager/api/validate

Example Request JSON Body

An authorized HTTP POST request should be sent to one of the API URLs from the above

{
  "report": {
    "companyCode": "68",
    "company": "TR",
    "id": 265932237,
    "key": "RP99944230031H"
    ...
  }
}

Example of responses

Status: 200 OK

{
  "succeeded": true,
  "rules": [
    {
      "name": "SomeRule",
      "explanation": ""
    }
  ]
}

Status: 408 Request Timeout

{
  "succeeded": false
}

Status: 500 Internal Server Error

{
  "succeeded": false
}

Pre-qualification

Description

This API allows to preliminary validate the report for a repair shop without submitting a real report to AI Cost Control. The endpoint has a timeout of 5 seconds. If the processing time exceeds this limit, you will receive a 408 response (Request Timeout).

Endpoint URLs

Production: https://entry.scalepoint.com/forsi-report-manager/api/prequalify

Sandbox: https://sandbox.scalepoint.com/forsi-report-manager/api/prequalify

Example Request JSON Body

An authorized HTTP POST request should be sent to one of the API URLs from the above

{
  "report": {
    "companyCode": "68",
    "company": "TR",
    "id": 265932238,
    "key": "RP99944230171H"
    ...
  }
}

Example of responses

Status: 200 OK

{
  "succeeded": true,
  "messages": [
    "Need more photos"
  ]
}

Status: 408 Request Timeout

{
  "succeeded": false
}

Status: 500 Internal Server Error

{
  "succeeded": false
}