Skip to main content
POST
/
commissions
/
v2
/
rs
Create a new commission
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/commissions/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>' \
  --data '
{
  "visitType": 1,
  "siteIds": [
    1
  ],
  "decision": 1,
  "commissionDate": "2024-12-01T12:34:56.000Z",
  "comment": "Urgent repairs needed.",
  "buildingWorkId": 1,
  "labelIds": [
    1
  ]
}
'
{
  "data": {
    "id": 1,
    "visitType": 1,
    "commissionType": 1,
    "status": 1,
    "decision": 1,
    "commissionDate": "2024-12-01T12:34:56.000Z",
    "buildingWorkId": 1,
    "siteId": 1,
    "comment": "Urgent repairs needed.",
    "createdById": 1,
    "signatureUrl": "Signature URL",
    "signedBy": "Signatory"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to create a commission

visitType
integer
required

Type of visit.

Example:

1

siteIds
integer[]
required
Minimum array length: 1

Identifier of the associated site.

decision
integer

Decision of the commission.

Example:

1

commissionDate

Date of the commission.

Example:

"2024-12-01T12:34:56.000Z"

comment
string | null

Comment associated with the commission.

Example:

"Urgent repairs needed."

buildingWorkId
integer

Unique identifier of the building work.

Example:

1

labelIds
integer[]

Unique identifier of the label.

Response

201 - application/json

The commission has been created successfully

data
object
required