AcceptReturn

This operation transfers the agency's decision to accept or return the application from agency's IT system to ePlanning's IT System.

path Parameters
CaseID
required
string

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

header Parameters
OrganisationID
required
string

The council LGA name or Agency Organisation name to indicate where the request has 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

isAgencyAssessmentReq
required
string (AgencyAssessment)

Is agency assessment required? "Accept all "," Reject all" and "Accept/Reject individually" are only applicable when agency has more than one clause. One of the below mentioned values must be selected for One of the below mentioned values must be selected for AgencyAssessment 1. Accept 2. Reject 3. Accept all 4. Reject all 5. Accept/Reject individually

rejectReason
string (Please provide reason) <= 2000 characters

This infers that the agency need to provide the reason for which the assessment is not required. Mandatory when isAgencyAssessmentReq is- 'Reject' OR 'Reject All'

agencyOfficer
string (Assign case to) <= 32 characters

applicable when isAgencyAssessmentReq is "Accept" or "Accept all"

Array of objects (ClauseDetails)
Array of objects (DownloadableDocument)

Documents will be available if the isAgencyAssessmentReq is 'Reject' OR 'Reject All'

updatedByEmail
required
string (UpdatedByEmail)

user mail address who performing the action.

Responses

Request samples

Content type
application/json
{
  • "isAgencyAssessmentReq": "Refer to description for values",
  • "rejectReason": "string",
  • "agencyOfficer": "string",
  • "clauseDetails": [
    ],
  • "Documents": [
    ],
  • "updatedByEmail": "string"
}

Response samples

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