al-files-service v1.0.10
al-files-service
Exposes operations supported by awardletter files RESTful API
- al-files-service
- .upload(Root, Authorization, content) ⇒ function
- .getFile(Root, Authorization, string) ⇒ function
- .getRecords(Root, Authorization, string) ⇒ function
al-files-service.upload(Root, Authorization, content) ⇒ function
upload a file as application/octet-stream content
Kind: static method of al-files-service
Returns: function - A promise.
The promise will resolve with an Id (fileId) for the uploaded file.
Any response whose status code is not 2xx will result in a rejected promise.
Param | Type | Description |
---|---|---|
Root | rootUrl | url of awardletter API |
Authorization | authorization | header value |
content | object | JSON content to be uploaded |
al-files-service.getFile(Root, Authorization, string) ⇒ function
retrieves file processing results summary
Kind: static method of al-files-service
Returns: function - A promise.
A resolved promise will return the the file processing results summary.
Any response with a status code that is not 2xx will result in a rejected promise.
Param | Type | Description |
---|---|---|
Root | rootUrl | url of awardletter API |
Authorization | authorization | header value |
string | fileId | The Id of the file being retrieved |
al-files-service.getRecords(Root, Authorization, string) ⇒ function
get all records for a given file
Kind: static method of al-files-service
Returns: function - Returns a promise of the results.
A resolved promise returns all records for a given file.
Any response with a status code that is not 2xx will result in a rejected promise.
Param | Type | Description |
---|---|---|
Root | rootUrl | url of awardletter API |
Authorization | authorization | header value |
string | fileId | The Id of the file for which records are being retrieved |