DCOM Compliance Document Server API

Base URL: /api/v1/, Version:

This is the API for the Compliance Document Server version: '1.0.0'. It is important to note when reading this API that any given version of a compliance documents is immutable and once a specific version is published it cannot be changed. To update a document a new version must be created.

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 compliance document server
/v1/{jurisdiction}	GET	Returns a list of all compliance documents covering the given jurisdiction
/v1/{jurisdiction}/{type}	GET	Returns a list of all compliance documents of a given type covering the given jurisdiction
/v1/{jurisdiction}/{type}/{shortName}	GET	Returns the latest version of a compliance document
/v1/{jurisdiction}/{type}/{shortName}	PUT	Creates a new compliance document
/v1/{jurisdiction}/{type}/{shortName}/{version}	GET	Returns a specified version of a compliance document
/v1/{jurisdiction}/{type}/{shortName}/{version}	PUT	Updates a compliance document by creating a new version using the specified version name
/v1/{jurisdiction}/{type}/{shortName}/{version}/{documentReference}	GET	Returns a specific section/paragraph of a compliance document
	PUT	Updates a section/paragraph of a compliance document creating a new version using the specific version name

Security

auth

Type: bearer

Description:: An bearer authorization token to prove the user is authorized to edit/create compliance documents. Acquired from the OATH2 Security Service related to this service.

Paths

Retrieves the basic metadata about the compliance document server

GET /v1/

Retrieves the basic metadata about the compliance document server

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

200 OK: Returns basic metadata about the Compliance Document Server. Equivalent XML Response is returned if content type is set appropriately.

ServerIdentity

Returns a list of all compliance documents covering the given jurisdiction

GET /v1/{jurisdiction}

Returns a list of all compliance documents covering the given jurisdiction


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string

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

200 OK: Returns a list of Compliance Documents. Equivalent XML Response is returned if content type is set appropriately.

ComplianceDocumentIndex

Returns a list of all compliance documents of a given type covering the given jurisdiction

GET /v1/{jurisdiction}/{type}

Returns a list of all compliance documents of a given type covering the given jurisdiction


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string
type	The type of the document as per the defined types in the Compliance Document Specifications	path	integer , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 9 , 10 }

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

200 OK: Returns a list of Compliance Documents. Equivalent XML Response is returned if content type is set appropriately.

ComplianceDocumentIndex

Returns the latest version of a compliance document

GET /v1/{jurisdiction}/{type}/{shortName}

Returns the latest version of a compliance document


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string
type	The type of the document as per the defined types in the Compliance Document Specifications	path	integer , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 9 , 10 }
shortName	The Short URL Friendly Title of the Compliance Document	path	string
diff	The version of the compliance document that should be compared with this one for changes	query	string
query	Instruct the server to return either the full compliance document(full), or provide the outline structure with all content removed (structure)	query	string , x ∈ { full,structure }

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

200 OK: Returns the latest version of the compliance document identified by shortName of the given type, covering the given jurisdiction. Response is a compliance document structured according to these specifications. XML or JSON returned according to the content-type specified.

Creates a new compliance document

PUT /v1/{jurisdiction}/{type}/{shortName}

Creates a new compliance document

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

A compliance document structured according to these specifications. XML or JSON returned according to the content-type specified.


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string
type	The type of the document as per the defined types in the Compliance Document Specifications	path	integer , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 9 , 10 }
shortName	The Short URL Friendly Title of the Compliance Document	path	string

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

200 OK

success: boolean


auth

Returns a specified version of a compliance document

GET /v1/{jurisdiction}/{type}/{shortName}/{version}

Returns a specified version of a compliance document


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string
type	The type of the document as per the defined types in the Compliance Document Specifications	path	integer , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 9 , 10 }
shortName	The Short URL Friendly Title of the Compliance Document	path	string
version	The version name of the document to retrieve, or the latest version if absent.	path	string
diff	The version of the compliance document that should be compared with this one for changes	query	string
query	Instruct the server to return either the full compliance document(full), or provide the outline structure with all content removed (structure)	query	string , x ∈ { full,structure }

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

200 OK: Response is a compliance document structured according to these specifications. XML or JSON expected according to the content-type specified.

Updates a compliance document by creating a new version using the specified version name

