CreateRef

This operation transfers the referral details from the relevant organisation to create the referral in the ePlanning system.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

The relevant organisation 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

updateReason
string <= 1500 characters

This is to track the reason(s) for adding new referral(s) and/or uploading documents.

Array of objects (agencyList)

This is to track the the agency name(s).

Array of objects (DownloadableDocument)

Upload the documents if required as it is an optional field.

updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "updateReason": "string",
  • "agencyList": [
    ],
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Case Submitted by Applicant",
  • "activityId": "string",
  • "Documents": [
    ]
}
Next to CreateExhibition