1.0.10 • Published 9 years ago

al-files-service v1.0.10

Weekly downloads
5
License
ISC
Repository
github
Last release
9 years ago

al-files-service

Exposes operations supported by awardletter files RESTful API

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.

ParamTypeDescription
RootrootUrlurl of awardletter API
Authorizationauthorizationheader value
contentobjectJSON 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.

ParamTypeDescription
RootrootUrlurl of awardletter API
Authorizationauthorizationheader value
stringfileIdThe 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.

ParamTypeDescription
RootrootUrlurl of awardletter API
Authorizationauthorizationheader value
stringfileIdThe Id of the file for which records are being retrieved
1.0.10

9 years ago

1.0.3

9 years ago

1.0.1

9 years ago

1.0.0

9 years ago

1.0.2

9 years ago