MAmaqqie
Arbo document

Create an arbo document

Changed on

Create an arbo document

post/public/arbo-document/v1/create-arbo-document

Request

Request body

companyIdstring uuid required

The unique id of the client company.

contactIdstring uuid required

The unique id of the client company's contact person on whose behalf this API is called.

workerPointOfContactContactIdstring uuid required

The unique id of the client company's contact person that acts as the point of contact for the worker. Their phone number will be shared with the worker.

datestring date required

The date, that is considered to be the date of drafting the arbo document. In ISO 8601 calendar date (YYYY-MM-DD). TODO: check whether there are any restrictions on the date.

functionIdstring uuid required

The function applicable to the activities for the work that this arbo document is valid for (arbo documents cannot apply to more than one function). The id must be a value returned from the collective-labour-agreement API. The function's collective labour agreement must be one of the client company's collective labour agreements.

isDocumentForSafetyEducationboolean required

true if there is a document with general safety-related information material, false otherwise. The caller of this endpoint should make that document available together with the created arbo document.

isDocumentForSpecificSafetyRegulationsboolean required

true if there is a document with client-company safety precautions for this arbo document's function, false otherwise. The caller of this endpoint should make that document available together with the created arbo document.

isDocumentForInHouseEmergencyServiceAgreementsboolean required

true if there is a document with client-company arrangements for emergency response, false otherwise. The caller of this endpoint should make that document available together with the created arbo document.

isSafetyProtectedEquipmentboolean required

true if the worker needs equipment for safety protection, false otherwise. If true, it is mandatory for the client company to provide that equipment (in a timely manner).

isWorkOnThirdPartyLocationsboolean required

true if the worker will work at third-party locations (i.e. locations not belonging to the client company). If true, the client company is responsible for providing any necessary information about safety and health regulations at those locations.

Response

Successfully created the arbo document

fileIdstring uuid required

The unique id of the arbo document PDF.

Changes

  • f9510f3f4b22Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to string for status

    • info

      added the required property to the response with the status

  • 3352b56bb8feRevision changes
    • breaking

      the request's body type changed from object to no type

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from string to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      response schema application/json enum value removed CONTACT_DOES_NOT_BELONG_TO_COMPANY

    • info

      response schema application/json enum value removed FUNCTION_DOES_NOT_BELONG_TO_CLA_OF_COMPANY

    • info

      response schema application/json enum value removed WORKER_POINT_OF_CONTACT_DOES_NOT_BELONG_TO_COMPANY