operational-api (1.0)

Download OpenAPI specification:Download

Authentication

Operations related to authentication

Authentication Login

Authorizations:

api_key

header Parameters

Content-Type

required

string

Request Body schema: application/json

password required	string
username required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"username": "string"
}

Response samples

200

Content type

application/json

{"accessToken": "string",
"expiresIn": 0,
"tokenType": "string"
}

Jobs

Operations related to jobs

List Job Types

Authorizations:

ApiAuthorizerapi_key

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"passPercentage": 0
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Create a Job

Authorizations:

ApiAuthorizerapi_key

header Parameters

Content-Type required	string
x-api-key	string
x-api-token	string

Request Body schema: application/json

endAt required	integer <int32>
instructions	string
jobTypeId required	string
reference required	string
requiresSignature required	boolean
siteId required	string
startAt required	integer <int32>
technicianId required	string
zoneIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"endAt": 0,
"instructions": "string",
"jobTypeId": "string",
"reference": "string",
"requiresSignature": true,
"siteId": "string",
"startAt": 0,
"technicianId": "string",
"zoneIds": ["string"
]
}

Response samples

201

Content type

application/json

{"closedBy": "string",
"completedAt": 0,
"createdAt": 0,
"durationMinutes": 0,
"endedAt": 0,
"futureStartDate": true,
"id": "string",
"instructions": "string",
"jobTypeId": "string",
"latestStatus": "string",
"number": "string",
"paused": true,
"reference": "string",
"requiresSignature": true,
"signatureName": "string",
"siteId": "string",
"startedAt": 0,
"syncedAt": 0,
"technicianId": "string",
"updatedAt": 0,
"userId": "string"
}

List Jobs By Site

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"closedBy": "string",
"completedAt": 0,
"createdAt": 0,
"durationMinutes": 0,
"endedAt": 0,
"futureStartDate": true,
"id": "string",
"instructions": "string",
"jobTypeId": "string",
"latestStatus": "string",
"number": "string",
"paused": true,
"reference": "string",
"requiresSignature": true,
"signatureName": "string",
"siteId": "string",
"startedAt": 0,
"syncedAt": 0,
"technicianId": "string",
"updatedAt": 0,
"userId": "string"
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Get Job Type By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"description": "string",
"id": "string",
"passPercentage": 0
}

Get Job By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"closedBy": "string",
"completedAt": 0,
"createdAt": 0,
"durationMinutes": 0,
"endedAt": 0,
"futureStartDate": true,
"id": "string",
"instructions": "string",
"jobTypeId": "string",
"latestStatus": "string",
"number": "string",
"paused": true,
"reference": "string",
"requiresSignature": true,
"signatureName": "string",
"siteId": "string",
"startedAt": 0,
"syncedAt": 0,
"technicianId": "string",
"updatedAt": 0,
"userId": "string"
}

Users

Operations related to users

Get Technician By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"active": true,
"createdAt": 0,
"email": "string",
"lastName": "string",
"name": "string",
"updatedAt": 0
}

List Technicians

Authorizations:

ApiAuthorizerapi_key

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"active": true,
"createdAt": 0,
"email": "user@example.com",
"id": "string",
"lastName": "string",
"name": "string",
"updatedAt": 0
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Assets

Operations related to assets

Get Asset By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"assetTypeId": "string",
"barcode": "string",
"code": "string",
"createdAt": 0,
"decommissionedAt": 0,
"defective": true,
"id": "string",
"lastInspection": 0,
"metaData": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"value": "string"
}
],
"nextInspection": 0,
"riskLevel": "string",
"updatedAt": 0,
"zoneId": "string"
}

List Assets

Authorizations:

ApiAuthorizerapi_key

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"assetTypeId": "string",
"barcode": "string",
"code": "string",
"createdAt": 0,
"decommissionedAt": 0,
"defective": true,
"id": "string",
"lastInspection": 0,
"metaData": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"value": "string"
}
],
"nextInspection": 0,
"riskLevel": "string",
"updatedAt": 0,
"zoneId": "string"
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Update Asset

Authorizations:

ApiAuthorizerapi_key

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Request Body schema: application/json

assetTypeId	string <uuid>
code	string
id required	string <uuid>
riskLevel	string
zoneId	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"assetTypeId": "8b5111d6-fc22-4841-bf1b-479a403efd40",
"code": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"riskLevel": "string",
"zoneId": "c3920607-5069-4ac3-ba10-00754e7a8e8b"
}

Response samples

200

Content type

application/json

{"assetTypeId": "string",
"barcode": "string",
"code": "string",
"createdAt": 0,
"decommissionedAt": 0,
"defective": true,
"id": "string",
"lastInspection": 0,
"metaData": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"value": "string"
}
],
"nextInspection": 0,
"riskLevel": "string",
"updatedAt": 0,
"zoneId": "string"
}

Create Asset

Authorizations:

ApiAuthorizerapi_key

header Parameters

Content-Type	string
x-api-key	string
x-api-token	string

Request Body schema: application/json

assetTypeId required	string <uuid>
barcode	string
code	string
	Array of objects
riskLevel required	string
zoneId required	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"assetTypeId": "8b5111d6-fc22-4841-bf1b-479a403efd40",
"barcode": "string",
"code": "string",
"metaData": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"value": "string"
}
],
"riskLevel": "string",
"zoneId": "c3920607-5069-4ac3-ba10-00754e7a8e8b"
}

