Exceptions
Response Code |
Error Description |
Exception Condition |
Response |
How to Handle |
---|---|---|---|---|
400 Bad Request |
Indicates missing or duplicate parameters. |
An Access Token call is made without a grant_type parameter. |
{ |
Make sure the grant_type parameter is set in the Access Token call. |
400 Bad Request |
Indicates an invalid grant_type. |
An Access Token call is made with an invalid grant_type. |
{ |
Make sure the correct value is sent for the grant_type parameter. |
400 Bad Request |
Indicates a Validationerror. |
The token is missing in the request or an invalid token is sent in the request. |
{ |
Make sure the correct token is included in the request. |
400 Bad Request |
Indicates an Invalid/Missing Role code. |
For the associated feature, Role Code is not found or enabled for the requestor. |
processMessages": [{"userMessage": {"messageTxt": "Invalid / Missing Role code" |
In an ADP product, assign the proper actor permission for the HTTP requestor. For further help contact your ADP representative. |
401 Unauthorized Error |
Indicates that the given client credentials were not valid. |
The Client ID or Client Secret entered is invalid for the Access Token call. |
{ |
Verify the correct Client ID and Client Secret are being passed. |
401 Unauthorized Error |
Specifies the proper client secure sockets layer (SSL) certificate was not presented. |
Proper Secure SSL certificates are not sent. |
{ |
Make sure valid SSL certificates are sent in the request. |
403 Forbidden Error |
Indicates the subscription status is suspended. |
The client suspended a subscription to the data connector application. |
{ |
Verify your client's subscription status. Then, contact your client to activate the subscription. |
403 Forbidden Error |
Indicates consent has not been provided. |
The client has not provided consent or has suspended consent to the data connector application. |
{ |
Ask the client to provide consent to your data connector application. |
403 Forbidden Error |
Indicates an invalid_scope. |
The API request is not authorized in your application scope. When your consumer application needs to use extra APIs, contact your ADP representative to add each API to your application scope. |
{ |
To add the API to your application scope, contact your ADP representative. Make sure you provide the following:
|
403 Forbidden Error |
|
The calling HTTP request does not have the right authorization for the underlying ADP application feature. |
{"messageTxt":"Operation Not Permitted"}, |
Do the following:
|
404 Not Found |
Indicates the scope for this service is invalid or undefined. |
An Invalid URI is being used in the request. |
{ |
Make sure the correct URI is included in the request. |
503 Service Unavailable |
Failed to retrieve consent status. |
The client consent record is not available. |
{ |
Contact your ADP representative. |
503 Service Unavailable |
Specifies that infrastructure is temporarily unavailable. |
ADP service is not available. |
{ |
Try again. |
These common exceptions apply to all ADP APIs. Please see API documentation for exception codes and errors specific to individual APIs