This operation transfers defer determination information provided by the applicant from the Building Information certificate Service to the relevant organisation's IT system.
CaseID required | string A fully qualified application number or case id |
OrganisationID required | string Used by the API gateway to identify the agency to which the response needs to be routed to. |
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" |
Information request object
caseStatus | string This field is to track the case status of the defer determination request. |
WorkDescription | string This is to track the comments provided by council as part of defer determination request. |
isWorksCompleted required | boolean This is to track works completed or not. |
worksNotCompletedReason | string <= 1000 characters This is to track the reason why Works are not completed. Applicable and mandatory when isWorksCompleted is false |
childCaseID | string This child case ID is to track the defer determination request. |
responseDate | string <date> This is to track the date on which defer determination is provided. |
Array of objects (DownloadableDocument) | |
object (UpdatedBy) |
{- "caseStatus": "string",
- "WorkDescription": "string",
- "isWorksCompleted": true,
- "worksNotCompletedReason": "string",
- "childCaseID": "DEF-XXXX",
- "responseDate": "2019-08-24",
- "documents": [
- {
- "documentName": "test.docx",
- "documentType": "string",
- "uploadedDateTime": "2019-08-24T14:15:22Z",
- "documentURL": "string",
- "documentSize": 0,
- "updatedBy": "string"
}
], - "updatedBy": {
- "person": {
- "firstName": "John",
- "familyName": "Smith",
- "email": "john.smith@gmail.com",
- "contactNumber": "stringst"
}
}
}
{- "statusCode": 404,
- "message": "Internal Server error 19876",
- "activityId": "00000011-0ab-xy00-0000-500000000000",
- "errorCode": "DPE_TMS01",
- "errorDetails": "Inner Exceptions, Stack Trace, etc"
}