POST generateReport
https://m360soft.com/api/customer/v2/generateReport
Creates a PDF / HTML report from the specified details of the given device session
Request parameters
| Name | Type | Description |
|---|---|---|
diagnosticsResultId |
integer | ID of the DiagnosticsResult object to include in the report. The default value is the ID of the last diagnostics test result of the session. Optional. |
contents |
array | List of the content parts to include in the report. Default: all contents. Optional, possible values: ["diagnostics", "grading", "wipe", "oem_check", "device_expenses", "grading_photos"]. |
dateTimeFormat |
string | Date/time format to use in the report. Default: dd/MM/yyyy HH:mm. Optional, possible values: ["dd/MM/yyyy HH:mm", "MM/dd/yyyy HH:mm", "yyyy/MM/dd HH:mm"]. |
timeZone |
string | Timezone to use (eg.: "UTC", "Europe/Berlin" etc.) when displaying dates and times in the report. Default: UTC. Optional, max. 100 characters. |
sessionId |
string | The unique ID of the device session. Required, exactly 36 characters. |
locale |
string | ISO 639-1 language code that is supported by the application. Optional, exactly 2 characters, Allowed values: "de","en","es","fr","hu","it","pt","ru","tr","uk","zh","lt","pl","ja","ro","hi","ko". |
testing |
bool | Setting this value to true will result in a response populated only with syntactically correct test data which can be used to test the API integration. While your account is in testing mode the value of this parameter is always true and cannot be overridden. Optional. |
Examples
200
OK
POST https://m360soft.com/api/customer/v2/generateReport
Request
POST https://m360soft.com/api/customer/v2/generateReportContent-Type: application/json{ "sessionId": "bc883c8b-46d3-ef73-924d-23005e7e8e13", "contents": [ "diagnostics", "grading" ] }
Response application/json
{
"data": {
"diagnosticsReport": {
"id": "15d8-3390b0bbfadb61e0b4c3f-20200115",
"htmlLink": "https://m360soft.com/reports/diagnostics/sample.html",
"pdfLink": "https://m360soft.com/reports/diagnostics/sample.pdf"
}
},
"meta": {
"success": true
}
}