CouncilLibrary

This operation enables the consent authority to update an existing Bespoke condition in Council's condition library.

path Parameters
ConditionID
required
string

This indicates the Condition ID generated by DPE.

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

UpdateCondition request object

conditionTitle
required
string <= 256 characters

This indicates the title of the Condition.

conditionText
required
string <= 300000 characters

This indicates the condition text in HTML format. Council should send image document with png, jpg, jpeg extension(s) only in the img tag in Condition text. Image size can be maximum 600px in width and 252 px in height.

conditionReason
string <= 256 characters

This indicates the reason why a Condition is being added in Council library.

newEffectiveDate
required
string <date> <= 10 characters

This indicates the date from when the updated Condition will be effective in the ePlanning & Council system.

newExpiryDate
string <date> <= 10 characters

This indicates the expiration date of the updated condition.

typeOfWork
required
string <= 256 characters

This indicates the type of work mentioned in the condition. This field has following options - 1.Building Work, 2.Demolition Work, 3.Subdivision Work,4.Remediation Work, 5.Strata Subdivision, 6.Change of use, 7.Land Subdivision, 8.Other

reasonForReporting
required
string <= 1000 characters

This indicates the reason for adding this condition.

developmentStage
required
string <= 256 characters

This indicates the stage of development that are relevant to the condition. This field has following options - 1. During building work, 2. During demolition work, 3. During subdivision work, 4. Before building work commences, 5. Before remediation work commences, 6. Before subdivision work commences, 7. Before issue of an occupation certificate, 8. Ongoing use for subdivision work, 9. Occupation and ongoing use, 10. Before issue of a construction certificate, 11. Before issue of a subdivision certificate, 12. Before issue of a strata certificate, 13. Before issue of a subdivision works certificate, 14. On completion of demolition work, 15.On completion of remediation work, 16. Ongoing use for change of use, 17. Before demolition work commences, 18. During remediation work, 19. General condition

councilConditionID
string <= 256 characters

This indicates the Council reference ID that's assigned by the Council for a specific Condition ID.

updatedByEmail
required
string <= 256 characters

This refers to the email address of the User. User is expected to be registered in the planning portal.

Responses

Request samples

Content type
application/json
{
  • "conditionTitle": "Approved Plans",
  • "conditionText": "<p><img src ='http://councilbaseurl/Documents/ConImg2.png' width='300' height='150'></p>",
  • "conditionReason": "Plans condition",
  • "newEffectiveDate": "2022-03-16T00:00:00.000Z",
  • "newExpiryDate": "2023-03-16T00:00:00.000Z",
  • "typeOfWork": "Demolition Work",
  • "reasonForReporting": "This is for reporting purpose",
  • "developmentStage": "General condition",
  • "councilConditionID": "SAMPLE-123",
  • "updatedByEmail": "abc@gmail.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Request is successfully executed"
}
Next to CouncilLibrary