Many Records RES

A response profile for many request records.

{
  "totalCount" : "number",
  "okCount"    : "number",
  "errorCount" : "number",
  "results" :  [
      {
        "ok"       : "boolean",
        "userId"   : "character",
        "errorMessage" : "character",
        "extRefId" : "character",
        "userData" : "character"
      }
  ]
}

Response Header

Header Field	Description
totalCount	Total number of records, which should match the number of records in the request. totalCount = okCount + errorCount
okCount	Number of record that have been processed successfully.
errorCount	Number of records which could not be processed.

The results array

The results array contains a record for each request item.

Result Field	Description
ok	[Mandatory] true | false
userId	[Mandatory] The id of the request record.
errorMessage	[Optional] A user-readable message why that record could not be processed. Note: Administrative (technical) error messages are not sent back to the client.
extRefId	[Optional] If provided in the request, a reference to the record in the external (requesting) system.
userData	[Optional] Can contain any request specific additional information, that is used by the client.