Endpoint Schema

Below is a list of all the endpoints within the RailSmart API, within each endpoint drop-down is a list of classes associated with the endpoint, some may not be returned from the endpoint itself and it's used as a reference inside other classes as a reference to themself as they may contain important fields that another dto requires.

How to use

The base URL will change depending on whether you are using the production server, or sandbox server.

Production = https://api.railsmart.io
Sandbox = https://api.uat.railsmart.io

To call the endpoints displayed here prefix the URLs within the code blocks with the BaseURL above e.g.

https://api.railsmart.io/api/v1/Assessment

For calls with parameters included in them, add them where shown in the code block.

Date times, both for parameters are in the ISO-8601 standard (YYYY-MM-DDThh:mm:ss:nnnZ), e.g. To pass a date and time for 2nd June 2024 3:32pm to this endpoint

https://api.railsmart.io/api/v1/Assessment/{modifiedDateTime}

it will be

https://api.railsmart.io/api/v1/Assessment/2024-06-02T15:32:00.000Z

You only have to include parameters that are required, however including non-required parameters will change the data received back.

Assessment

This section shows all of the classes used in the Assessment endpoint.

Get All Assessments Before Date

Description

This request is used to get all assessments (within the given parameters) on or after the given time. The AssessmentDto object is returned from this request

Parameters

modifiedDateTime : REQUIRED

Gets all the assessments created on or after the date and time supplied

archived

Allows the user to get archived assessments

imported

Allows the user to get imported assessments

isDeleted

Allows the user to get deleted assessments

GET {BaseUrl}/api/v1/Assessment/{modifiedDateTime} : AssessmentDto

{
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userAssessingId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessmentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verifiedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verificationStatusId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorVerificationResponseId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "windowStartDate": "2021-03-21T13:24:29.539Z",
  "windowEndDate": "2021-03-21T13:24:29.539Z",
  "isClassroomAssessment": false,
  "notes": "string",
  "assessmentCompetencyId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorFeedback": "string",
  "employeeConfirmedResult": false,
  "recordedStartDate": "2021-03-21T13:24:29.539Z",
  "recordedEndDate": "2021-03-21T13:24:29.539Z",
  "overriddenStartDate": "2021-03-21T13:24:29.539Z",
  "overriddenEndDate": "2021-03-21T13:24:29.539Z",
  "completedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "completedOnPlatformId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verifierFinalFeedback": "string",
  "assessorVerificationResponseNotes": "string",
  "createdByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "archivedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "isArchived": false,
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "isAdHoc": false,
  "isPreview": false,
  "assessorConfirmedResult": false,
  "initialCompetencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "originalAssessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "createdOnPlatformId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorEmployeeReference": "string"
}

Get All Assessments

Description

This request is used to get all assessments (within the given parameters). The AssessmentDto object is returned from this request

Parameters

modifiedDateTime

Gets all the assessments created on or after the date and time supplied

archived

Allows the user to get archived assessments

imported

Allows the user to get imported assessments

isDeleted

Allows the user to get deleted assessments

GET {BaseUrl}/api/v1/Assessment : AssessmentDto

{
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userAssessingId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessmentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verifiedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verificationStatusId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorVerificationResponseId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "windowStartDate": "2021-03-21T13:24:29.539Z",
  "windowEndDate": "2021-03-21T13:24:29.539Z",
  "isClassroomAssessment": false,
  "notes": "string",
  "assessmentCompetencyId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorFeedback": "string",
  "employeeConfirmedResult": false,
  "recordedStartDate": "2021-03-21T13:24:29.539Z",
  "recordedEndDate": "2021-03-21T13:24:29.539Z",
  "overriddenStartDate": "2021-03-21T13:24:29.539Z",
  "overriddenEndDate": "2021-03-21T13:24:29.539Z",
  "completedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "completedOnPlatformId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verifierFinalFeedback": "string",
  "assessorVerificationResponseNotes": "string",
  "createdByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "archivedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "isArchived": false,
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "isAdHoc": false,
  "isPreview": false,
  "assessorConfirmedResult": false,
  "initialCompetencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "originalAssessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "createdOnPlatformId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorEmployeeReference": "string"
}

Add Assessment

Description

This request is used to create a new assessment object, using a AddAssessmentDto object as the body of the request any information supplied inside is used to create a new assessment.

Request Body

addAssessmentDto

This is the object used as the body of the request.

POST {BaseUrl}/api/v1/Assessment : AddAssessmentDto

{
  "userAssessingId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessmentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "windowStartDate": "2021-03-21T13:24:29.539Z",
  "windowEndDate": "2021-03-21T13:24:29.539Z",
  "isClassroomAssessment": false,
  "notes": "string"
}

Get Assessment By Id

Description

This request is used to get an assessment by it's id, this will get assessments that are and are not deleted

Parameters

id : REQUIRED

The id of the assessment you want to get

GET {BaseUrl}/api/v1/Assessment/{id} : AssessmentDto

{
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userAssessingId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessmentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verifiedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verificationStatusId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorVerificationResponseId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "windowStartDate": "2021-03-21T13:24:29.539Z",
  "windowEndDate": "2021-03-21T13:24:29.539Z",
  "isClassroomAssessment": false,
  "notes": "string",
  "assessmentCompetencyId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorFeedback": "string",
  "employeeConfirmedResult": false,
  "recordedStartDate": "2021-03-21T13:24:29.539Z",
  "recordedEndDate": "2021-03-21T13:24:29.539Z",
  "overriddenStartDate": "2021-03-21T13:24:29.539Z",
  "overriddenEndDate": "2021-03-21T13:24:29.539Z",
  "completedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "completedOnPlatformId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "verifierFinalFeedback": "string",
  "assessorVerificationResponseNotes": "string",
  "createdByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "archivedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "isArchived": false,
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "isAdHoc": false,
  "isPreview": false,
  "assessorConfirmedResult": false,
  "initialCompetencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "originalAssessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "createdOnPlatformId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorEmployeeReference": "string"
}

Delete Assessment

Description

This request is used to delete an assessment by it's id.

Parameters

id : REQUIRED

The id of the assessment you want to delete.

DELETE {BaseUrl}/api/v1/Assessment/{id} : None

Get Assessment Notes By Assessment Id

Description

This request is used to get an assessment's list of notes by the id of the assessment.

Parameters

id : REQUIRED

The id of the assessment you want to get the notes from.

GET {BaseUrl}/api/v1/Assessment/{id}/Note : AssessmentNoteDto

{
  "assessmentNoteId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "note": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "modifiedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false
}

AddAssessmentNoteDto

Description

This request is used to add a note to an assessment,an id of the of the assessment needs to be supplied. The body of the request is an AddAssessmentNoteDto object and is used to create the assessment note.

Parameters

id : REQUIRED

This is the id of the assessment you want to add the note too

addAssessmentNoteDto

This is the body of the request

POST {BaseUrl}/api/v1/Assessment/{id}/Note : AddAssessmentNoteDto

{
  "note": "string"
}

Get All Assessment Notes

Description

This request is used to get a list of all the assessment notes from all assessments.

Parameters

isDeleted

Allows the user to get deleted assessments

GET {BaseUrl}/api/v1/Assessment/Note : AssessmentNoteDto

{
  "assessmentNoteId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "note": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "modifiedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false
}

Get Assessment Results

Description

This request is used to get the results of all the assessments on or after the given time.

Parameters

modifiedDateTime

Used to get results from the date specified to any date on or after it.

imported

Allows the user to get imported assessments

isArchived

Allows the user to get archived assessments

assessorConfirmedResult

Allows the user to filter the results if the result is confirmed by an assessor

isDeleted

Allows the user to get deleted assessments

isForceUpdated

Allows the user to filter the results if the result was force updated

GET {BaseUrl}/api/v1/Assessment/Result : AssessmentResultDto

