Update Company Validity

Request

Update an existing validity for a company.

Security

oAuth2ClientCredentials

Path

company_idstring, (uuid)(Company Id)required

idstring, (uuid)(Id)required

Bodyapplication/jsonrequired

start_timestring, (date-time)(Start Time)required

Start time of the validity

end_timestring or null(End Time)

Any of:

End time of the validity from a planning perspective

string (date-time)

legal_end_timestring or null(Legal End Time)

Any of:

End time of the validity from a legal perspective

string (date-time)

generate_unavailabilityboolean(Generate Unavailability)

Generate a planning unavailability once the validity end time has passed

Default:false

typestring(SubcontractorValidityReason)required

Enum:"ATA_CARNET""BANK_DETAILS""CMR_INSURANCE""COMMON_HEALTH_ENTRY_DOCUMENT""COMMUNICATION""COMMUNICATION_SUBCONTRACTOR""SUBCONTRACTOR_CONTRACT""CREDIT_REPORT""DGSA_CERTIFICATE""ECMT_TRANSPORT_LICENSE"

external_idstring or null(External Id)

Any of:

ID of the validity in the external master data system

string

descriptionstring or null(Description)

Any of:

string

documentsArray of objects(Documents)

List of documents associated with the validity

PUT

/v1/companies/company/{company_id}/validity/{id}

{
  "start_time": "2019-08-24T14:15:22Z",
  "end_time": "2019-08-24T14:15:22Z",
  "legal_end_time": "2019-08-24T14:15:22Z",
  "generate_unavailability": false,
  "type": "ATA_CARNET",
  "external_id": "string",
  "description": "string",
  "documents": [
    { … }
  ]
}

Responses

Successful Response

Bodyapplication/json

start_timestring, (date-time)(Start Time)required

Start time of the validity

end_timestring or null(End Time)

Any of:

End time of the validity from a planning perspective

string (date-time)

legal_end_timestring or null(Legal End Time)

Any of:

End time of the validity from a legal perspective

string (date-time)

generate_unavailabilityboolean(Generate Unavailability)

Generate a planning unavailability once the validity end time has passed

Default:false

typestring(SubcontractorValidityReason)required

Enum:"ATA_CARNET""BANK_DETAILS""CMR_INSURANCE""COMMON_HEALTH_ENTRY_DOCUMENT""COMMUNICATION""COMMUNICATION_SUBCONTRACTOR""SUBCONTRACTOR_CONTRACT""CREDIT_REPORT""DGSA_CERTIFICATE""ECMT_TRANSPORT_LICENSE"

external_idstring or null(External Id)

Any of:

ID of the validity in the external master data system

string

descriptionstring or null(Description)

Any of:

string

idstring, (uuid)(Id)required

Unique identifier of the validity

Response

{
  "start_time": "2019-08-24T14:15:22Z",
  "end_time": "2019-08-24T14:15:22Z",
  "legal_end_time": "2019-08-24T14:15:22Z",
  "generate_unavailability": false,
  "type": "ATA_CARNET",
  "external_id": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}