Response samples

201

Content type

application/json

{"assetTypeId": "string",
"barcode": "string",
"code": "string",
"createdAt": 0,
"decommissionedAt": 0,
"defective": true,
"id": "string",
"lastInspection": 0,
"metaData": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"value": "string"
}
],
"nextInspection": 0,
"riskLevel": "string",
"updatedAt": 0,
"zoneId": "string"
}

List Asset Types

Authorizations:

ApiAuthorizerapi_key

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"customFields": [{"default": "string",
"fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
"isRequired": true,
"label": "string",
"options": [ ],
"placeholder": "string"
}
],
"id": "string",
"name": "string",
"riskLevel": "string"
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Get Asset Type By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"customFields": [{"default": "string",
"fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
"isRequired": true,
"label": "string",
"options": [ ],
"placeholder": "string"
}
],
"id": "string",
"name": "string",
"riskLevel": "string"
}

Sites

Operations related to sites

Get Site By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"clientId": "string",
"createdAt": 0,
"failing": true,
"failureThreshold": 0,
"id": "string",
"legalName": "string",
"name": "string",
"registrationNumber": "string",
"riskLevel": "string",
"siteManagerId": "string",
"updatedAt": 0,
"vatNumber": "string"
}

List Sites

Authorizations:

ApiAuthorizerapi_key

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200
401
422

Content type

application/json

{"data": [{"clientId": "string",
"createdAt": 0,
"failing": true,
"failureThreshold": 0,
"id": "string",
"legalName": "string",
"name": "string",
"registrationNumber": "string",
"riskLevel": "string",
"siteManagerId": "string",
"updatedAt": 0,
"vatNumber": "string"
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Update Site

Authorizations:

ApiAuthorizerapi_key

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Request Body schema: application/json

clientId	string
failureThreshold	integer <int32> >= 1
id required	string
legalName	string
name	string
registrationNumber	string
siteManagerUserId	string
vatNumber	string

Responses

Request samples

Payload

Content type

application/json

{"clientId": "string",
"failureThreshold": 1,
"id": "string",
"legalName": "string",
"name": "string",
"registrationNumber": "string",
"siteManagerUserId": "string",
"vatNumber": "string"
}

Response samples

200

Content type

application/json

{"clientId": "string",
"createdAt": 0,
"failing": true,
"failureThreshold": 0,
"id": "string",
"legalName": "string",
"name": "string",
"registrationNumber": "string",
"riskLevel": "string",
"siteManagerId": "string",
"updatedAt": 0,
"vatNumber": "string"
}

Create Site

Authorizations:

ApiAuthorizerapi_key

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Request Body schema: application/json

required	object
clientId required	string
failureThreshold required	integer <int32> >= 1
legalName	string
name required	string
registrationNumber	string
siteManagerUserId required	string
vatNumber	string

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "string",
"region": "string",
"street": "string",
"timezone": "string"
},
"clientId": "string",
"failureThreshold": 1,
"legalName": "string",
"name": "string",
"registrationNumber": "string",
"siteManagerUserId": "string",
"vatNumber": "string"
}

Response samples

201

Content type

application/json

{"clientId": "string",
"createdAt": 0,
"failing": true,
"failureThreshold": 0,
"id": "string",
"legalName": "string",
"name": "string",
"registrationNumber": "string",
"riskLevel": "string",
"siteManagerId": "string",
"updatedAt": 0,
"vatNumber": "string"
}

Zones

Operations related to zones

Get Zone Type By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"description": "string",
"id": "string",
"riskLevel": "string"
}

List Zone Types

Authorizations:

ApiAuthorizerapi_key

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"riskLevel": "string"
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

List Zones By Site

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"createdAt": 0,
"id": "string",
"name": "string",
"siteId": "string",
"typeId": "string",
"updatedAt": 0,
"userId": "string"
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Create Zone

Authorizations:

ApiAuthorizerapi_key

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Request Body schema: application/json

name required	string
siteId required	string
typeId required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"siteId": "string",
"typeId": "string"
}

Response samples

201

Content type

application/json

{"createdAt": 0,
"id": "string",
"name": "string",
"siteId": "string",
"typeId": "string",
"updatedAt": 0,
"userId": "string"
}

Get Zone By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"createdAt": 0,
"id": "string",
"name": "string",
"siteId": "string",
"typeId": "string",
"updatedAt": 0,
"userId": "string"
}

Clients

Operations related to users

Get Client By Id

Authorizations:

ApiAuthorizerapi_key

path Parameters

id

required

string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"createdAt": 0,
"id": "string",
"legalName": "string",
"registrationNumber": "string",
"tradingName": "string",
"updatedAt": 0,
"userId": "string",
"vatNumber": "string"
}

List Clients

Authorizations:

ApiAuthorizerapi_key

query Parameters

pageSize required	string
pageIndex required	string

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"data": [{"createdAt": 0,
"id": "string",
"legalName": "string",
"registrationNumber": "string",
"tradingName": "string",
"updatedAt": 0,
"userId": "string",
"vatNumber": "string"
}
],
"pageIndex": 0,
"pageSize": 0,
"total": 0
}

Risks

Operations related to users

List Risks

header Parameters

Content-Type required	string
x-api-key required	string
x-api-token required	string

Responses

Response samples

200

Content type

application/json

{"level": "string"
}