CreateRef

This operation transfers the Referrals application created by the applicant/Certifer from the
the Post Consent Service.

path Parameters
CaseID
required
string

A fully qualified application number or case id

header Parameters
OrganisationID
required
string

The council LGA name or Private Certifier or Agency Organisation name to indicate where the request is originated from.

Request Body schema: application/json

Information request object

updateReason
string <= 1500 characters

Please enter reason/s for adding new referral/s and/or uploading documents.

Array of objects (agencyList)

Holds the agency name.

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": 404,
  • "message": "Internal Server error 19876",
  • "activityId": "00000011-0ab-xy00-0000-500000000000",
  • "errorCode": "DPE_TMS01",
  • "errorDetails": "Inner Exceptions, Stack Trace, etc"
}