Section 68 - ePlanning to Council API (v1)

Authentication

Please use the subscription key provided by the Department to access the APIs.

Download OpenAPI description

S68 - ePlanning to Council API v1.0.json

S68 - ePlanning to Council API v1.0.yaml

Overview

Servers

https://dpie-apim-uat.redocly.app/

CreateSec68

Request

This operation transfers the application created by the applicant from the Section 68 of the Local Government Act Service to the Council's IT system.

Path

CaseIDstringrequired

A fully qualified Section 68 of the Local Government Act case

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the response is routed to.

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 80 characters

Status of the Section68 case

Example: "Submitted"

primaryApplicantobject(applicantList)required

used to hold applicant's details.

primaryApplicant.applyOnBehalfOfCompanyboolean

This property will confirm whether the applicant is a company or Not. If YES, need to provide the company details.

primaryApplicant.contactDetailsobject(applicantDetails)

primaryApplicant.applicantCompanyobject(applicantCompany)

If Apply on Behalf of Company is selected as 'Yes'

secondaryApplicantsArray of objects(applicantList)

applicationTypestring(ApplicationType)required

what is the application type to be created. One of the below mentioned values must be selected for ApplicationType 1. Section 68 application 2. Section 68 modification application 3. Section 68 review of determination

Example: "Refer to description for values"

relatedApplicationstring(relatedApplication)

type of the related application and is applicable when 'applicationType' is selected as 'Section 68 application'. One of the below mentioned values must be selected for RelatedApplication 1. Complying Development Certificate (CDC) 2. Development Application (DA) 3. No related application

Example: "Refer to description for values"

relatedApplicationAppliedViaPortalboolean

applicable when 'Complying Development Certificate (CDC)' or 'Development Application (DA)' is selected as part of 'relatedApplication' given options.

relatedPortalCaseIDstring

Holds the related portal caseID of either 'Complying Development Certificate (CDC)' or 'Development Application (DA)' and is applicable when 'Complying Development Certificate (CDC)' or 'Development Application (DA)' is selected as part of 'relatedApplication' given options.

isCaseAppliedOnPortalboolean

Applicable when 'applicationType' is 'Section 68 modification application' or 'Section 68 review of determination'

referenceNumberOfPastCasestring

applicable when 'applicationType' is 'Section 68 modification application'or 'Section 68 review of determination'. This field is required when 'isCaseAppliedOnPortal' is true

dateOfDetermiantionOfPastCasestring(date)

applicable when 'applicationType' is 'Section 68 modification application' or 'Section 68 review of determination'. This field is required when 'isCaseAppliedOnPortal' is false

dateOfDetermiantionstring(date)

applicable when 'applicationType' is 'Section 68 modification application' or 'Section 68 review of determination'. This field is required when 'isCaseAppliedOnPortal' is true

modificationDescriptionstring<= 512 characters

applicable when 'applicationType' is 'Section 68 modification application' and holds the comments why the other case is modified.

siteAddressesArray of objects(Location)required

siteAddresses[].addressstring<= 250 charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"

siteAddresses[].addressDetailobject(AddressDetail)

siteAddresses[].addressMissingboolean

Used to differentiate if address is present in the system or not.

siteAddresses[].adjacentLotboolean

used to check if the land is adjacent to this lot and applicable if 'addressMissing' is true

siteAddresses[].lotListArray of objects(LotSectionPlan)

siteAddresses[].lgastring<= 30 charactersrequired

Local Government Area under which this application falls

Example: "PENRITH"

siteAddresses[].isPrimarybooleanrequired

The primary address if multiple

developmentTypeArray of objects(DevelopmentTypes)required

Holds the type of development proposed by the applicant.

developmentType[].publicPlaceArray of strings(PublicEntertainmentPlaces)

applicable when 'developmentType'is selected as 'Structure or places of public entertainment'

Example: ["Refer to description for values"]

developmentType[].waterWorksArray of strings(WaterWorks)

applicable when 'developmentType'is selected as 'Water supply, sewerage and stormwater drainage work'

