UpdateBIC

This operation transfers the application updates from the Building Information certificate Service to the council's IT system.

path Parameters
CaseID
required
string

A fully qualified Planning BIC case

header Parameters
OrganisationID
required
string

Used by the API gateway to identify the agency to which the response needs to be routed to.

Request Body schema: application/json

Information request object

caseStatus
required
string [ 1 .. 80 ] characters

Status of the BIC case

isPrimaryApplicant
string

This is to track primary applicant type for the application. One of the below mentioned values must be selected for the field. 1. The landowner 2. A representative of the landowner 3. The purchaser of a property under a contract of sale 4. A public authority that has notified the owner that you are applying for a Building Information Certificate

object (applicantList)

used to hold owner’s Corporation details.

Array of objects (applicantList)
securityConditions
required
boolean

This is to track if there are any security or site conditions that may impact on the person undertaking the inspection.

detailsOfSecurityConditions
string <= 512 characters

This is to track the detailed description of the security or site conditions that impact the person undertaking the inspection. Visible if SecurityConditions is true.

object (SiteAccessPerson)

This is to track the details of the person that will provide access to the site, if different to the primary applicant.

required
Array of objects (Location)
Array of objects (buildingStructureList)
structureDescription
required
string non-empty

This is to track the detailed description of the structures the Building Information Certificate would apply to.

reasonForApplying
required
string non-empty

This is to track the reason why Building Information Certificate is applied. One of the below values must be selected. 1. Property sale/purchase 2. Review unauthorised work 3. Other

Array of objects (BICWorkList)

This is to track the consent or certificate information for the works proposed. Visible if reasonForApplying is Review unauthorised work.

worksErectedOrAlteredinMonth
string

This is to track the month the works erected or altered. Visible if reasonForApplying is Review unauthorised work or Other.

worksErectedOrAlteredinYear
number

This is to track the year the works erected or altered. Visible if reasonForApplying is Review unauthorised work or Other.

isWorksErectAlterDateUnknown
boolean

This is to indicate the month and year the works erected or altered is not known. Visible if reasonForApplying is Review unauthorised work or Other.

reasonforOther
string

This is to track the detailed description of other reason mentioned for appliying certificate. Visible and required if applicant selects reasonForApplying as Other.

object (contractorDetails)

Applicable when reasonForApplying is Review unauthorised work or Other

object
Array of objects (DownloadableDocument)
Array of objects (DownloadableDocument)
declarations
required
Array of strings (Declaration)
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "Submitted",
  • "isPrimaryApplicant": "Refer to description for values.",
  • "primaryApplicant": {
    },
  • "additionalApplicants": [
    ],
  • "securityConditions": true,
  • "detailsOfSecurityConditions": "string",
  • "siteAccessPersonDetails": {
    },
  • "siteAddresses": [
    ],
  • "listOfBuildingStructures": [
    ],
  • "structureDescription": "string",
  • "reasonForApplying": "Refer to description for values.",
  • "doWorkHave": [
    ],
  • "worksErectedOrAlteredinMonth": "March",
  • "worksErectedOrAlteredinYear": 2021,
  • "isWorksErectAlterDateUnknown": true,
  • "reasonforOther": "string",
  • "contractorDetails": {
    },
  • "payerInformation": {
    },
  • "deltaDocuments": [
    ],
  • "documents": [
    ],
  • "declarations": [
    ],
  • "updatedBy": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 404,
  • "message": "Internal Server error 19876",
  • "activityId": "00000011-0ab-xy00-0000-500000000000",
  • "errorCode": "DPE_TMS01",
  • "errorDetails": "Inner Exceptions, Stack Trace, etc"
}
Next to ResponseToDeferredDetermination