Hometrack Organisation API
The Organisation API from Hometrack — 16 operation(s) for organisation.
Hometrack Organisation API is one of 18 APIs that Hometrack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Organisation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 19 operations across 16 paths, and defines 257 schemas. It is described by OpenAPI 3.2.0, at version v2.0.
Requests are made against 2 base URLs: https://api.hometrack.com/prh, https://api.hometrack.local/prh.
19 operations
16 paths
257 schemas
15 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Hometrack Organisation API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Ocp-Apim-Subscription-Key (apiKeyHeader).
An API key is passed in the query as subscription-key (apiKeyQuery).
By default, every request must be authenticated, though some operations may also be called without credentials.
Paths & Operations 19
Across 16 paths, the API surfaces 19 operations — 15 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Organisation 19
GET
/organisation/{orgId}/case
/organisation/{orgId}/case - GET
GET
/organisation/{orgId}/case/{caseId}
/organisation/{orgId}/case/{caseId} - GET
GET
/organisation/{orgId}/case/{caseId}/documents
/organisation/{orgId}/case/{caseId}/documents - GET
POST
/organisation/{orgId}/case/{caseId}/documents
/organisation/{orgId}/case/{caseId}/documents - POST
GET
/organisation/{orgId}/case/{caseId}/documents/{documentReference}
/organisation/{orgId}/case/{caseId}/documents/{documentReference} - GET
GET
/organisation/{orgId}/case/{caseId}/documents/{documentReference}/verify
/organisation/{orgId}/case/{caseId}/documents/{documentReference}/verify - GET
GET
/organisation/{orgId}/case/{caseId}/process/{caseProcessId}
/organisation/{orgId}/case/{caseId}/process/{caseProcessId} - GET
GET
/organisation/{orgId}/case/{caseId}/process/{caseProcessId}/status
/organisation/{orgId}/case/{caseId}/process/{caseProcessId}/status - GET
GET
/organisation/{orgId}/case/{caseId}/report
/organisation/{orgId}/case/{caseId}/report - GET
GET
/organisation/{orgId}/case/{caseId}/report/{revision}
/organisation/{orgId}/case/{caseId}/report/{revision} - GET
GET
/organisation/{orgId}/case/{caseId}/report/latest
/organisation/{orgId}/case/{caseId}/report/latest - GET
GET
/organisation/{orgId}/case/{caseId}/status
/organisation/{orgId}/case/{caseId}/status - GET
POST
/organisation/{orgId}/case/{caseId}/status
/organisation/{orgId}/case/{caseId}/status - POST
GET
/organisation/{orgId}/case/{caseId}/status/latest
/organisation/{orgId}/case/{caseId}/status/latest - GET
POST
/organisation/{orgId}/instruction
/organisation/{orgId}/instruction - POST
PUT
/organisation/{orgId}/instruction
/organisation/{orgId}/instruction - PUT
GET
/organisation/{orgId}/property/repository
/organisation/{orgId}/property/repository - GET
GET
/organisation/{orgId}/property/repository/{repositoryId}
/organisation/{orgId}/property/repository/{repositoryId} - GET
GET
/organisation/{orgId}/property
/organisation/{orgId}/property?postalCode={postalCode} - GET
Schemas 257
The contract defines 257 schemas that model the data the API accepts and returns. The most detailed are OrganisationOrgIdCaseCaseIdGet200ApplicationJsonResponse (51 properties), OrganisationOrgIdCaseCaseIdReportRevisionGet200ApplicationJsonResponse (24 properties), OrganisationOrgIdCaseCaseIdReportLatestGet200ApplicationJsonResponse (24 properties), Address_3 (19 properties). Each schema is shown below with its type and property counts.
OrganisationOrgIdPropertyGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet403Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet401ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet202Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet500ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet401ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut504ApplicationJsonResponse
object
2 properties
1 required
Address_1
object
The address object containing the address of the property.
18 properties
2 required
OrganisationOrgIdInstructionPost502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet405ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet429ApplicationJsonResponse
object
2 properties
1 required
Address
object
The address object containing the address of the property.
18 properties
2 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet401Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet500ApplicationJsonResponse
object
2 properties
1 required
Address_3
object
The address object containing the address of the property.
19 properties
2 required
OrganisationOrgIdCaseCaseIdStatusGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet429ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is provided when retrieving a case from the Prism system.
51 properties
OrganisationOrgIdInstructionPost400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet200ApplicationJsonResponse
array
OrganisationOrgIdCaseCaseIdDocumentsGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is provided when retrieving a list of cases from the Prism system.
5 properties
OrganisationOrgIdCaseCaseIdDocumentsGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet405ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet200Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost200ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is return in the JSON when responding to the request made to the Retrieve Case Report API on the Prism system.
24 properties
1 required
OrganisationOrgIdCaseGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet405Application
object
2 properties
1 required
OrganisationOrgIdInstructionPut400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet200ApplicationJsonRe
object
1 property
OrganisationOrgIdPropertyRepositoryGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet200ApplicationJsonResponse
object
1 property
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet200ApplicationJsonResponse
object
8 properties
2 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define the response when retrieving a case process from PRH.
8 properties
OrganisationOrgIdCaseCaseIdStatusLatestGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet425ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost406ApplicationJsonResponse
object
2 properties
1 required
Generated-2
object
8 properties
OrganisationOrgIdCaseCaseIdStatusPost400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet502ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is return in the JSON when responding to the request made to the Create Instruction API on the PRH system.
11 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is return in the JSON when responding to the request made to the Property Repository resource on the RiskHub…
11 properties
OrganisationOrgIdCaseCaseIdStatusLatestGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet415Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet504Application
object
2 properties
1 required
OrganisationOrgIdPropertyGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet406Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet504ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet429ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet404Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet401ApplicationJsonResponse
object
2 properties
1 required
Generated
object
The purpose of this JSON schema is to define what is required in the JSON to create an instruction on the PRH system.
13 properties
4 required
OrganisationOrgIdCaseCaseIdReportGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet502Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet429Application
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet403ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet415ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet404ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet425Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is return in the JSON when responding to the request made to the Retrieve Case Report API on the Prism system.
24 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet404ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet406ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdInstructionPut200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is return in the JSON when responding to the request made to the Update Instruction API on the Prism system.
11 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet504ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdInstructionPost504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet500Application
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet500ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet400ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet406ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdPropertyGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryRepositoryIdGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet504ApplicationJsonResponse
object
2 properties
1 required
Generated-1
object
The purpose of this JSON schema is to define what is required in the JSON to create an instruction on the Prism system.
15 properties
4 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet403ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet200ApplicationJsonRe
object
The purpose of this JSON schema is to define the response when retrieving a case process status from PRH.
7 properties
OrganisationOrgIdCaseGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is provided when attempting to find a list of properties through the RiskHub system.
5 properties
OrganisationOrgIdCaseGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost406ApplicationJsonResponse
object
2 properties
1 required
Generated-3
array
OrganisationOrgIdCaseCaseIdReportRevisionGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceVerifyGet400Application
object
2 properties
1 required
OrganisationOrgIdInstructionPut405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet415ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPut425ApplicationJsonResponse
object
2 properties
1 required
Address_2
object
The address object containing the address of the property.
18 properties
2 required
OrganisationOrgIdPropertyGet405ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet400ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet401ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdInstructionPost500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusPost404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet500ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet400ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportRevisionGet404ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet500ApplicationJsonResponse
object
2 properties
1 required
Address_4
object
Address object used for both property and contact addresses. All fields are optional apart from Line1 and PostalCode.
18 properties
2 required
OrganisationOrgIdCaseCaseIdProcessCaseProcessIdStatusGet425ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet200ApplicationJsonResponse
object
The purpose of this JSON schema is to define what is return in the JSON when responding to the request made to the Property Repository resource on the RiskHub…
11 properties
OrganisationOrgIdCaseGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyGet403ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsDocumentReferenceGet502ApplicationJsonRe
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet502ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdPropertyRepositoryGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost429ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusLatestGet504ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportGet425ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdStatusGet200ApplicationJsonResponse
array
OrganisationOrgIdCaseCaseIdStatusPost415ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdReportLatestGet406ApplicationJsonResponse
object
2 properties
1 required
OrganisationOrgIdCaseCaseIdDocumentsPost202ApplicationJsonResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hometrack 12
Other APIs Hometrack publishes across the network.
Hometrack Authentication API
Hometrack Brands API
Hometrack Broker API
Hometrack Epc Hometrack API
Hometrack Flood Twinn API
Hometrack Ground Coastalerosion Twinn API
Hometrack Ground Subsidence Twinn API
Hometrack Ground Terrafirma API
Hometrack Internal API
Hometrack Licences API
Hometrack Partners API
Hometrack Pvrplugin API
#Organisation
Where this information came from
This is an independent, third-party profile of Hometrack Organisation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.