Error Handling for v1 API

For record error handling, the bulk id and data id fields are used, which enable tracking of the errors from the client side.

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

Status CodeResponses
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.


Last modified : December 18, 2025