Example: ["Refer to description for values"]

developmentType[].wasteManagementArray of strings(WasteMgmtWork)

applicable when 'developmentType'is selected as 'Management of waste'

Example: ["Refer to description for values"]

developmentType[].publicRoadWorksArray of strings(PublicRoadWork)

applicable when 'developmentType'is selected as 'Works and activities within public roads'

Example: ["Refer to description for values"]

developmentType[].communityLandWorksArray of strings(CommunityLandWork)

applicable when 'developmentType'is selected as 'Works and activities within Community Lands'

Example: ["Refer to description for values"]

developmentType[].otherDevelopmentWorksArray of strings(OtherDevWork)

applicable when 'developmentType' is selected as 'Other'

Example: ["Refer to description for values"]

propertySizestring

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the size of property proposed. One of the below mentioned values must be selected for propertySize 1. Land size of less than 1000m2 2. Land size of 1000m2 – 2000m2 3. Land size of more than 2000m2

Example: "Refer to description for values"

propertyUsestring

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the usage of property. One of the below mentioned values must be selected for propertyUse 1. Residential dwelling 2. Commercial and/or industrial development 3. Other

Example: "Refer to description for value"

noOfBedroomsinteger<= 5 characters

applicable when 'Residential dwelling' is selected in 'propertyUse'

propertyUseOtherstring

applicable when 'Other' is selected in 'propertyUse'

typeOfWaterSupplystring

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the type of watter supply. One of the below mentioned values must be selected for typeOfWaterSupply 1. Mains water supply (town water) 2. Tank water 3. Dam, river or bore water

Example: "Refer to description for value"

typeOfWasteTreatmentArray of strings(WasteTreatementType)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the type of waste treatment

Example: ["Refer to description for values"]

tradeWasteDescstring

applicable when 'typeOfWasteTreatment' is 'Trade'

otherWasteDescstring<= 256 characters

applicable when 'typeOfWasteTreatment' is 'Other'

wasteMgmtTreatmentSystemArray of strings(TreatmentSystem)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the type of system to be installed (treatment system)

Example: ["Refer to description for values"]

otherTreatmentSystemDescstring<= 256 characters

applicable when 'wasteMgmtTreatmentSystem' is 'Other'

wasteMgmtTypeOfSystemArray of strings(TypeOfSystem)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the type of system to be installed (treatment system)

Example: ["Refer to description for values"]

otherTypeOfSystemDescstring<= 256 characters

applicable when 'wasteMgmtTypeOfSystem' is 'Other'

tankCapacityArray of numbers(decimal)(TankCapacity)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the tank capacity in litres

Example: [12.5]

proposed24HrWorkobject

operationHoursCommentsstring<= 512 characters

applicable when 'hoursOfOperation' is present and holds additional comments on operating hours.

otherDevelopmentstring<= 512 characters

applicable when 'otherDevelopmentWorks' is selected as 'Other'

diningAreaLicensedboolean

applicable when 'communityLandWorks' has 'Engage in a trade or business' and tells if applicant is intended to operate the outdoor dining area as a licensed premises

isLiquorLicenseHeldboolean

applicable when 'diningAreaLicensed' is true and holds whether the applicant holds liquor license or not

liquorLicenceNumberstring<= 20 characters

applicable when 'isLiquorLicenseHeld' is true and holds the liquor license number provided

briefOfProposedWorksstring<= 512 charactersrequired

holds the brief explanation of the proposed works

estimatedCostnumber(decimal)

Holds the estimated cost of the works

siteConditionsImpactboolean

Tells if there are any security or site conditions which may impact on the person undertaking the inspection. eg: locked gates, animals, etc

impactDetalsstring<= 512 characters

Applicable and required when 'siteConditionsImpact' is true and holds the detailed description of site or security conditions may impact inspecting person.

isApplicantCouncilMemberboolean

describes if the applicant or owner a staff member or councillor of the council assessing the application

applicantCouncilRoleDescriptionstring<= 512 characters

applicable and required when 'isApplicantPartOfCouncil' is true