{
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userAssessingId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "recordedEndDate": "2021-03-21T13:24:29.539Z",
  "overriddenEndDate": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "assessorEmployeeReference": "string",
  "assessmentCompetency": "AssessmentCompetencyDto",
  "assessmentType": "AssessmentTypeDto",
  "criteriaMet": [],
  "competencyCycle": "CompetencyCycleDto"
}

Complete Assessment

Description

This request is used to complete an assessment, the assessment is found by passing it's id as a parameter. The body of this request is a CompleteAssessmentDto object.

Parameters

id : REQUIRED

The id of the assessment you want to find.

completeAssessmentDto

This object is the body of this request.

PUT {BaseUrl}/api/v1/Assessment/{id}/Complete : CompleteAssessmentDto

{
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "recordedStartDate": "2021-03-21T13:24:29.539Z",
  "recordedEndDate": "2021-03-21T13:24:29.539Z",
  "assessmentCompetencyId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorFeedback": "string"
}

Delete Assessment Note

Description

This request is used to delete an assessment note.

Parameters

id : REQUIRED

The id of the note you want to delete.

DELETE {BaseUrl}/api/v1/Assessment/Note/{id} : None

Company Role

This section shows all of the classes used in the Company Role endpoint.

Get All Company Roles

Description

This request is used to get all of the company roles.

Parameters

isDeleted

Allows the user to filter the results by deleted roles.

GET {BaseUrl}/api/v1/CompanyRole : CompanyRoleDto

{
  "companyRoleId": "string",
  "name": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false
}

Add Company Role

Description

This request is used to create a new company role, an AddCompanyRoleDto object is used as the body of the request. The data inside the body of the request is used to create the new company role.

Request Body

addCompanyRoleDto

The body of the request, the data inside this object is used to create the new company role

POST {BaseUrl}/api/v1/CompanyRole : AddCompanyRoleDto

{
  "name": "string"
}

Edit Company Role

Description

This request is used to edit a company role, an EditCompanyRoleDto object is used as the body of the request and the data used inside the body of the request is used to edit the existing company role.

Request Body

editCompanyRoleDto

The information inside the editCompanyRoleDto object is used to update the existing company role

PUT {BaseUrl}/api/v1/CompanyRole : EditCompanyRoleDto

{
  "companyRoleId": "string",
  "companyRoleName": "string"
}

Delete Company Role

Description

This request is used to delete an existing company role by using it's id.

Parameters

id

The id of the company role you want to delete

DELETE {BaseUrl}/api/v1/CompanyRole : None

Get Company Role By Id

Description

This request is used to get a company role by an id.

Parameters

id : REQUIRED

The id of the company role you want to get.

GET {BaseUrl}/api/v1/CompanyRole/{id} : CompanyRoleDto

{
  "companyRoleId": "string",
  "name": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false
}

Competency Cycle

This section shows all of the classes used in the Competency Cycle endpoint.

Get All Competency Cycles

Description

This request is used to get all of the competency cycles

Parameters

isDeleted

Allows the user to filter the results to show deleted competency cycles

isArchived

Allows the user to filter the results to show archived competency cycles

GET {BaseUrl}/api/v1/CompetencyCycle : CompetencyCycleDto

{
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "numberOfMonths": 8,
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "baseCompetencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "competencyCycleCriteria": []
}

Get Competency Cycle By Id

Description

This request is used to get a competency cycle by it's id, which is supplied as a parameter to the request.

Parameters

id : REQUIRED

The id of the competency cycle you want to get.

GET {BaseUrl}/api/v1/CompetencyCycle/{id} : CompetencyCycleDto

{
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "numberOfMonths": 8,
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "baseCompetencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "competencyCycleCriteria": []
}

Get Competency Cycle Criteria

Description

This request is used to get all of the criteria from a competency cycle.

Parameters

id : REQUIRED

The id of the competency cycle you want to get the criteria for.

GET {BaseUrl}/api/v1/CompetencyCycle/{id}/Criteria : CompetencyCycleDto

{
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "numberOfMonths": 8,
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "baseCompetencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "competencyCycleCriteria": []
}

Competency Element

This section shows all of the classes used in the Competency Element endpoint.

Get All Competency Elements

Description

This is the CompetencyElementDto, it is not returned from an endpoint or used as a request body, it is instead used inside the CompetencyCriteriaDto as the competency element.

Parameters

isDeleted

Allows the user to filter the results of the request to include deleted competency elements

GET {BaseUrl}/api/v1/CompetencyElement : CompetencyElementDto

{
  "competencyElementId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "orderIndex": 3,
  "referenceId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyUnit": "CompetencyUnitDto"
}

Get Competency Element By Id

Description

This request is used to get a competency element by id.

Parameters

id : REQUIRED

The id of the competency element you want to get.

GET {BaseUrl}/api/v1/CompetencyElement/{id} : CompetencyElementDto

{
  "competencyElementId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "orderIndex": 3,
  "referenceId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyUnit": "CompetencyUnitDto"
}

Get Competency Element Criteria By Id

Description

This request is used to get a competency element's criteria by the competency element's id.

Parameters

id : REQUIRED

The id of the competency element criteria you want to get

GET {BaseUrl}/api/v1/CompetencyElement/{id}/Criteria : CompetencyCriteriaDto

{
  "competencyCriteriaId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "orderIndex": 6,
  "referenceId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyElement": "CompetencyElementDto"
}

Add Competency Element Criteria

Description

This request is used to add a new competency criteria object to the database. This request has a AddCompetencyObject as the body of the request.

Parameters

id : REQUIRED

The id of the competency element you would like to add the criteria too.

competencyElementCriteriaToAdd

This is is a AddCompetencyCriteriaDto object and it is used as the body of the request.

POST {BaseUrl}/api/v1/CompetencyElement/{id}/Criteria : AddCompetencyCriteriaDto