PUT /v1/{jurisdiction}/{type}/{shortName}/{version}

Updates a compliance document by creating a new version using the specified version name. This is a PUT operation due to the fact that any given version of a compliance documents is immutable and once a specific version is published it cannot be changed. To update a document a new version must be created.

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

A compliance document structured according to these specifications. XML or JSON expected according to the content-type specified.


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string
type	The type of the document as per the defined types in the Compliance Document Specifications	path	integer , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 9 , 10 }
shortName	The Short URL Friendly Title of the Compliance Document	path	string
version	The version name of the document section/paragraph being created	path	string

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

200 OK

success: boolean

500 Internal Server Error


auth

Returns a specific section/paragraph of a compliance document

GET /v1/{jurisdiction}/{type}/{shortName}/{version}/{documentReference}

Returns a specific section/paragraph of a compliance document


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string
type	The type of the document as per the defined types in the Compliance Document Specifications	path	integer , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 9 , 10 }
shortName	The Short URL Friendly Title of the Compliance Document	path	string
version	The version name of the document to retrieve, or the latest version if absent.	path	string
documentReference	The reference to the specific section/paragraph to retrieve. Should be a list of section or paragraph numbered seperated by the / character. An example for this is /1/2/a for Section 1, Paragraph 2 sub paragraph a	path	string
diff	The version of the compliance document that should be compared with this one for changes	query	string
query	Instruct the server to return either the full compliance document(full), or provide the outline structure with all content removed (structure)	query	string , x ∈ { full,structure }

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

200 OK: Response is a compliance document structured according to these specifications. XML or JSON expected according to the content-type specified.

Updates a section/paragraph of a compliance document creating a new version using the specific version name

PUT /v1/{jurisdiction}/{type}/{shortName}/{version}/{documentReference}

Updates a section/paragraph of a compliance document by creating a new version of this section/paragraph using the specified version name. This is a PUT operation due to the fact that any given version of a compliance documents is immutable and once a specific version is published it cannot be changed. To update a document a new version must be created.

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

A compliance document structured according to these specifications. XML or JSON expected according to the content-type specified.


jurisdiction	The geographical area the document is relevant to. Specified using terms from ISO 3166-2	path	string
type	The type of the document as per the defined types in the Compliance Document Specifications	path	integer , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 9 , 10 }
shortName	The Short URL Friendly Title of the Compliance Document	path	string
version	The version name of the document section/paragraph being created	path	string
documentReference	The reference to the specific section/paragraph to retrieve. Should be a list of section or paragraph numbered seperated by the / character. An example for this is /1/2/a for Section 1, Paragraph 2 sub paragraph a	path	string

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

200 OK

success: boolean


auth

Schema definitions

ComplianceDocumentIndex: object

Represents the essential metadata of a single compliance document within the index of compliance documents

uid: string

The unique identifier of this compliance document

shortName: string

The shortened name for a compliance document that is used as part of the document URI.

fullName: string

The full, as published, name of the compliance document.

latestVersion: string

The descriptive name of the latest version of this document.

latestVersionDate: string (date)

The date on which the latest version was published.

versions:: object[]

A list of all versions of this document

object

version: string: The descriptive name of this version of the document.
versionDate: string (date): The date on which this version was published.

language: string

The language of the document. Specified using a language code from ISO 639-2

documentType: object , x ∈ { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 }

The type of this document. These are defined as: 0: Policy, 1: Legislation, 2: Regulations, 3: Guidance, 4: Standards, 5: Products, 6: Testing/Simulating, 7: Certificates of Conformity, 8: Requirements, 9: Specification.

jurisdiction: string

The geographical area the document is relevant to. Specified using terms from ISO 3166-2

embeddedLogic: object , x ∈ { None , RASE , EL }

The type of logic embeded within this compliance document

ServerIdentity: object

Represents the basic metadata of the compliance document server, including an index of compliance documents

name: string: The name of this compliance document server
description: string: A description of this compliance document server
operator: string: The name of the organisation operating this compliance document server
securityServiceType: string: The type of authorisation/authentication service used by this compliance document server
securityServiceURI: string: The URL of the OAUTH2 security service utilised by this compliance document server
documentList: object[]: A list of all document stored on this compliance document server

ComplianceDocument