Get Query
Below section describes error response codes from Client-API for queries to fetch data operations.
- Error Response: GET/v1/{clientId}/get_account
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check url params fields are part of payload Mandatory values are 1. accountReference | {"message": "Missing required request parameters: [accountReference]"} |
| 200 OK Empty response payload | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference | Empty response null |
- Error Response: GET/v1/{clientId}/get_message
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check url params fields are part of payload Mandatory values are 1. messageURL | {"message": "Missing required request parameters: [messageURL]"} |
| 500 Internal Server Error | Invalid messageURL | -Check for validity of URL | {"success":false,"messageIds":[],"messages":["Internal Server Error"]} |
- Error Response: GET/v1/{clientId}/get_communication_message_urls (broken)
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 500 Internal Server Error |
- Error Response: GET/v1/{clientId}/get_events
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check url params are part of payload Mandatory values are 1. date 2. evenType | {"message": "Missing required request parameters: [date]"} |
| 400 Bad Request | Wrong values in eventType | -Check eventType for value set below * event.claim.created * event.claimDebtPayment.processing * event.debtorEmail.queued * event.debtorSMS.queued * event.promiseToPay.created * event.promiseToPay.invalidated * event.promiseToPay.resolved * event.instalment.started * event.instalment.resolved * event.instalment.invalidated * event.instalment.expired * event.instalmentsPlan.resolved * event.instalmentsPlan.invalidated * event.instalmentsPlan.failed * event.instalmentsPlan.created * event.promiseToPay.expired | {"messages":["query/eventType should match pattern "^(event.claim.created |
- Error Response: GET/v1/{clientId}/get_account_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check url params fields are part of payload Mandatory values are 1. accountReference | {"message": "Missing required request parameters: [accountReference]"} |
| 200 OK Empty response payload | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference | Empty response [] |
- Error Response: GET/v1/{clientId}/get_landing_page_url
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check url params fields are part of payload Mandatory values are 1. claimReference | {"message": "Missing required request parameters: [claimReference]"} |
| 200 OK Empty response payload | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. claimReference | Empty response [] |