isApplicantRelatedToCouncilboolean

describes if the applicant or owner have a relationship with any staff or councillor of the council assessing the application

applicantCouncilRelationDecriptionstring<= 512 characters

applicable and required when 'applicantRelatedWithcouncilMember' is true

contractorLicenseeDetailsobject

Applicable only if 'waterWorks' is not chosen.

drainageWorkerDetailsobject

Applicable only if 'waterWorks' is chosen.

plumberDetailsobject

Applicable only if 'waterWorks' is not chosen.

manufacturerDetailsobject

payerInformationobject

isResendboolean

This is to track if application details are resent. True indicates a retriggered event.

documentsArray of objects(DownloadableDocument)

declarationsArray of strings(declarationS68)

Required applicant declaration for Section 68 of the Local Government Act

Example: ["Refer to description for values"]

updatedByobject(UpdatedBy)

curl -i -X POST \
  'https://dpie-apim-uat.redocly.app/CreateSec68/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "primaryApplicant": {
      "applyOnBehalfOfCompany": true,
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "applicantCompany": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string",
        "address": "string",
        "email": "user@example.com"
      }
    },
    "secondaryApplicants": [
      {
        "applyOnBehalfOfCompany": true,
        "contactDetails": {
          "title": "Refer to description for values",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "string",
            "address": "string"
          }
        },
        "applicantCompany": {
          "companyName": "string",
          "ABN": "12345678910",
          "ACN": "123456789",
          "tradingName": "string",
          "address": "string",
          "email": "user@example.com"
        }
      }
    ],
    "applicationType": "Refer to description for values",
    "relatedApplication": "Refer to description for values",
    "relatedApplicationAppliedViaPortal": true,
    "relatedPortalCaseID": "string",
    "isCaseAppliedOnPortal": true,
    "referenceNumberOfPastCase": "string",
    "dateOfDetermiantionOfPastCase": "2019-08-24",
    "dateOfDetermiantion": "2019-08-24",
    "modificationDescription": "string",
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "addressDetail": {
          "complexUnitType": "string",
          "complexLevelType": "string",
          "complexLevelNumber": "string",
          "complexUnitIdentifier": "string",
          "streetNumber1": "string",
          "streetNumber2": "string",
          "streetName": "string",
          "streetSuffix": "string",
          "streetType": "string",
          "suburb": "string",
          "latitude": 0,
          "longitude": 0,
          "wkid": "string",
          "cadastralID": "string",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "addressMissing": true,
        "adjacentLot": true,
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ],
        "lga": "PENRITH",
        "isPrimary": true
      }
    ],
    "developmentType": [
      {
        "publicPlace": [
          "Refer to description for values"
        ],
        "waterWorks": [
          "Refer to description for values"
        ],
        "wasteManagement": [
          "Refer to description for values"
        ],
        "publicRoadWorks": [
          "Refer to description for values"
        ],
        "communityLandWorks": [
          "Refer to description for values"
        ],
        "otherDevelopmentWorks": [
          "Refer to description for values"
        ]
      }
    ],
    "propertySize": "Refer to description for values",
    "propertyUse": "Refer to description for value",
    "noOfBedrooms": 0,
    "propertyUseOther": "string",
    "typeOfWaterSupply": "Refer to description for value",
    "typeOfWasteTreatment": [
      "Refer to description for values"
    ],
    "tradeWasteDesc": "string",
    "otherWasteDesc": "string",
    "wasteMgmtTreatmentSystem": [
      "Refer to description for values"
    ],
    "otherTreatmentSystemDesc": "string",
    "wasteMgmtTypeOfSystem": [
      "Refer to description for values"
    ],
    "otherTypeOfSystemDesc": "string",
    "tankCapacity": [
      12.5
    ],
    "proposed24HrWork": {
      "isMonWorkDay": true,
      "MonWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isTueWorkDay": true,
      "TueWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isWedWorkDay": true,
      "WedWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isThuWorkDay": true,
      "ThuWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isFriWorkDay": true,
      "FriWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSatWorkDay": true,
      "SatWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSunWorkDay": true,
      "SunWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      }
    },
    "operationHoursComments": "string",
    "otherDevelopment": "string",
    "diningAreaLicensed": true,
    "isLiquorLicenseHeld": true,
    "liquorLicenceNumber": "string",
    "briefOfProposedWorks": "string",
    "estimatedCost": 0,
    "siteConditionsImpact": true,
    "impactDetals": "string",
    "isApplicantCouncilMember": true,
    "applicantCouncilRoleDescription": "string",
    "isApplicantRelatedToCouncil": true,
    "applicantCouncilRelationDecription": "string",
    "contractorLicenseeDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "drainageWorkerDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "plumberDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "manufacturerDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "payerInformation": {
      "isPayerCompany": true,
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "payerCompany": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string",
        "address": "string",
        "email": "user@example.com"
      }
    },
    "isResend": true,
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "declarations": [
      "Refer to description for values"
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Created

Body

Response

No content

UpdateSec68

Request

This operation updates the application details entered by the applicant in the Section 68 of the Local Government Act Service to the Council's IT system.

Path

CaseIDstringrequired

A fully qualified Section 68 of the Local Government Act case

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the response is routed to.

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 80 characters

Status of the Section68 case

Example: "Submitted"

primaryApplicantobject(applicantList)required

used to hold applicant's details.

primaryApplicant.applyOnBehalfOfCompanyboolean

This property will confirm whether the applicant is a company or Not. If YES, need to provide the company details.

primaryApplicant.contactDetailsobject(applicantDetails)

primaryApplicant.applicantCompanyobject(applicantCompany)

If Apply on Behalf of Company is selected as 'Yes'

secondaryApplicantsArray of objects(applicantList)

applicationTypestring(ApplicationType)required

Example: "Refer to description for values"

relatedApplicationstring(relatedApplication)

Example: "Refer to description for values"

relatedApplicationAppliedViaPortalboolean

applicable when 'Complying Development Certificate (CDC)' or 'Development Application (DA)' is selected as part of 'relatedApplication' given options.

relatedPortalCaseIDstring

isCaseAppliedOnPortalboolean

Applicable when 'applicationType' is 'Section 68 modification application' or 'Section 68 review of determination'

referenceNumberOfPastCasestring

applicable when 'applicationType' is 'Section 68 modification application'or 'Section 68 review of determination'. This field is required when 'isCaseAppliedOnPortal' is true

dateOfDetermiantionOfPastCasestring(date)

applicable when 'applicationType' is 'Section 68 modification application' or 'Section 68 review of determination'. This field is required when 'isCaseAppliedOnPortal' is false

dateOfDetermiantionstring(date)

applicable when 'applicationType' is 'Section 68 modification application' or 'Section 68 review of determination'. This field is required when 'isCaseAppliedOnPortal' is true

modificationDescriptionstring<= 512 characters

applicable when 'applicationType' is 'Section 68 modification application' and holds the comments why the other case is modified.

siteAddressesArray of objects(Location)required

siteAddresses[].addressstring<= 250 charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"

siteAddresses[].addressDetailobject(AddressDetail)

siteAddresses[].addressMissingboolean

Used to differentiate if address is present in the system or not.

siteAddresses[].adjacentLotboolean

used to check if the land is adjacent to this lot and applicable if 'addressMissing' is true

siteAddresses[].lotListArray of objects(LotSectionPlan)

siteAddresses[].lgastring<= 30 charactersrequired

Local Government Area under which this application falls

Example: "PENRITH"

siteAddresses[].isPrimarybooleanrequired

The primary address if multiple

developmentTypeArray of objects(DevelopmentTypes)required

Holds the type of development proposed by the applicant.

developmentType[].publicPlaceArray of strings(PublicEntertainmentPlaces)

applicable when 'developmentType'is selected as 'Structure or places of public entertainment'

Example: ["Refer to description for values"]

developmentType[].waterWorksArray of strings(WaterWorks)

applicable when 'developmentType'is selected as 'Water supply, sewerage and stormwater drainage work'

Example: ["Refer to description for values"]

developmentType[].wasteManagementArray of strings(WasteMgmtWork)

applicable when 'developmentType'is selected as 'Management of waste'

Example: ["Refer to description for values"]

developmentType[].publicRoadWorksArray of strings(PublicRoadWork)

applicable when 'developmentType'is selected as 'Works and activities within public roads'

Example: ["Refer to description for values"]

developmentType[].communityLandWorksArray of strings(CommunityLandWork)

applicable when 'developmentType'is selected as 'Works and activities within Community Lands'

Example: ["Refer to description for values"]

developmentType[].otherDevelopmentWorksArray of strings(OtherDevWork)

applicable when 'developmentType' is selected as 'Other'

Example: ["Refer to description for values"]

propertySizestring

Example: "Refer to description for values"

propertyUsestring

Example: "Refer to description for value"

noOfBedroomsinteger<= 5 characters

applicable when 'Residential dwelling' is selected in 'propertyUse'

propertyUseOtherstring

applicable when 'Other' is selected in 'propertyUse'

typeOfWaterSupplystring

Example: "Refer to description for value"

typeOfWasteTreatmentArray of strings(WasteTreatementType)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the type of waste treatment

Example: ["Refer to description for values"]

tradeWasteDescstring

applicable when 'typeOfWasteTreatment' is 'Trade'

otherWasteDescstring<= 256 characters

applicable when 'typeOfWasteTreatment' is 'Other'

wasteMgmtTreatmentSystemArray of strings(TreatmentSystem)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the type of system to be installed (treatment system)

Example: ["Refer to description for values"]

otherTreatmentSystemDescstring<= 256 characters

applicable when 'wasteMgmtTreatmentSystem' is 'Other'

wasteMgmtTypeOfSystemArray of strings(TypeOfSystem)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the type of system to be installed (treatment system)

Example: ["Refer to description for values"]

otherTypeOfSystemDescstring<= 256 characters

applicable when 'wasteMgmtTypeOfSystem' is 'Other'

tankCapacityArray of numbers(decimal)(TankCapacity)

applicable when 'wasteManagement' is selected as 'Operate a system of sewage management (within the meaning of section 68A)' and holds the tank capacity in litres

Example: [12.5]

proposed24HrWorkobject

operationHoursCommentsstring<= 512 characters

applicable when 'hoursOfOperation' is present and holds additional comments on operating hours.

otherDevelopmentstring<= 512 characters

applicable when 'otherDevelopmentWorks' is selected as 'Other'

diningAreaLicensedboolean

applicable when 'communityLandWorks' has 'Engage in a trade or business' and tells if applicant is intended to operate the outdoor dining area as a licensed premises

isLiquorLicenseHeldboolean

applicable when 'diningAreaLicensed' is true and holds whether the applicant holds liquor license or not

liquorLicenceNumberstring<= 20 characters

applicable when 'isLiquorLicenseHeld' is true and holds the liquor license number provided

briefOfProposedWorksstring<= 512 charactersrequired

holds the brief explanation of the proposed works

estimatedCostnumber(decimal)

Holds the estimated cost of the works

siteConditionsImpactboolean

Tells if there are any security or site conditions which may impact on the person undertaking the inspection. eg: locked gates, animals, etc

impactDetalsstring<= 512 characters

Applicable and required when 'siteConditionsImpact' is true and holds the detailed description of site or security conditions may impact inspecting person.

isApplicantCouncilMemberboolean

describes if the applicant or owner a staff member or councillor of the council assessing the application

applicantCouncilRoleDescriptionstring<= 512 characters

applicable and required when 'isApplicantPartOfCouncil' is true

isApplicantRelatedToCouncilboolean

describes if the applicant or owner have a relationship with any staff or councillor of the council assessing the application

applicantCouncilRelationDecriptionstring<= 512 characters

applicable and required when 'applicantRelatedWithcouncilMember' is true

contractorLicenseeDetailsobject

Applicable only if 'waterWorks' is not chosen.

drainageWorkerDetailsobject

Applicable only if 'waterWorks' is chosen.

plumberDetailsobject

Applicable only if 'waterWorks' is not chosen.

manufacturerDetailsobject

payerInformationobject

documentsArray of objects(DownloadableDocument)

This block will be sending the full set of documents.

deltaDocumentsArray of objects(DownloadableDocument)

This block will be sending the delta documents uploaded or updated as part of update operation.

declarationsArray of strings(declarationS68)

Required applicant declaration for Section 68 of the Local Government Act

Example: ["Refer to description for values"]

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://dpie-apim-uat.redocly.app/UpdateSec68/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "primaryApplicant": {
      "applyOnBehalfOfCompany": true,
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "applicantCompany": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string",
        "address": "string",
        "email": "user@example.com"
      }
    },
    "secondaryApplicants": [
      {
        "applyOnBehalfOfCompany": true,
        "contactDetails": {
          "title": "Refer to description for values",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "string",
            "address": "string"
          }
        },
        "applicantCompany": {
          "companyName": "string",
          "ABN": "12345678910",
          "ACN": "123456789",
          "tradingName": "string",
          "address": "string",
          "email": "user@example.com"
        }
      }
    ],
    "applicationType": "Refer to description for values",
    "relatedApplication": "Refer to description for values",
    "relatedApplicationAppliedViaPortal": true,
    "relatedPortalCaseID": "string",
    "isCaseAppliedOnPortal": true,
    "referenceNumberOfPastCase": "string",
    "dateOfDetermiantionOfPastCase": "2019-08-24",
    "dateOfDetermiantion": "2019-08-24",
    "modificationDescription": "string",
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "addressDetail": {
          "complexUnitType": "string",
          "complexLevelType": "string",
          "complexLevelNumber": "string",
          "complexUnitIdentifier": "string",
          "streetNumber1": "string",
          "streetNumber2": "string",
          "streetName": "string",
          "streetSuffix": "string",
          "streetType": "string",
          "suburb": "string",
          "latitude": 0,
          "longitude": 0,
          "wkid": "string",
          "cadastralID": "string",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "addressMissing": true,
        "adjacentLot": true,
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ],
        "lga": "PENRITH",
        "isPrimary": true
      }
    ],
    "developmentType": [
      {
        "publicPlace": [
          "Refer to description for values"
        ],
        "waterWorks": [
          "Refer to description for values"
        ],
        "wasteManagement": [
          "Refer to description for values"
        ],
        "publicRoadWorks": [
          "Refer to description for values"
        ],
        "communityLandWorks": [
          "Refer to description for values"
        ],
        "otherDevelopmentWorks": [
          "Refer to description for values"
        ]
      }
    ],
    "propertySize": "Refer to description for values",
    "propertyUse": "Refer to description for value",
    "noOfBedrooms": 0,
    "propertyUseOther": "string",
    "typeOfWaterSupply": "Refer to description for value",
    "typeOfWasteTreatment": [
      "Refer to description for values"
    ],
    "tradeWasteDesc": "string",
    "otherWasteDesc": "string",
    "wasteMgmtTreatmentSystem": [
      "Refer to description for values"
    ],
    "otherTreatmentSystemDesc": "string",
    "wasteMgmtTypeOfSystem": [
      "Refer to description for values"
    ],
    "otherTypeOfSystemDesc": "string",
    "tankCapacity": [
      12.5
    ],
    "proposed24HrWork": {
      "isMonWorkDay": true,
      "MonWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isTueWorkDay": true,
      "TueWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isWedWorkDay": true,
      "WedWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isThuWorkDay": true,
      "ThuWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isFriWorkDay": true,
      "FriWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSatWorkDay": true,
      "SatWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSunWorkDay": true,
      "SunWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      }
    },
    "operationHoursComments": "string",
    "otherDevelopment": "string",
    "diningAreaLicensed": true,
    "isLiquorLicenseHeld": true,
    "liquorLicenceNumber": "string",
    "briefOfProposedWorks": "string",
    "estimatedCost": 0,
    "siteConditionsImpact": true,
    "impactDetals": "string",
    "isApplicantCouncilMember": true,
    "applicantCouncilRoleDescription": "string",
    "isApplicantRelatedToCouncil": true,
    "applicantCouncilRelationDecription": "string",
    "contractorLicenseeDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "drainageWorkerDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "plumberDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "manufacturerDetails": {
      "applyOnBehalfOfCompany": true,
      "companyDetails": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string"
      },
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        },
        "licenceNumber": "string"
      }
    },
    "payerInformation": {
      "isPayerCompany": true,
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "payerCompany": {
        "companyName": "string",
        "ABN": "12345678910",
        "ACN": "123456789",
        "tradingName": "string",
        "address": "string",
        "email": "user@example.com"
      }
    },
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "deltaDocuments": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "declarations": [
      "Refer to description for values"
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Created

Body

Response

No content

Assessment

Request

This operation is to send information of the assessment of Referrals to Council's IT system.

Path

CaseIDstringrequired

A fully qualified Referral case for S68

Headers

OrganisationIDstringrequired

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

Bodyapplication/jsonrequired

Information request object

childCaseIDstring

Used to hold the child case ID to perform RFI.

Example: "REF-XXXX"

primaryCaseIDstring

Used to hold Section68 case ID.

Example: "S68-XXXX"

caseStatusstring<= 80 charactersrequired

Status of the Referral case

Example: "Submitted"

agencyOfficerstringrequired

Assign case to

Example: "Test@yopmail.com"

preliminaryReviewstring(Preliminary Review)required

Following a preliminary review, is the detail provided complete and is the case ready for a decision? One of the below mentioned values must be selected for PreliminaryReview 1. Yes, the application is ready for decision 2. No, need more information

Example: "Refer to description for values"

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://dpie-apim-uat.redocly.app/Assessment/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "childCaseID": "REF-XXXX",
    "primaryCaseID": "S68-XXXX",
    "caseStatus": "Submitted",
    "agencyOfficer": "Test@yopmail.com",
    "preliminaryReview": "Refer to description for values",
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case Submitted by Applicant

Body

Response

No content

Decision

Request

This operation is to send information of the determination of Referrals to Council's IT system.

Path

CaseIDstringrequired

A fully qualified Referral case

Headers

OrganisationIDstringrequired

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

Bodyapplication/jsonrequired

Information request object

childCaseIDstring

Used to hold the child case ID to perform RFI.

Example: "REF-XXXX"

primaryCaseIDstring

Used to hold section68 case ID.

Example: "S68-XXXX"

caseStatusstring<= 80 charactersrequired

Status of the Referral case

Example: "Submitted"

decisionOutcomestring(DecisionOutcome)required

What is the outcome of your assessment? One of the below mentioned values must be selected for DecisionOutcome 1. Advice 2. Decision not required

Example: "Refer to description for values"

commentsstring<= 512 charactersrequired

documentsArray of objects(DownloadableDocument)

Documents will be avialble if the reviewOfOutcome is 'Return application'

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://dpie-apim-uat.redocly.app/Decision/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "childCaseID": "REF-XXXX",
    "primaryCaseID": "S68-XXXX",
    "caseStatus": "Submitted",
    "decisionOutcome": "Refer to description for values",
    "comments": "string",
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case decision is completed

Body

Response

No content

Section 68 - ePlanning to Council API (v1)

Authentication

CreateSec68

Request

Responses

Was this helpful?

UpdateSec68

Request

Responses

Was this helpful?

Assessment

Request

Responses

Was this helpful?

Decision

Request

Responses

Was this helpful?

Section 68 - ePlanning to Council API (v1)

Authentication

CreateSec68

RequestExpand all

Responses

Was this helpful?

UpdateSec68

RequestExpand all

Responses

Was this helpful?

Assessment

RequestExpand all

Responses

Was this helpful?

Decision

RequestExpand all

Responses

Was this helpful?

Request

Request

Request

Request