{
  "title": "string",
  "orderIndex": 7,
  "competencyCriteriaRiskLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Competency Unit

This section shows all of the classes used in the Competency Unit endpoint.

Get All Competency Units

Description

This is the CompetencyUnitDto, it is not returned from an endpoint or used as a request body, it is instead used inside the CompetencyElementDto.

Parameters

isDeleted

Allows the user to filter results to show deleted competency unit.

isArchived

Allows the user to filter results to show archived competency units.

GET {BaseUrl}/api/v1/CompetencyUnit : CompetencyUnitDto

{
  "competencyUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "timeframeMonths": 7,
  "orderIndex": 6,
  "referenceId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Add Competency Unit

Description

This request is used to add a competency unit by entering data into the request body.

Request Body

competencyUnitToAdd

This is a AddCompetencyUnitDto object and is used in the body of the request to create a new competency unit.

POST {BaseUrl}/api/v1/CompetencyUnit : AddCompetencyUnitDto

{
  "name": "string",
  "timeframeMonths": 0
}

Get A Competency Unit By Id

Description

This request is used to get a competency unit by the id supplied inside the parameters.

Parameters

id : REQUIRED

The id of the Competency Unit to get.

GET {BaseUrl}/api/v1/CompetencyUnit/{id} : CompetencyUnitDto

{
  "competencyUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "timeframeMonths": 7,
  "orderIndex": 6,
  "referenceId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Get Competency Unit Elements By Id

Description

This is the CompetencyElementDto, it is not returned from an endpoint or used as a request body, it is instead used inside the CompetencyCriteriaDto as the competency element.

Parameters

id : REQUIRED

The id of the competency unit that you want to get the elements from.

GET {BaseUrl}/api/v1/CompetencyUnit/{id}/Elements : CompetencyElementDto

{
  "competencyElementId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "orderIndex": 0,
  "referenceId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyUnit": "CompetencyUnitDto"
}

Add Competency Unit Elements

Description

This request is used to add element to a competency unit.

Parameters

id : REQUIRED

The id of the competency unit you want to add the elements too.

competencyUnitElementsToAdd

This is a AddCompetencyElementDto object and is used within the body of the request.

POST {BaseUrl}/api/v1/CompetencyUnit/{id}/Elements : AddCompetencyElementDto

{
  "name": "string",
  "orderIndex": 6
}

Department

This section shows all of the classes used in the Department endpoint.

Get Departments

Description

This request is used to get all of the departments.

Parameters

isDeleted

Allows the user to filter the results to show deleted departments

GET {BaseUrl}/api/v1/Department : DepartmentDto

{
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentName": "string",
  "isDeleted": false,
  "locationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentCode": "string"
}

Add Department

Description

This request is used to add a new department.

Request Body

newDepartmentDto

This is an AddDepartmentDto object and is used in the body of the request.

POST {BaseUrl}/api/v1/Department : AddDepartmentDto

{
  "departmentName": "string",
  "locationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentCode": "string"
}

Update department

Description

This request is used to update an existing department. This request takes an updateDepartmentDto object as the body

Request Body

updateDepartmentDto

This is an UpdateDepartmentDto object and is used as the request body.

PUT {BaseUrl}/api/v1/Department : UpdateDepartmentDto

{
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentName": "string",
  "locationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentCode": "string"
}

Get Department By Code

Description

This request is used to get a department by it's code.

Parameters

departmentCode : REQUIRED

The code of the department you want to get.

GET {BaseUrl}/api/v1/Department/code/{departmentCode} : DepartmentDto

{
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentName": "string",
  "isDeleted": false,
  "locationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentCode": "string"
}

Get Department By Id

Description

This request is used to get a department by it's id.

Parameters

id : REQUIRED

The id of the department you want to get.

GET {BaseUrl}/api/v1/Department/{id} : DepartmentDto

{
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentName": "string",
  "isDeleted": false,
  "locationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentCode": "string"
}

Delete Department

Description

This request is used to delete an existing department

Parameters

id : REQUIRED

The id used to get the department

DELETE {BaseUrl}/api/v1/Department/{id} : None

Incident

This section shows all of the classes used in the Incident endpoint.

Get Incidents

Description

This request is used to get all the Incidents.

Parameters

modifiedDateTime

Allows the user to filter the results to on or after a certain date and time.

isDeleted

Allows the user to filter the results to included deleted incidents.

GET {BaseUrl}/api/v1/Incident : IncidentDto

{
  "incidentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateOfIncident": "2021-03-21T13:24:29.539Z",
  "incidentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "description": "string",
  "incidentResponsibilityLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reportCompletedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "createdByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "archivedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isArchived": false,
  "isDeleted": false,
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Add Incident

Description

This request is used to add a new incident.

Request Body

addIncidentDto

Used in the body of the request to create an incident.

POST {BaseUrl}/api/v1/Incident : AddIncidentDto

{
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateOfIncident": "2021-03-21T13:24:29.539Z",
  "incidentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "description": "string",
  "incidentResponsibilityLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reportCompletedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Update Incident

Description

This request is used to updated an existing incident.

Request Body

updateIncidentDto

This object is used to update an existing incident.

PUT {BaseUrl}/api/v1/Incident : UpdateIncidentDto

{
  "incidentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateOfIncident": "2021-03-21T13:24:29.539Z",
  "incidentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "description": "string",
  "incidentResponsibilityLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reportCompletedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Get Incident By Id

Description

This request is used to get an Incident by id

Parameters

id : REQUIRED

The id of the Incident to get

GET {BaseUrl}/api/v1/Incident/{id} : IncidentDto

{
  "incidentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateOfIncident": "2021-03-21T13:24:29.539Z",
  "incidentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "description": "string",
  "incidentResponsibilityLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reportCompletedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "createdByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "archivedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isArchived": false,
  "isDeleted": false,
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Delete Incident

Description

This request is used to delete an incident.

Parameters

id : REQUIRED

The id of the incident you want to delete.

DELETE {BaseUrl}/api/v1/Incident/{id} : None

Archive Incident

Description

This request is used to archive an incident.

Parameters

id : REQUIRED

The id of the incident you want to archive.

PUT {BaseUrl}/api/v1/Incident/Archive/{id} : None

Infrastructure Authorized To Operate

This section shows all of the classes used in the Infrastructure Authorized To Operate endpoint.

Get Infrastructure Authorised To Operate

Description

This request is used to get all of the Infrastructure Authorised To Operate.

Parameters

modifiedDateTime

Gets all the assessments created on or after the date and time supplied

isImported

Allows the user to get imported assessments

isArchived

Allows the user to get archived assessments

isDeleted

Allows the user to get deleted assessments

GET {BaseUrl}/api/v1/InfrastructureAuthorisedToOperate : InfrastructureAuthorisedToOperateDto

{
  "infrastructureAuthorisedToOperateId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "routeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "date": "2021-03-21T13:24:29.539Z",
  "expiryDateTime": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isArchived": false,
  "isDeleted": false,
  "userCompanyRole": "ChildUserCompanyRoleDto"
}

Get Infrastructure Authorised To Operate By Id

Description

This request will get an Infrastructure Authorised To Operate by id.

Parameters

id : REQUIRED

The id of the infrastructure authorised to operate.

GET {BaseUrl}/api/v1/InfrastructureAuthorisedToOperate/{id} : InfrastructureAuthorisedToOperateDto

{
  "infrastructureAuthorisedToOperateId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "routeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "date": "2021-03-21T13:24:29.539Z",
  "expiryDateTime": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isArchived": false,
  "isDeleted": false,
  "userCompanyRole": "ChildUserCompanyRoleDto"
}

Location

This section shows all of the classes used in the Location endpoint.

Get Locations

Description

This request will get all of the locations, you can get deleted location back in the response by changing the parameter.

Parameters

name

Name of the location.

isDeleted

Allows the user to filter the response to show deleted locations.

GET {BaseUrl}/api/v1/Location : LocationDto

{
  "locationId": "string",
  "name": "string",
  "isDeleted": false
}

Add Location

Description

This request is used to add a new Location.

Request Body

newLocation

The newLocationDto information is used to create a new location

POST {BaseUrl}/api/v1/Location : AddLocationDto

{
  "name": "string",
  "userAssignable": false
}

Edit Location

Description

This request will edit an existing Location.This request uses an UpdateLocationDto as the request body

Request Body

updatedLocationDto

The updatedLocationDto information is used to update the existing location

PUT {BaseUrl}/api/v1/Location : UpdateLocationDto

{
  "locationId": "string",
  "name": "string",
  "userAssignable": false
}

Delete Location

Description

This request is used to delete an existing location

Parameters

id

The id is used to find the location to delete

DELETE {BaseUrl}/api/v1/Location : None

Get Location By Id

Description

This request will get a Location by id

Parameters

id : REQUIRED

The id is used to find the specific location

GET {BaseUrl}/api/v1/Location/{id} : LocationDto

{
  "locationId": "string",
  "name": "string",
  "isDeleted": false
}

Medical Assessment Result

This section shows all of the classes used in the Medical Assessment Result endpoint.

Get Hearing Results

Description

This request is used to get all of the hearing results.

This request has no body or parameters

GET {BaseUrl}/api/v1/MedicalAssessmentResult/HearingResults : MedicalAssessmentResultDto

{
  "medicalAssessmentResultId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string"
}

Get Vision Results

Description

This request will get all of the vision results.

This request has no body or parameters

GET {BaseUrl}/api/v1/MedicalAssessmentResult/VisionResults : MedicalAssessmentResultDto

{
  "medicalAssessmentResultId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string"
}

Get Drug,Alcohol and Diabetes

Description

This request will get all of the drug,alcohol and diabetes results.

This request has no body or parameters

GET {BaseUrl}/api/v1/MedicalAssessmentResult/DrugsAlcoholAndDiabetes : MedicalAssessmentResultDto

{
  "medicalAssessmentResultId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string"
}

Medical Assessment Type

This section shows all of the classes used in the Medical Assessment Type endpoint.

Get Medical Assessment Types

Description

This request will get all of the Medical Assessment Types.

This request has no body or parameters

GET {BaseUrl}/api/v1/MedicalAssessmentType : MedicalAssessmentTypeDto

{
  "medicalAssessmentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string"
}

Medical Indicator

This section shows all of the classes used in the Medical Indicator endpoint.

Get Medical Indicator

Description

This request will get all of the Medical Indicators.

This request has no body or parameters

GET {BaseUrl}/api/v1/MedicalIndicator : MedicalIndicatorDto

{
  "medicalIndicatorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string"
}

OrrDoctorInformation

This section shows all of the classes used in the Orr Doctor Information endpoint.

Get Orr Doctor Information

Description

This request will get all of the Orr Doctor's Information.

Parameters

isDeleted

Allows the user to filter the results to show deleted orr doctor info.

GET {BaseUrl}/api/v1/OrrDoctorInformation : OrrDoctorInformationDto

{
  "orrDoctorInformationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "registerNumber": "string",
  "name": "string",
  "nameOfPractice": "string",
  "building": "string",
  "numberAndStreet": "string",
  "town": "string",
  "county": "string",
  "postCode": "string",
  "isDeleted": false
}

Get Orr Doctor Information By Id

Description

This will get a doctor's information by id.

Parameters

id : REQUIRED

The id is used to find the Orr Doctor's Information.

GET {BaseUrl}/api/v1/OrrDoctorInformation/{id} : OrrDoctorInformationDto

{
  "orrDoctorInformationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "registerNumber": "string",
  "name": "string",
  "nameOfPractice": "string",
  "building": "string",
  "numberAndStreet": "string",
  "town": "string",
  "county": "string",
  "postCode": "string",
  "isDeleted": false
}

Reference

This section shows all of the classes used in the Reference endpoint.

Get System Roles

Description

This will get all of the system roles.

Parameters

isDeleted

Allows the user to filter the delete System Roles

GET {BaseUrl}/api/v1/Reference/SystemRole : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get System Role By Id

Description

This request will get a System Role By Id.

Parameters

id : REQUIRED

The id of the System role to get.

GET {BaseUrl}/api/v1/Reference/SystemRole/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Support Levels

Description

This request will get all of the support levels.

Parameters

isDeleted

Allows the user to filter deleted references.

GET {BaseUrl}/api/v1/Reference/SupportLevel : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Support Levels

Description

This request will get a Support Level by id.

Parameters

id : REQUIRED

The id used to get the Support Level.

GET {BaseUrl}/api/v1/Reference/SupportLevel/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get All Duration Unit

Description

This request will get all Duration Unit's.

Parameters

isDeleted

Allows the user to filter deleted Duration Unit's

GET {BaseUrl}/api/v1/Reference/DurationUnit : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Duration By Id

Description

This will get a Duration Unit by id.

Parameters

id : REQUIRED

The id of the duration unit to get.

GET {BaseUrl}/api/v1/Reference/DurationUnit/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Employee Authority To Work Statuses

Description

This request is used to get all Employees Authority To Work Statuses

Parameters

isDeleted

Allows the user to filter deleted Employees Authority To Work Statuses.

GET {BaseUrl}/api/v1/Reference/EmployeeAuthorityToWorkStatus : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Employee Authority To Work Statuses By Id

Description

This request to the id

Parameters

id : REQUIRED

The id of the employee authority to work status.

GET {BaseUrl}/api/v1/Reference/EmployeeAuthorityToWorkStatus/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Employee Safety Critical Statuses

Description

This request is used to get employer safety critical status.

Parameters

isDeleted

Allows the user to filter results if they are deleted.

GET {BaseUrl}/api/v1/Reference/EmployeeSafetyCriticalStatus : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Employee Safety Critical Statuses By Id

Description

This request is used to get employee safety critical statuses.

Parameters

id : REQUIRED

The id of the employee safety critical statuses.

GET {BaseUrl}/api/v1/Reference/EmployeeSafetyCriticalStatus/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Competency Criteria Risk Levels

Description

This request is used to get all competency criteria risk levels.

Parameters

isDeleted

Allows the user to filter results if there deleted.

GET {BaseUrl}/api/v1/Reference/CompetencyCriteriaRiskLevel : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Competency Criteria Risk Level By Id

Description

This request is used to get a competency criteria risk level by the id provided in the parameters.

Parameters

id : REQUIRED

The id of the competency criteria risk level.

GET {BaseUrl}/api/v1/Reference/{id}/CompetencyCriteriaRiskLevel : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Support Plan Types

Description

This request is used to get all support plan types.

Parameters

isDeleted

Allows the user to filter by deleted.

GET {BaseUrl}/api/v1/Reference/SupportPlanType : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Support Plan By Id

Description

This request is used to get a support plan by id.

Parameters

id : REQUIRED

The id of the support plan type.

GET {BaseUrl}/api/v1/Reference/SupportPlanType/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Support Plan Approval Types

Description

This request is used to get all support plan approval types.

Parameters

isDeleted

Allows the user to filter the results if deleted.

GET {BaseUrl}/api/v1/Reference/SupportPlanApprovalType : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Support Plan Approval Type By Id

Description

This request is used to get a support plan approval type by the id in the parameters.

Parameters

id : REQUIRED

The id of the support plan type.

GET {BaseUrl}/api/v1/Reference/SupportPlanApprovalType/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Safety Brief Type

Description

This request is used to get all safety brief types.

Parameters

isDeleted

Allows the user to filter by deleted result.

GET {BaseUrl}/api/v1/Reference/SafetyBriefType : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Safety Brief Type By Id

Description

This request is used to get a safety brief type with.

Parameters

id : REQUIRED

This is the id of the safety brief type.

GET {BaseUrl}/api/v1/Reference/SafetyBriefType/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Assessment Competency

Description

This request is used to get all assessment competencies

Parameters

isDeleted

Allows the user to filter results by deleted.

GET {BaseUrl}/api/v1/Reference/AssessmentCompetency : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Assessment Competency By Id

Description

This request is used to get an assessment competency by the id supplied in the parameters

Parameters

id : REQUIRED

The id of the assessment competency by id.

GET {BaseUrl}/api/v1/Reference/AssessmentCompetency/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Assessment Type

Description

This request is used to get all of the assessment types.

Parameters

isDeleted

Allows the user to filter the results by deleted results.

GET {BaseUrl}/api/v1/Reference/AssessmentType : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Assessment Type By Id

Description

This request is used to get an assessment by the id given in the parameters.

Parameters

id : REQUIRED

The id of the assessment type.

GET {BaseUrl}/api/v1/Reference/AssessmentType/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Assessment Type Category

Description

This request is used to get all assessment type categories.

Parameters

isDeleted

Allows the user to filter the results by deleted results

GET {BaseUrl}/api/v1/Reference/AssessmentTypeCategory : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Assessment Type Category By Id

Description

This request is used to get an assessment type category by id.

Parameters

id : REQUIRED

The id of the assessment type category

GET {BaseUrl}/api/v1/Reference/AssessmentTypeCategory/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Platform

Description

This request is used to get all platforms.

Parameters

isDeleted

Allows the user to filter results by deleted results.

GET {BaseUrl}/api/v1/Reference/Platform : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Platform By Id

Description

This request is used to get platform by the id supplied in the parameters.

Parameters

id : REQUIRED

The id of the platform you want to get.

GET {BaseUrl}/api/v1/Reference/Platform/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Incident Type

Description

This request is used to get all incident types

Parameters

isDeleted

Allows the user to filter the response to show deleted incident types.

GET {BaseUrl}/api/v1/Reference/IncidentType : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Incident Type By Id

Description

This request is used to get an incident type by the id supplied in the parameters.

Parameters

id : REQUIRED

The id of the incident type you want to get.

GET {BaseUrl}/api/v1/Reference/IncidentType/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Incident Responsibility Level

Description

This request is used to get all of the incident responsibility levels.

Parameters

isDeleted

Allows the user to filter the response to show deleted incident responsibility levels.

GET {BaseUrl}/api/v1/Reference/IncidentResponsibilityLevel : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Incident Responsibility Level By Id

Description

This request is used to get an incident responsibility level by the id supplied in the parameters.

Parameters

id : REQUIRED

The id of the incident responsibility level you want to get.

GET {BaseUrl}/api/v1/Reference/IncidentResponsibilityLevel/{id} : ReferenceDto

{
  "id": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Route

This section shows all of the classes used in the Route endpoint.

Get Routes

Description

This request is used to get all Routes.

Parameters

isDeleted

Allows the user to filter deleted Routes.

isArchived

Allows the user to filter archived Routes.

search

GET {BaseUrl}/api/v1/Route : RouteDto

{
  "routeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "code": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "expires": false,
  "duration": 8,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Add Route

Description

This request is used to add a new Route.

Request Body

newRouteDto

The newRouteDto is used to create a new Route.

POST {BaseUrl}/api/v1/Route : AddRouteDto

{
  "title": "string",
  "code": "string",
  "autoRenew": false,
  "expires": false,
  "duration": 1,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Update Route

Description

This request is used to update an existing Route.

Request Body

updateRouteDto

The UpdateRouteDto is used to update a Route.

PUT {BaseUrl}/api/v1/Route : UpdateRouteDto

{
  "routeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "code": "string",
  "autoRenew": false,
  "expires": false,
  "duration": 4,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Delete Route

Description

This request is used to delete an existing Route.

Parameters

routeId

The id of the Route to delete.

DELETE {BaseUrl}/api/v1/Route : None

Get Route By id

Description

This request is used to get a Route by id

Parameters

id : REQUIRED

The of the Route to get.

GET {BaseUrl}/api/v1/Route/{id} : RouteDto

{
  "routeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "code": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "expires": false,
  "duration": 8,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Get Route By Code

Description

This request is used to get a Route by code.

Parameters

code : REQUIRED

The code of the Route to get.

GET {BaseUrl}/api/v1/Route/reference/{code} : RouteDto

{
  "routeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "code": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "expires": false,
  "duration": 8,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Safety Brief

This section shows all of the classes used in the Safety Brief endpoint.

Get Safety Briefs

Description

This request will get all Safety Briefs.

Parameters

modifiedDateTime

Gets all the assessments created on or after the date and time supplied

archived

Allows the user to get archived assessments

imported

Allows the user to get imported assessments

isDeleted

Allows the user to get deleted assessments

GET {BaseUrl}/api/v1/SafetyBrief : SafetyBriefDto

{
  "safetyBriefId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "isArchived": false,
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Add Safety Brief

Description

This request is used to add a new Safety Brief. A NewSafetyBriefDto object is used in the body of the request.

Request Body

newSafetyBriefDto

The NewSafetyBriefDto object is used to create a bew Safety Brief.

POST {BaseUrl}/api/v1/SafetyBrief : AddSafetyBriefDto

{
  "title": "string"
}

Update SafetyBrief

Description

This request is used to update an existing safety brief.

Request Body

updateSafetyBriefDto

The UpdateSafetyBriefDto is used to update the existing safety brief.

PUT {BaseUrl}/api/v1/SafetyBrief : UpdateSafetyBriefDto

{
  "safetyBriefId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string"
}

Get Safety Brief By Id

Description

This request is used to get a Safety Brief by id.

Parameters

id : REQUIRED

The id of the Safety Brief to get.

GET {BaseUrl}/api/v1/SafetyBrief/{id} : SafetyBriefDto

{
  "safetyBriefId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "isArchived": false,
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Delete Safety Brief

Description

This request is used to delete an existing Safety Brief.

Parameters

id : REQUIRED

The id of the Safety Brief to delete.

DELETE {BaseUrl}/api/v1/SafetyBrief/{id} : None

Skill

This section shows all of the classes used in the Skill endpoint.

Get Skills

Description

This request is used to get all of the Skills.

Parameters

isDeleted

Allows the user to filter delete Skills.

GET {BaseUrl}/api/v1/Skill : SkillDto

{
  "skillId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "code": "string",
  "name": "string",
  "expires": false,
  "description": "string",
  "duration": 2,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false
}

Add Skill

Description

This request will create a new Skill with data supplied in the request body. The request body is a NewSKillDto object.

Request Body

newSkillDto

The NewSKillDto is used as the body of the request.

POST {BaseUrl}/api/v1/Skill : AddSkillDto

{
  "code": "string",
  "name": "string",
  "description": "string",
  "expires": false,
  "duration": 2,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Update Skill

Description

This request is used to update an existing Skill with the data supplied to the request body. The request body is an UpdateSkillDto object.

Request Body

updateSkillDto

The UpdateSkillDto is used as the body of the request.

PUT {BaseUrl}/api/v1/Skill : UpdateSkillDto

{
  "skillId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "code": "string",
  "name": "string",
  "description": "string",
  "expires": false,
  "duration": 7,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Delete Skill

Description

This request is used to delete an existing Skill.

Parameters

skillId

The id of the Skill to delete.

DELETE {BaseUrl}/api/v1/Skill : None

Get Skill By id

Description

This request is used to get a Skill by id.

Parameters

id : REQUIRED

The id of the Skill to delete.

GET {BaseUrl}/api/v1/Skill/{id} : SkillDto

{
  "skillId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "code": "string",
  "name": "string",
  "expires": false,
  "description": "string",
  "duration": 2,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false
}

Support Plan

This section shows all of the classes used in the Support Plan endpoint.

Get Support Plan

Description

This request is used to get the support plans.

Parameters

modifiedDate

Gets all the assessments created on or after the date and time supplied

creationApproved

Allows the user to filter the results by the creation of the Support Plan being approved.

completionApproved

Allows the user to filter results by the completion of the Support Plan being approved.

active

Allows the user to filter results by the active status of the Support Plan.

isDeleted

Allows the user filter results to include deleted assessments

awaitingCreationApproval

Allows the user to filter results by the approval status of the creation of the Support Plan.

awaitingCompletionApproval

Allows the user to filter results by the approval status of the creation of the Support Plan.

GET {BaseUrl}/api/v1/SupportPlan : SupportPlanDto

{
  "supportPlanId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "supportPlanTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "supportLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "incidentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "periodStartDate": "2021-03-21T13:24:29.539Z",
  "periodActualCompletionDate": "2021-03-21T13:24:29.539Z",
  "periodExpectedCompletionDate": "2021-03-21T13:24:29.539Z",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "createdByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userCompanyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isActive": false,
  "supportPlanApproval": "SupportPlanApprovalDto"
}

Get Support Plan For User

Description

This request is used to get a support plan for a certain user.

Parameters

modifiedDateTime

Gets all the assessments created on or after the date and time supplied

userId : REQUIRED

The id of the user you want to get the support plans for.

creationApproved

Allows the user to filter the results by the creation of the Support Plan being approved.

completionApproved

Allows the user to filter results by the completion of the Support Plan being approved.

active

Allows the user to filter results by the active status of the Support Plan.

isDeleted

Allows the user filter results to include deleted assessments

GET {BaseUrl}/api/v1/SupportPlan/{userId} : SupportPlanDto

{
  "supportPlanId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "supportPlanTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "supportLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "incidentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "periodStartDate": "2021-03-21T13:24:29.539Z",
  "periodActualCompletionDate": "2021-03-21T13:24:29.539Z",
  "periodExpectedCompletionDate": "2021-03-21T13:24:29.539Z",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "createdByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userCompanyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isActive": false,
  "supportPlanApproval": "SupportPlanApprovalDto"
}

Get Support Plan interactions

Description

This request is used to get all support plan interactions.

Parameters

modifiedDateTime

Gets all the support plan interaction that got created/updated since that date and time

archived

Whether or not to include archived interactions

isDeleted

Whether or not to include deleted interactions

GET {BaseUrl}/api/v1/SupportPlan/interactions : SupportPlanInteractionDto

{
  "supportPlanInteractionId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "supportPlanId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "plannedInteractionTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "otherPlannedInteractionType": "string",
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "description": "string",
  "expectedCompletionDate": "2021-03-21T13:24:29.539Z",
  "actualCompletionDate": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "archivedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "isArchived": false
}

Get Support Plan interactions

Description

This request is used to get all support plan interactions.

Parameters

supportPlanId : REQUIRED

The ID of the support plan to get interactions for

modifiedDateTime

Gets all the support plan interaction that got created/updated since that date and time

archived

Whether or not to include archived interactions

isDeleted

Whether or not to include deleted interactions

GET {BaseUrl}/api/v1/SupportPlan/{supportPlanId}/interactions : SupportPlanInteractionDto

{
  "supportPlanInteractionId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "supportPlanId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "plannedInteractionTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "otherPlannedInteractionType": "string",
  "assessmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "description": "string",
  "expectedCompletionDate": "2021-03-21T13:24:29.539Z",
  "actualCompletionDate": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "archivedByUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "dateArchived": "2021-03-21T13:24:29.539Z",
  "isArchived": false
}

Team

This section shows all of the classes used in the Team endpoint.

Get Teams

Description

This request is used to get all Teams.

Parameters

isDeleted

Allows the user to filter the results by deleted Teams.

GET {BaseUrl}/api/v1/Team : TeamDto

{
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Add team

Description

This request is used to add new Team from the data supplied in the request body. An AddTeamDto object is used as the request body.

Request Body

newTeamDto

The information in the newTeam object is used as the request body to create a new object.

POST {BaseUrl}/api/v1/Team : AddTeamDto

{
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string"
}

Update Team

Description

This request is used to update an existing TeamDto.

Request Body

updatedTeamDto

The UpdateTeamDto is used as the request body to create a new object.

PUT {BaseUrl}/api/v1/Team : UpdateTeamDto

{
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string"
}

Delete Team

Description

This request is used to delete an existing Team.

Parameters

id

The id of the Team to delete.

DELETE {BaseUrl}/api/v1/Team : None

Get Team By Id

Description

This request is used to get a Team by id.

Parameters

id : REQUIRED

The id of the Team to get.

GET {BaseUrl}/api/v1/Team/{id} : TeamDto

{
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "reference": "string",
  "isDeleted": false
}

Get Team Users By Id

Description

This request is used to get all the users within a team.

Parameters

id : REQUIRED

The id of the user where the team is present.

isDeleted

Allows the user to filter the results by deleted Teams.

GET {BaseUrl}/api/v1/Team/{id}/users : TeamUsersDto

{
  "userTeamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false
}

Get All Team Users

Description

This request is used to get all of the user in a Team.

Parameters

isDeleted

Allows the user to filter the results by deleted Teams.

GET {BaseUrl}/api/v1/Team/users : TeamUsersDto

{
  "userTeamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false
}

Get Team By Owner's Id

Description

This request is used to get a Team by the owner's id.

Parameters

id : REQUIRED

The id of Team's owner.

isDeleted

Allows the user to filter the results by deleted Teams.

GET {BaseUrl}/api/v1/Team/{id}/owners : TeamUsersDto

{
  "userTeamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false
}

Get Team Owners

Description

This request is used to get the owners of a Team.

Parameters

isDeleted

Allows the user to filter the results by deleted Teams.

GET {BaseUrl}/api/v1/Team/owners : TeamOwnerDto

{
  "teamOwnerId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "ownerUserId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "notificationsEnabled": false
}

Traction

This section shows all of the classes used in the Traction endpoint.

Get Traction

Description

This request is used to Get all Traction.

Parameters

isDeleted

Allows the user to filter the results by deleted Teams.

GET {BaseUrl}/api/v1/Traction : TractionDto

{
  "tractionId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "expires": false,
  "duration": 7,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "code": "string",
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Add Traction

Description

This request is used to create a new Traction with the data supplied in the request body. The AddTractionDto object is used as the request body.

Request Body

newTractionDto

The AddTractionDto object is used as the request body to create a new object

POST {BaseUrl}/api/v1/Traction : AddTractionDto

{
  "name": "string",
  "code": "string",
  "expires": false,
  "duration": 8,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false
}

Update Traction

Description

This request is used to update an existing Traction with the data supplied to the request body.

Request Body

updateTractionDto

The updateTractionDto object is used as the request body to update an existing Tracton.

PUT {BaseUrl}/api/v1/Traction : UpdateTractionDto

{
  "tractionId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "expires": false,
  "duration": 4,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "code": "string"
}

Delete Traction

Description

This request is used to delete an existing Traction.

Parameters

tractionId

The id of the Traction object to delete.

DELETE {BaseUrl}/api/v1/Traction : None

Get Traction By id

Description

This request is used to get a Traction by id.

Parameters

id : REQUIRED

The id of the Traction object to get.

GET {BaseUrl}/api/v1/Traction/{id} : TractionDto

{
  "tractionId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "expires": false,
  "duration": 7,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "code": "string",
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Get Traction By Reference

Description

This request is used to get a Traction by reference.

Parameters

code : REQUIRED

The code of the Traction object to get.

GET {BaseUrl}/api/v1/Traction/reference/{code} : TractionDto

{
  "tractionId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "name": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "expires": false,
  "duration": 7,
  "durationUnitId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "autoRenew": false,
  "code": "string",
  "dateImported": "2021-03-21T13:24:29.539Z"
}

User Company Role

This section shows all of the classes used in the User Company Role endpoint.

Get User Company Role

Description

This request is used to get all User Company Role.

Parameters

competencyCycleStartDate

Gets all the assessments created up to the time supplied

modifiedDateTime

Gets all the assessments created on or after the date and time supplied

isDeleted

Allows the user to filter the results by deleted User Company Role.

isImported

Allows the user to filter the results by imported User Company Role.

isStarted

Allows the user to filter the results by started User Company Role.

GET {BaseUrl}/api/v1/UserCompanyRole : UserCompanyRoleDto

{
  "userCompanyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleStartDate": "2021-03-21T13:24:29.539Z",
  "competencyCycleEndDate": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "competencyCycle": "CompetencyCycleDto"
}

Gets User Company Role By Id

Description

This request is used to get a User Company Role by id.

Parameters

id : REQUIRED

The id of the User Company Role.

GET {BaseUrl}/api/v1/UserCompanyRole/{id} : UserCompanyRoleDto

{
  "userCompanyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleStartDate": "2021-03-21T13:24:29.539Z",
  "competencyCycleEndDate": "2021-03-21T13:24:29.539Z",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "dateImported": "2021-03-21T13:24:29.539Z",
  "competencyCycle": "CompetencyCycleDto"
}

User

This section shows all of the classes used in the User endpoint.

Get Users

Description

This request is used to get all users.

Parameters

modifiedAfter

Allows the user to filter the result by any user that has being modified after the time given.

isDeleted

Allows the user to filter the result by deleted results.

GET {BaseUrl}/api/v1/User : UserDto

{
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userReference": "string",
  "userName": "string",
  "forename": "string",
  "surname": "string",
  "fullName": "string",
  "dateOfBirth": "2021-03-21T13:24:29.539Z",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "emailAddress": "string",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "lineManagerId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "licenseNumber": "string",
  "gender": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "birthplacePostcode": "string",
  "birthplaceTown": "string",
  "nationality": "string",
  "nativeLanguage": "string",
  "timezone": "string",
  "addressId": "string",
  "lastActivityDate": "2021-03-21T13:24:29.539Z",
  "lockedOutStatus": false,
  "createdDate": "2021-03-21T13:24:29.539Z",
  "lastLogin": "2021-03-21T13:24:29.539Z",
  "lastLoginMobile": "2021-03-21T13:24:29.539Z",
  "enabled": false,
  "lastModifiedDate": "2021-03-21T13:24:29.539Z",
  "roleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userDepartmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false,
  "systemRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "authorityToWorkId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "safetyCriticalStatusId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Add User Dto

Description

This request is used to create a new user.

Request Body

addUser

The addUser object is used as the body of the request.

POST {BaseUrl}/api/v1/User : AddUserDto

{
  "userReference": "string",
  "userName": "string",
  "forename": "string",
  "surname": "string",
  "dateOfBirth": "2021-03-21T13:24:29.539Z",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "emailAddress": "string",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "lineManagerId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "licenseNumber": "string",
  "gender": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "birthplacePostcode": "string",
  "birthplaceTown": "string",
  "nationality": "string",
  "nativeLanguage": "string",
  "timezone": "string",
  "systemRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userDepartmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userAddress": "AddAddressDto",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "password": "string",
  "supportLevelId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "authorityToWorkId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "safetyCriticalStatusId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "competencyCycleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Update User

Description

This request is used to update an existing User.

Request Body

editUser

This object is the body of the request and is used.

PUT {BaseUrl}/api/v1/User : EditUserDto

{
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "forename": "string",
  "surname": "string",
  "dateOfBirth": "2021-03-21T13:24:29.539Z",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "emailAddress": "string",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "licenseNumber": "string",
  "gender": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "birthplacePostcode": "string",
  "birthplaceTown": "string",
  "nationality": "string",
  "nativeLanguage": "string",
  "timezone": "string"
}

Get User By Reference

Description

This request is used to get a user by a reference code.

Parameters

reference : REQUIRED

Reference code used to get the user.

GET {BaseUrl}/api/v1/User/reference/{reference} : UserDto

{
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userReference": "string",
  "userName": "string",
  "forename": "string",
  "surname": "string",
  "fullName": "string",
  "dateOfBirth": "2021-03-21T13:24:29.539Z",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "emailAddress": "string",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "lineManagerId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "licenseNumber": "string",
  "gender": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "birthplacePostcode": "string",
  "birthplaceTown": "string",
  "nationality": "string",
  "nativeLanguage": "string",
  "timezone": "string",
  "addressId": "string",
  "lastActivityDate": "2021-03-21T13:24:29.539Z",
  "lockedOutStatus": false,
  "createdDate": "2021-03-21T13:24:29.539Z",
  "lastLogin": "2021-03-21T13:24:29.539Z",
  "lastLoginMobile": "2021-03-21T13:24:29.539Z",
  "enabled": false,
  "lastModifiedDate": "2021-03-21T13:24:29.539Z",
  "roleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userDepartmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false,
  "systemRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "authorityToWorkId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "safetyCriticalStatusId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Get User By User Id

Description

This request is used to get a user by supplying a user id within the parameters.

Parameters

id : REQUIRED

The id of the User to get.

GET {BaseUrl}/api/v1/User/{id} : UserDto

{
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userReference": "string",
  "userName": "string",
  "forename": "string",
  "surname": "string",
  "fullName": "string",
  "dateOfBirth": "2021-03-21T13:24:29.539Z",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "emailAddress": "string",
  "baseLocationId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "lineManagerId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "assessorId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "licenseNumber": "string",
  "gender": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "birthplacePostcode": "string",
  "birthplaceTown": "string",
  "nationality": "string",
  "nativeLanguage": "string",
  "timezone": "string",
  "addressId": "string",
  "lastActivityDate": "2021-03-21T13:24:29.539Z",
  "lockedOutStatus": false,
  "createdDate": "2021-03-21T13:24:29.539Z",
  "lastLogin": "2021-03-21T13:24:29.539Z",
  "lastLoginMobile": "2021-03-21T13:24:29.539Z",
  "enabled": false,
  "lastModifiedDate": "2021-03-21T13:24:29.539Z",
  "roleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userDepartmentId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false,
  "systemRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "authorityToWorkId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "safetyCriticalStatusId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Delete User

Description

This request is used to delete a user.

Parameters

id : REQUIRED

The id of the user.

DELETE {BaseUrl}/api/v1/User/{id} : None

Get User Department Access

Description

This request is used to get the department access of a user.

Parameters

id : REQUIRED

The id of the User

GET {BaseUrl}/api/v1/User/{id}/departmentaccess : UserDepartmentAccess

{
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "departmentAccess": []
}

Get User Address

Description

This request is used to get the address of the user.

Parameters

id : REQUIRED

The id of the User

GET {BaseUrl}/api/v1/User/{id}/address : AddressDto

{
  "addressId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "line1": "string",
  "line2": "string",
  "line3": "string",
  "town": "string",
  "county": "string",
  "countryId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Change User Address

Description

This request is used to update an existing user's address with a new address.

Parameters

id : REQUIRED

The id of the user.

newAddress

The newAdress object is used as the body of the reqeust.

PUT {BaseUrl}/api/v1/User/{id}/address : AddAddressDto

{
  "line1": "string",
  "line2": "string",
  "line3": "string",
  "town": "string",
  "county": "string",
  "postCode": "string",
  "countryId": "1b231a24-859e-4a1e-9c52-c14e40cd107d"
}

Get User Company Roles

Description

This request is used to get a user's company roles.

Parameters

id : REQUIRED

The id of the User.

isDeleted

Allows the user to filter the results by deleted results.

GET {BaseUrl}/api/v1/User/{id}/companyRoles : UserRolesDto

{
  "userCompanyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false
}

Get All User Company Roles

Description

This request is used to get all user company roles.

Parameters

isDeleted

Allows the user to filter the results by deleted results.

GET {BaseUrl}/api/v1/User/companyRoles : UserRolesDto

{
  "userCompanyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "companyRoleId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "isDeleted": false
}

Get User Teams

Description

This request is used to get a user's teams.

Parameters

id : REQUIRED

The id of the User.

isDeleted

Allows the user to filter the results by deleted results.

GET {BaseUrl}/api/v1/User/{id}/teams : UserTeamsDto

{
  "userTeamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false
}

Get All User Teams

Description

This request is used to get all user teams.

Parameters

isDeleted

Allows the user to filter results by deleted results.

GET {BaseUrl}/api/v1/User/teams : UserTeamsDto

{
  "userTeamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "teamId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "isDeleted": false
}

Toggle User Status

Description

This request is used to toggle the status of a user.

Parameters

id : REQUIRED

The id of the user to toggle the status off.

enabled : REQUIRED

The status of the user.

POST {BaseUrl}/api/v1/User/{id}/status/{enabled} : None

Add User Department Access

Description

This request is used to add department access to a user.

Parameters

id : REQUIRED

The id of the user to add the department too.

departmentId : REQUIRED

The id of the department.

POST {BaseUrl}/api/v1/User/{id}/departmentaccess/{departmentId} : None

Change User Manager

Description

This request is used to change an existing user's manager.

Parameters

id : REQUIRED

The id of the user.

managerid : REQUIRED

The id of the manager.

PUT {BaseUrl}/api/v1/User/{id}/manager/{managerid} : None

Change User Assessor

Description

This request is used to change the assessor on an existing user.

Parameters

id : REQUIRED

The id of the user.

assessorId : REQUIRED

The id of the assessor.

PUT {BaseUrl}/api/v1/User/{id}/assessor/{assessorId} : None

Change User System Role

Description

This request is used to change the system role of an existing user.

Parameters

id : REQUIRED

The id of the user

systemRoleId : REQUIRED

The id of the system role.

PUT {BaseUrl}/api/v1/User/{id}/systemrole/{systemRoleId} : None

Change User Authority To Work

Description

This request is used to change an existing user's authority to work.

Parameters

id : REQUIRED

The id of the user.

authorityToWorkId : REQUIRED

The authority to work id.

PUT {BaseUrl}/api/v1/User/{id}/authoritytowork/{authorityToWorkId} : None

Updates the last sign on date

Description

Parameters

id : REQUIRED

The id of the infratructure to update

routeId : REQUIRED

The id of the route

lastSignOnDate : REQUIRED

The last sign on date

PUT {BaseUrl}/api/v1/User/{id}/infrastructureAuthorisedToOperate/{routeId}/{lastSignOnDate} : None

Change User Safety Critical Status

Description

This request is used to change the safety critical status of an existing user.

Parameters

id : REQUIRED

The id of the user

safetyCriticalStatusId : REQUIRED

The id of the safety critical status.

PUT {BaseUrl}/api/v1/User/{id}/safetycriticalstatus/{safetyCriticalStatusId} : None

Remove User Department Access

Description

This request is used to remove a user access to a department.

Parameters

id : REQUIRED

The id of the user.

departmentid : REQUIRED

The id fo the department.

DELETE {BaseUrl}/api/v1/User/{id}/departmentaccess/{departmentid} : None

Get user authority to work staus by user id

Description

Parameters

id : REQUIRED

The id of the user

modifiedAfter

The date to get the statuses after

isDeleted

GET {BaseUrl}/api/v1/User/{id}/authorityToWorkStatus : None

Get user authority to work statuses

Description

Parameters

modifiedAfter

The date to ge the results after

isDeleted

Gets deleted results

GET {BaseUrl}/api/v1/User/authorityToWorkStatus : None

Get user medical status by user id

Description

This request will get a user's medical status from by their id.

Parameters

id : REQUIRED

The id of the user.

modifiedAfter

The date to get the results after.

isDeleted

Gets deleted results.

GET {BaseUrl}/api/v1/User/{id}/medicalStatus : None

Get all user medical status

Description

This request will get all user medical status (within the given parameters)

Parameters

modifiedAfter

The date to get the results after.

isDeleted

Gets deleted results.

GET {BaseUrl}/api/v1/User/medicalStatus : None

Get user infrastructure authorised to operate by user id

Description

This request will get a user infrastructure authorised to operate using the user's id

Parameters

id : REQUIRED

modifiedAfter

The date to get the results after.

isDeleted

Gets deleted results.

isArchived

isImported

GET {BaseUrl}/api/v1/User/{id}/infrastructureAuthorisedToOperate : None

Get all user infrastructure authorised to operate

Description

This request will get all user infrastructure authorised to operate (within the given parameters)

Parameters

modifiedAfter

The date to get the results after.

isDeleted

Gets deleted results.

isArchived

isImported

GET {BaseUrl}/api/v1/User/infrastructureAuthorisedToOperate : None

Get user rolling stock authorised to operate

Description

This request will get a user rolling stock authorised to operate using the user's id

Parameters

id : REQUIRED

modifiedAfter

The date to get the results after.

isDeleted

Gets deleted results.

isImported

GET {BaseUrl}/api/v1/User/{id}/rollingStockAuthorisedToOperate : None

Get all user rolling stock authorised to operate

Description

This request will get all user rolling stock authorised to operate (within the given parameters)

Parameters

modifiedAfter

The date to get the results after.

isDeleted

Gets deleted results.

isImported

GET {BaseUrl}/api/v1/User/rollingStockAuthorisedToOperate : None

Get user skills

Description

This request will get all user skills using the user's id

Parameters

id : REQUIRED

modifiedAfter

The date to get the results after.

validFrom

Include user skills that are valid from this date

isDeleted

Gets deleted results.

GET {BaseUrl}/api/v1/User/{id}/skills : None

Get all user skills

Description

This request will get all user skills (within the given parameters)

Parameters

modifiedAfter

The date to get the results after.

validFrom

Include user skills that are valid from this date

isDeleted

Gets deleted results.

GET {BaseUrl}/api/v1/User/skills : None

User Medical Detail

This section shows all of the classes used in the User Medical Detail endpoint.

Get User Medical Detail

Description

This request is used to get all User Medical Detail

Parameters

isDeleted

This allows the results to include deleted User medical detail objects.

GET {BaseUrl}/api/v1/UserMedicalDetail : UserMedicalDetailDto

{
  "userMedicalDetailId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "medicalPractitionerId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "orrRegistrationNumber": "string",
  "generalHealthSummary": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "medicalAssessmentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "recommendations": "string",
  "reviewRequired": false,
  "dateOfReview": "2021-03-21T13:24:29.539Z",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "MedicalAssessmentDetailDto": "MedicalAssessmentDetailDto",
  "VisionAssessmentDto": "VisionAssessmentDto",
  "HearingAssessmentDto": "HearingAssessmentDto",
  "DrugsAlcoholAndDiabetesAssessmentDto": "DrugsAlcoholAndDiabetesAssessmentDto"
}

Get User Medical Detail By Id

Description

This request is used to get an user medical detail by id.

Parameters

id : REQUIRED

The id of the User Medical Detail to get.

GET {BaseUrl}/api/v1/UserMedicalDetail/{id} : UserMedicalDetailDto

{
  "userMedicalDetailId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "medicalPractitionerId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "orrRegistrationNumber": "string",
  "generalHealthSummary": "string",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "medicalAssessmentTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "recommendations": "string",
  "reviewRequired": false,
  "dateOfReview": "2021-03-21T13:24:29.539Z",
  "dateCreated": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "MedicalAssessmentDetailDto": "MedicalAssessmentDetailDto",
  "VisionAssessmentDto": "VisionAssessmentDto",
  "HearingAssessmentDto": "HearingAssessmentDto",
  "DrugsAlcoholAndDiabetesAssessmentDto": "DrugsAlcoholAndDiabetesAssessmentDto"
}

User Safety Briefing

This section shows all of the classes used in the User Safety Briefing endpoint.

Get User Safety briefing

Description

This request is used to get all User Safety Briefing within the parameters.

Parameters

modifiedDateTime

Gets all the assessments created on or after the date and time supplied

imported

Allows the user to get imported assessments

isDeleted

Allows the user to get deleted assessments

GET {BaseUrl}/api/v1/UserSafetyBriefing : UserSafetyBriefingDto

{
  "userSafetyBriefingId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "userId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "safetyBriefingTypeId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "title": "string",
  "dateAttended": "2021-03-21T13:24:29.539Z",
  "isDeleted": false,
  "safetyBriefId": "1b231a24-859e-4a1e-9c52-c14e40cd107d",
  "modifiedDate": "2021-03-21T13:24:29.539Z",
  "dateImported": "2021-03-21T13:24:29.539Z"
}

Endpoint Schema ​

How to use ​

Assessment ​

Get All Assessments Before Date

Description

Parameters

modifiedDateTime : REQUIRED

archived

imported

isDeleted

Get All Assessments

Description

Parameters

modifiedDateTime

archived

imported

isDeleted

Add Assessment

Description

Request Body

addAssessmentDto

Get Assessment By Id

Description

Parameters

id : REQUIRED

Delete Assessment

Description

Parameters

id : REQUIRED

Get Assessment Notes By Assessment Id

Description

Parameters

id : REQUIRED

AddAssessmentNoteDto

Description

Parameters

id : REQUIRED

addAssessmentNoteDto

Get All Assessment Notes

Description

Parameters

isDeleted

Get Assessment Results

Description

Parameters

modifiedDateTime

imported

isArchived

assessorConfirmedResult

isDeleted

isForceUpdated

Complete Assessment

Description

Parameters

id : REQUIRED

completeAssessmentDto

Delete Assessment Note

Description

Parameters

id : REQUIRED

Company Information ​

Get All Assessments Before Date

Description

Parameters

modifiedDateTime : REQUIRED

archived

imported

isDeleted

Get All Assessments

Description

Parameters

modifiedDateTime

archived

imported

isDeleted

Add Assessment

Description

Request Body

addAssessmentDto

Get Assessment By Id

Endpoint Schema

How to use

Assessment

Company Information

Company Role