WithdrawAgency

This operation transfers Council decision to withdraw particular agency application.

path Parameters
CaseID
required
string

A fully qualified Agency Concurrence and Referral case number

header Parameters
OrganisationID
required
string

The council LGA name to indicate where the request is originated from.

IdempotencyID
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically, a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

Information request object

caseStatus
string <= 32 characters

Status of the Agency CNR case

CNRCaseID
string <= 32 characters

CNR Case ID.

withdrawalDate
required
string <date> non-empty

Date on which case is withdrawn

withdrawalReason
string

Reason for which the case is withdrawn

agencyBeingWithrawn
string <= 256 characters

Agency name withdrawn by council

Array of objects (agencyInfo)
Array of objects (DownloadableDocument)
required
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "string",
  • "CNRCaseID": "CNR-XXX",
  • "withdrawalDate": "2019-08-24",
  • "withdrawalReason": "string",
  • "agencyBeingWithrawn": "string",
  • "agencies": [
    ],
  • "documents": [],
  • "updatedBy": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 404,
  • "message": "Internal Server error 19876",
  • "activityId": "00000011-0ab-xy00-0000-500000000000",
  • "errorCode": "DPE_TMS01",
  • "errorDetails": "Inner Exceptions, Stack Trace, etc"
}