application-list-entries

Replace officials for multiple Application List Entries.

Atomically replaces the full officials array for each specified entry in the source list (path listId). If any entry cannot be updated, no officials are changed. NOTE: Duplicate entryIds will result in an error

post/application-lists/{listId}/entries/officials

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /application-lists/{listId}/entries/officials
  • Auth
    none declared

Path parameters

listIdstring uuid required

ID of the Application List that owns the entries whose officials will be replaced.

Request body

entryIdsstring[] required

Array of entry IDs whose officials should be replaced. All must belong to the list in the path.

Example request

{
  "entryIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ],
  "officials": [
    {
      "title": "Mr, Mrs",
      "surname": "Smith",
      "forename": "John",
      "type": "MAGISTRATE"
    }
  ]
}

Response

Officials replaced for all entries. No response body.

Changes

No recorded changes to this operation across all 61 revisions of this API.