Errors are described by a combination of attributes as shown in an example below:
Sample error response
{
"transactionStatus": {
""isFailure": true,
""statusCode": "400",
""statusMessage": "Invalid input"
}
}
In case of success response, the status code will be populated with 200
Scenario | statusCode | Description | Products |
---|---|---|---|
When required param Authorization is missed | 400 | Bad Request |
|
When wrong Authorization param is passed | 401 | Unauthorized access |
|
When wrong Authorization param is passed or token is timed out | HTTP Code - 403 | "User is not authorized to access this resource with an explicit deny" |
|
No Authorization param is passed | HTTP Code - 401 | Unauthorized |
|
Mandatory input MatchCriteria not provided or empty value | 400 | Match Criteria not provided |
|
When mandatory value missing (either Name, DUNS, Regn Nbr missing) | 400 | Bad Request provided |
|
Pagination - Start record number greater than total number of records | 404 | StartRecordNumber can't be greater than total records count: <doc_count> |
|
When search is NOT matched | 404 | No match found |
|
Invalid input: Match criteria not provided | 400 | Match Criteria Not Provided |
|
Invalid input: Missing headers | 400 | Header not provided |
|
Invalid input: Invalid or no request type | 400 | RequestType Not Provided |
|
Pagination: StartRecordNumber is empty or invalid | 400 | StartRecordNumber in Pagination can't be empty or invalid |
|
Pagination: When number of records greater than 50 or max permitted value. | 400 | Minimum size should be: 1 and Maximum pagination limit allowed is: 50| Input value: >given value< |
|
Pagination: When requested result set is size greater than 10K permitted limit. | 413 | Result window is too large, sum of from and size values must be less than or equal to: [10000] but was >given value< |
|
API payload size limitation error | 500 | Reason for the failure maybe API payload size has crossed 10MB limit. Please reduce the pagination numberOfRecords to retrieve records,if you need support please contact the customer service team-gfsupport@dnb.com. |
|
Any internal error | 500 | Internal error. Contact support (support.dnb.com). |
|
Any financial range field with fromValue, toValue and isAvailable is given | 400 | Both IsAvailable & Range fields can't be given together. |
|
Any financial range field matchCriteria with fromValue greater than toValue | 400 | Invalid upper value range given for Financial Element(s) |
|
Any Corporate linkage matchCriteria with duns array and hasParent given together | 400 | Both IsAvailable & DUNS check can't be given for Parent Duns |
|