Terminal - Download transaction list

API Url

Used for downloading transaction list in the specified format.

GET

http://localhost:16010/ProMarkREST/rest/Terminal/files/{id}

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
id	String	The file identifier (name).

Query parameters

Field	Type	Description
format`optional`	String	The terminal list format. For now it's only "PDF"

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
fileContent	String	The transaction list content as BASE64-ENCODED.
fileName	String	Name of the downloaded file.
fileType	String	Format of the downloaded file.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.

Error example:

HTTP/1.1 404 Not found
{
   "response": {
      "data": {
         "fileType": "",
         "fileName": "",
         "fileContent: ""
      },
      "errorCode": 285,
      "errorMessage": "The transaction list does not exist."
   }
}