Assessment

This operation transfers the particulars of the agency's request from agency's IT System to ePlanning's IT system. In this operation agency requests for additional information from council when required. When additional information is not required, the case is progressed to the subsequent stage.

path Parameters
CaseID
required
string

A fully qualified Agency Concurrence and Referral case. E.g. A-xxx case

header Parameters
OrganisationID
required
string

The agency 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

canContinueAssessment
boolean

it infers whether information provided by Council is sufficient for the assessment process. This is applicable when the Council confirms that the Applicant is willing to provide the additional information requested.

moreInfoReqd
boolean

it infers if more information is required from the Council on behalf of the applicant, for the assessment process? This will be applicable when 'canContinueAssessment' is false.

detailsOfRequest
string <= 256 characters

It infers about the details of information request and is applicable if 'moreInfoReqd' is true

requestDate
string <date>

Date of request for additional information

Array of objects (DownloadableDocument)
updatedByEmail
string (UpdatedByEmail)

user mail address who performing the action.

Responses

Request samples

Content type
application/json
{
  • "canContinueAssessment": true,
  • "moreInfoReqd": true,
  • "detailsOfRequest": "string",
  • "requestDate": "2021-03-18T00:00:00.000Z",
  • "Documents": [
    ],
  • "updatedByEmail": "string"
}

Response samples

Content type
application/json
{
  • "documentName": "test.docx",
  • "documentType": "string",
  • "eplanningDocId": "string",
  • "externalOrgDocURL": "string"
}
Next to Decision