Virima API Specification - ScanService Services
The requests documented in this section are directed to
ScanService resources, which represent .
getScans GET Interface
Method: GET
Relative URL: scan/get-all
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Response Structure:
Field Name | Type | Description |
---|
listOfScanRecord | ListOfScanRecord | |
Example Request:
Example Response:
{
"id":2147483647,
"scanRecords":[
{
"id":2147483647,
"_id":"?",
"status":"?",
"decription":"?",
"runBy":"?",
"noRecordsUpdated":"?",
"scanId":"?",
"sheetName":"?",
"fileName":"?",
"date":"?",
"imported":?
} ]
}
getAllScanNames GET Interface
Method: GET
Relative URL: scan/get-all-names
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Response Structure:
Field Name | Type | Description |
---|
listOfScanName | ListOfScanName | |
Example Request:
Example Response:
{
"id":354991837,
"scanNames":[
{
"id":1269141956,
"scanId":"?",
"sheetName":"?",
"fileName":"?"
} ]
}