v1

latestOpenAPI 3.0.02026-08-06151101754.7 KB
Documentations

Updates documentation

put/documentations/{documentationId}

Path parameters

documentationIdinteger required

Documentation id

Request body

assignment_idinteger

The appointment id to add to the documentation

author_idinteger

The author of this documentation (only customizable for type TIME)

titlestring

The documentation title

descriptionstring

The documentation description

type'NOTE' | 'DRAFT' | 'PHOTO' | 'SIGNING' | 'TIME' | 'PDF' | 'ATTACHMENT' | 'MATERIAL'

The documentation type

state'ACCEPTED_WITH_COMMENT' | 'ACCEPTED_WO_COMMENT' nullable

Documentation state

state_textstring

Documentation Signing text (Like 'Vertragsgerechet und mangelfrei...' to display and store

working_timeinteger

The working time in minutes

driving_timeinteger

The driving time in minutes

break_timeinteger

The break time in minutes

documented_onstring date-time

The datetime, when the documentation has been documented has been created

uploadstring binary

First documentation upload file. PLEASE ADD _method=put parameter and change method to POST, if you send file uploads (PHP issue. More info: https://stackoverflow.com/questions/39942670/how-to-send-put-request-with-a-file-and-an-array-of-data-in-laravel)

upload2string binary

Second documentation upload file. PLEASE ADD _method=put parameter and change method to POST, if you send file uploads (PHP issue. More info: https://stackoverflow.com/questions/39942670/how-to-send-put-request-with-a-file-and-an-array-of-data-in-laravel)

sourcestring

The document source

source_external_idstring

The document source_external_id

Response

The request was successful.