All the push firmware to terminal related APIs are encapsulated in the class * com.pax.market.api.sdk.java.api.terminalFirmware.TerminalFirmwareApi*.
Constructors of TerminalFirmwareApi
public TerminalFirmwareApi(String baseUrl, String apiKey, String apiSecret);
Constructor parameters description
| Name | Type | Description |
|---|---|---|
| baseUrl | String | the base url of REST API |
| apiKey | String | the apiKey of marketplace, get this key from PAXSTORE admin console, refe to chapter Apply access rights |
| apiSecret | String | apiSecret, get api secret from PAXSTORE admin console, refer to chapter Apply access rights |
Push firmware API allow the third party system push a firmware to terminal.
API
public Result<String> pushFirmware2Terminal(PushFirmware2TerminalRequest pushFirmware2TerminalRequest)
Input parameter(s) description
| Parameter Name | Type | Nullable | Description |
|---|---|---|---|
| pushFirmware2TerminalRequest | PushFirmware2TerminalRequest | false | The push firmware request object. The structure shows below. |
Structure of class PushFirmware2TerminalRequest
| Property Name | Type | Nullable | Description |
|---|---|---|---|
| tid | String | true | The tid of terminal |
| serialNo | String | true | The serial number of terminal |
| fmName | String | false | The fmName which indicate the firmware you want to push to the terminal |
| wifiOnly | Boolean | true | Whether to download over Wi-Fi or Cable network only, don’t allow to download over the cellular network |
| effectiveTime | Date | true | The time when to start the push task |
| expiredTime | Date | true | The time when to stop the push task |
Note: tid and serialNo cannot be empty at same time.
Sample codes
TerminalFirmwareApi terminalFirmwareApi = new TerminalFirmwareApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
PushFirmware2TerminalRequest createTerminalFirmwareRequest = new PushFirmware2TerminalRequest();
pushFirmware2TerminalRequest.setTid("ABC09098989");
pushFirmware2TerminalRequest.setFmName("A920_PayDroid_4.4.2_Capricorn_V01.1.10_20171226_OTA");
terminalFirmwareApi.pushFirmware2Terminal(pushFirmware2TerminalRequest);
Client side validation failed sample result(JSON formatted)
{
"businessCode": -1,
"validationErrors": ["The property serialNo and tid in createTerminalFirmwareRequest cannot be blank at same time!"]
}
Server side validation failed sample result(JSON formatted)
{
"businessCode": 2028,
"message": "Terminal not found"
}
Successful sample result(JSON formatted)
{
"businessCode": 0,
"data": {
"id": 51741,
}
}
Possible validation errors
Parameter createTerminalFirmwareRequest cannot be null!
The property serialNo and tid in createTerminalFirmwareRequest cannot be blank at same time! fmName:may not be empty
Possible business codes
| Business Code | Message | Description |
|---|---|---|
| 2028 | Terminal not found | Please check the value of tid or serialNo |
| 2033 | Firmware name cannot be empty | |
| 2034 | Firmware not found | Cannot find firmware by fmName |
| 2035 | Firmware status not online | |
| 2036 | Firmware model mismatch with terminal model | |
| 2026 | Tid and serialNo cannot empty at same time | |
| 8112 | Same version of pending terminal firmware already exists | |
| 8113 | Same version of active terminal firmware already exists |
The search firmware push history API allows third party system to search pushed firmwares to the specified terminal by page.
tips： Compatible with older versions, returns Status : A(Active) when the status parameter is C(Completed)
API
public Result<PushFirmwareTaskDTO> searchPushFirmwareTasks(int pageNo, int pageSize, SearchOrderBy orderBy,String terminalTid, String fmName, PushStatus status)
public Result<PushFirmwareTaskDTO> searchPushFirmwareTasks(int pageNo, int pageSize, SearchOrderBy orderBy,String terminalTid, String fmName, PushStatus status,
String serialNo)
Input parameter(s) description
| Name | Type | Nullable | Description |
|---|---|---|---|
| pageNo | int | false | page number, value must >=1 |
| pageSize | int | false | the record number per page, range is 1 to 100 |
| orderBy | SearchOrderBy | true | the sort order by field name, if this parameter is null the search result will order by created date descend. The value of this parameter can be one of SearchOrderBy.CreatedDate_desc and SearchOrderBy.CreatedDate_asc. |
| terminalTid | String | true | search filter by terminal tid, when the parameter serialNo has a value, it can be null, otherwise, it cannot be empty |
| fmName | String | true | search filter by firmware name |
| status | PushStatus | true | the push status the value can be PushStatus.Active, PushStatus.Suspend, PushStatus.Completed |
| serialNo | String | true | search filter by terminal serial no |
Sample codes
TerminalFirmwareApi terminalFirmwareApi = new TerminalFirmwareApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<PushFirmwareTaskDTO> result = terminalFirmwareApi.searchPushFirmwareTasks(1,12,SearchOrderBy.CreatedDate_desc,
terminalTid, fmName, PushStatus.Active);
Client side validation failed sample result(JSON formatted)
{
"businessCode": -1,
"validationErrors": ["pageNo:must be greater than or equal to 1"]
}
Successful sample result
{
"businessCode": 0,
"pageInfo": {
"pageNo": 1,
"limit": 12,
"totalCount": 1,
"hasNext": false,
"dataSet": [{
"id": 17850,
"fmName": "PayDroid_5.1.1_Aquarius_V09.0.00_20190508",
"terminalSN": "87879696",
"status": "A",
"actionStatus": 2,
"errorCode": 0
}]
}
}
The type in dataSet is PushFirmwareTaskDTO. And the structure like below.
| Name | Type | Description |
|---|---|---|
| id | Long | the id of push firmware record |
| fmName | String | the name of firmware |
| terminalSN | String | the serialNo of terminal |
| status | String | the status of push firmware, value can be one of A(Active) and S(Suspend) |
| actionStatus | String | the action status, please refer to Action Status |
| activatedDate | Date | the push firmware activated date |
Possible client validation errors
pageNo:must be greater than or equal to 1
pageSize:must be greater than or equal to 1
pageSize:must be less than or equal to 100
Possible business codes
| Business Code | Message | Description |
|---|---|---|
| 2028 | Terminal not found | Please check the value of tid or serialNo |
| 2039 | Tid mismatch with serialNo |
Get terminal push firmware history by id.
API
public Result<PushFirmwareTaskDTO> getPushFirmwareTask(Long pushFirmwareTaskId)
Input parameter(s) description
| Parameter Name | Type | Nullable | Description |
|---|---|---|---|
| pushFirmwareTaskId | Long | false | the id of push firmware |
Sample codes
TerminalFirmwareApi terminalFirmwareApi = new TerminalFirmwareApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<PushFirmwareTaskDTO> result = terminalFirmwareApi.getPushFirmwareTask(17850L);
Client side validation failed sample result(JSON formatted)
{
"businessCode": -1,
"validationErrors": ["Parameter pushFirmwareTaskId cannot be null and cannot be less than 1!"]
}
Server side validation failed sample result(JSON formatted)
{
"businessCode": 8108,
"message": "Terminal firmeware not found"
}
Successful sample result(JSON formatted)
{
"businessCode": 0,
"data": {
"id": 17850,
"fmName": "PayDroid_5.1.1_Aquarius_V09.0.00_20190508",
"terminalSN": "87879696",
"status": "A",
"actionStatus": 2,
"errorCode": 0
}
}
The type of data is PushFirmwareTaskDTO, and the structure shows below.
| Name | Type | Description |
|---|---|---|
| id | Long | the id of push firmware record |
| fmName | String | the name of firmware |
| terminalSN | String | the serialNo of terminal |
| status | String | the status of terminal apk, value can be one of A(Active) and S(Suspend) |
| actionStatus | String | the action status, please refer to Action Status |
| errorCode | int | the error code, please refer to Action Error Codes |
| activatedDate | Date | the push firmware activated date |
Possible client validation errors
Parameter pushFirmwareTaskId cannot be null and cannot be less than 1!
Possible business codes
| Business Code | Message | Description |
|---|---|---|
| 8101 | Terminal firmware not found |
This api allows the third Party system disable an exist push by specifying the serial number of terminal and the firmware name.
API
public Result<String> disablePushFirmwareTask(DisablePushFirmwareTask disablePushFirmwareTask)
Input parameter(s) description
| Parameter Name | Type | Nullable | Description |
|---|---|---|---|
| disablePushFirmwareTask | DisablePushFirmwareTask | false | The disable request object. The structure shows below. |
Structure of class DisablePushFirmwareTask
| Property Name | Type | Nullable | Description |
|---|---|---|---|
| tid | String | true | The tid of terminal |
| serialNo | String | true | The serial number of terminal |
| fmName | String | false | The fmName which indicate the firmware you want to suspend the terminal push task |
Note: tid and serialNo cannot be empty at same time.
Sample codes
TerminalFirmwareApi terminalFirmwareApi = new TerminalFirmwareApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
DisablePushFirmwareTask disablePushFirmwareTask = new DisablePushFirmwareTask();
disablePushFirmwareTask.setTid("ABC09098989");
disablePushFirmwareTask.setFmName("A920_PayDroid_4.4.2_Capricorn_V01.1.10_20171226_OTA");
terminalFirmwareApi.disablePushFirmwareTask(disablePushFirmwareTask);
Client side validation failed sample result(JSON formatted)
{
"businessCode": -1,
"validationErrors": ["The property serialNo and tid in disablePushFirmwareTask cannot be blank at same time!"]
}
Server side validation failed sample result(JSON formatted)
{
"businessCode": 2040,
"message": "Unfinished terminal push firmware not found"
}
Successful sample result(JSON formatted)
{
"businessCode": 0
}
Possible validation errors
Parameter suspendTerminalApkRequest cannot be null!
The property serialNo and tid in suspendTerminalApkRequest cannot be blank at same time! fmName:may not be empty
Possible business codes
| Business Code | Message | Description |
|---|---|---|
| 2028 | Terminal not found | Please check the value of tid or serialNo |
| 2026 | Tid and serialNo cannot empty at same time | |
| 2033 | FmName cannot be empty | |
| 2034 | Firmware not found | |
| 2040 | Unfinished terminal push firmware not found |