Error Handling for v1 API

Mon, 01 Jan 0001 00:00:00 +0000

The following table lists the record error handling status codes, which are sent from the server to the client.

Status Code	Responses
Success	`{ "bulk":{ "id":1, "returntype":"success", "data":[ { "id":1, "returncode":"/rest-v1/returncodes/id/6", "returntype":"success", "content":"AGoAZABzAHIAdQBlAGMAagBaAEMAMQAyADMANA==" }, { "id":2, "returncode":"/rest-v1/returncodes/id/6", "returntype":"success", "content":"AGoAZABzAHIAdQBlAGMAagBaAEMAMQAyADMANA==" } ] } }`
Success, with warning	`{ "bulk":{ "id":1, "returntype":"warning", "data":[ { "id":1, "returntype":"warning", "content":null }, { "id":2, "returntype":"warning", "content":null } ] } }`
Error type of log return code	`{ "bulk":{ "id":1, "returntype":"error", "data":[ { "id":1, "message":"Data is too short to be protected/unprotected.", "returncode":"/rest-v1/returncodes/id/22", "returntype":"error" }, { "id":2, "message":"Data is too short to be protected/unprotected.", "returncode":"/rest-v1/returncodes/id/22", "returntype":"error" } ] } }`
Error type of log return code (different)	`{ "bulk":{ "id":1, "returntype":"error", "data":[ { "id":1, "message":"Data is too short to be protected/unprotected.", "returncode":"/rest-v1/returncodes/id/22", "returntype":"error" }, { "id":2, "returncode":"/rest-v1/returncodes/id/6", "returntype":"success", "content":"AGoAZABzAHIAdQBlAGMAagBaAEMAMQAyADMANA==" } ] } }`

For more information about the Log Return codes, refer to the section Log return codes.

V1 AP REST HTTP Response Codes

Mon, 01 Jan 0001 00:00:00 +0000

Error Messages	Operation	Audit Code in Logs	HTTP Response Code
Failed to decode Base64	Protect Unprotect Reprotect	No audit code generated	400
The content of the input data is not valid	Protect Unprotect Reprotect	44	400
Unsupported algorithm or unsupported action for the specific data element	Protect Unprotect Reprotect	26	400
Data is too long to be protected/unprotected	Protect Unprotect Reprotect	23	400
Data is too short to be protected/unprotected	Protect Unprotect Reprotect	22	400
The user does not have the appropriate permissions to perform the requested operation	Protect Unprotect Reprotect	3	400
The data element could not be found in the policy	Protect Unprotect Reprotect	1	401
The username could not be found in the policy	Protect Unprotect Reprotect	2	400
Data unprotect operation failed. with correlationId <CorrelationID>	Unprotect	9	400
Tweak input is too long. with correlationId <Correlation ID>	Protect Unprotect Reprotect	15	200
Failed to send logs, connection refused ! with correlationId <Correlation ID>	Protect Unprotect Reprotect	51	400
Policy not available with correlationId <Correlation ID>	Protect Unprotect Reprotect	31	400