list_transfer_reasons
GET /list_transfer_reasons
To get the TOTAL COUNT of the list of transfer reasons for search criteria.
Use this method FIRST to determine how many total records there are for the given criteria.
After you call this method, then call the method below, and pass the required paging parameters.
/list_transfer_reasons?token=XXXXX&active_type=active
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| active_type |
'active' = Only the active transfer reasons. 'inactive' = Only the inactive transfer reasons. 'all' = All the transfer reasons(active and inactive) |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_transfer_reasons": 2
}
GET /list_transfer_reasons
To get a list of transfer reasons.
/list_transfer_reasons?token=XXXXX&active_type=active&page_number=1&page_size=10
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| active_type |
'active' = Only the active transfer reasons. 'inactive' = Only the inactive transfer reasons. 'all' = All the transfer reasons(active and inactive) |
| page_number |
The page number in the entire list. eg Page 1 |
| page_size |
The number of rows to return. eg 10 rows |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_transfer_reasons": [
{
"transfer_reason_code_365": "NT",
"transfer_reason_name": "NORMAL TRANSFER",
"active": true,
"sequence_order": 0
},
{
"transfer_reason_code_365": "EI",
"transfer_reason_name": "EXPIRED ITEM",
"active": true,
"sequence_order": 1
}
]
}