DCOM Result Service API

Base URL: /api/, Version:

This is the API for the Result Service version: '1.0.0' Results are immutable, once they are placed into a result service by a rule engine they cannot be changed/deleted.

Default request content-types: application/json, application/xml
Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/v1/ GET

Retrieves the basic metadata about the result server
/v1/{building}/ GET

Returns a list of all compliance checks available for a given building

PATCH

Submits an update to the buildings UPRN
/v1/{building}/all GET

Returns a list of all compliance results across all compliance checks for a given building
/v1/{building}/{complianceCheckUID} GET

Returns a list of all compliance results from a given compliance check for a given building
PUT

Submits new compliance results

Security

authService

Type: bearer
Description:

An bearer authorization token to prove the service is authorized to submit compliance results

authUser

Type: bearer
Description:

An bearer authorization token to prove the user is authorized to access compliance results. Acquired from the OATH2 Security Service related to this service.

Paths

Retrieves the basic metadata about the result server

GET /v1/

Retrieves the basic metadata about the result server

Uses default content-types: application/json application/xml

200 OK

Returns basic metadata about the Result Service. Equivalent XML Response is returned if content type is set appropriately.

ServerIdentity
Returns a list of all compliance checks available for a given building

GET /v1/{building}/

Returns a list of all compliance checks available for a given building

building

The UPRN of the building being considered - as described here

 path string

Uses default content-types: application/json application/xml

200 OK

Returns a list of Compliance Checks that the user is allowed to view. Equivalent XML Response is returned if content type is set appropriately.

results: object[]
ComplianceCheckItem
authUser
Submits an update to the buildings UPRN

PATCH /v1/{building}/

Submits an update to the buildings UPRN

Uses default content-types: application/json application/xml

UPRN: string

An updated UPRN to be used in place of the existing UPRN
building

The UPRN of the building being considered - as described here

 path string

Uses default content-types: application/json application/xml

200 OK
success: boolean
authUser
Returns a list of all compliance results across all compliance checks for a given building

GET /v1/{building}/all

Returns a list of all compliance results across all compliance checks for a given building
building

The UPRN of the building being considered - as described here

 path string
start

The Start Date/Time to query

 query string (date-time)
end

The End Date/Time to query

 query string (date-time)
documentFilter

Filter based on the compliance document against which the compliance check was performed. This is free text - will will be matched against the document path provided within the result service i.e. AD_PartL2A/1 - for AD_PartL2A section 1

 query string
search

A free text search field to search results

 query string

Uses default content-types: application/json application/xml

200 OK

Returns a list of Compliance Results that the user is allowed to view. Equivalent XML Response is returned if content type is set appropriately.

results: object[]
ComplianceResultDataItem
authUser
Returns a list of all compliance results from a given compliance check for a given building

GET /v1/{building}/{complianceCheckUID}

Returns a list of all compliance results from a given compliance check for a given building
building

The UPRN of the building being considered - as described here

 path string
complianceCheckUID

The Unique ID of the compliance check being considered

 path string
start

The Start Date/Time to query

 query string (date-time)
end

The End Date/Time to query

 query string (date-time)
search

A free text search field to search results

 query string

Uses default content-types: application/json application/xml

200 OK

Returns a list of Compliance Results that the user is allowed to view. Equivalent XML Response is returned if content type is set appropriately.

results: object[]
ComplianceResultDataItem
authUser
Submits new compliance results

PUT /v1/{building}/{complianceCheckUID}

Submits new compliance results

Uses default content-types: application/json application/xml

conditions: string[]

A an array of conditions set on the approval by building control

string
results: object[]
ComplianceResultDataItem
building

The UPRN of the building being considered - as described here

 path string
complianceCheckUID

The Unique ID of the compliance check being considered

 path string

Uses default content-types: application/json application/xml

200 OK
success: boolean
authService

Schema definitions

ComplianceCheckItem: object

Represents the lists of compliance checks for a given building

complianceDocument: string

The URI of the compliance document this compliance check has checked against

complianceCheckUID: string

The UID of this compliance check

result: string , x ∈ { true , false }

The Final Result of this compliance check

time: string (date-time)

The date/time that this comliance check was generated

ComplianceResultDataItem: object

Represents an individual result from a compliance check

reference: string

The URI of the clause within a compliance document that this result is generated from

time: string (date-time)

The date/time that this result was generated

reasons: string[]

A set of reasons why this result has been computed this includes information on what data items have been used, what software tools produced this results, if the result was automatically or human generated etc...

string
attributation: string

A string describing what/who generated this result

result: string , x ∈ { true , false }

The result that has been computed

supportingFileData: string

The BASE64 Encoded File Data that supports/evidences this answer

supportingFileContentType: string

The MIME Content Type of the Support file data (if present)

ServerIdentity: object

Represents the basic metadata of the results service

name: string

The name of this result service

description: string

A description of this result service

operator: string

The name of the organisation operating this result service

securityServiceType: string

The type of authorisation/authentication service used by this result service

securityServiceURI: string

The URL of the OAUTH2 security service utilised by this result service