Auth

POST Auth/Logon
Logon with username and password

Companies

GET companies
Get a list of companies.

GET companies/{companyId}
Gets a comppany

GET companies/{companyId}/users
Gets all users from the company

GET companies/{companyId}/addresses
Gets all addresses from the company

POST companies
Creates a company

PUT companies/{companyId}
Updates a company

PUT companies/{companyId}/enable
Enables a company

PUT companies/{companyId}/disable
Disables a company

DELETE companies/{companyId}
Deletes a company

GET companies/dispatchers
Get a list of dispatchers. This method can only be called by a sender.

Addresses

GET addresses
Get a list of adresses to which you can send a form. This method can only be called by a sender.

GET addresses/{id}
Gets an addres by id.

POST addresses
Create a new address for a certain company

PUT addresses/{id}
Update an address

DELETE addresses/{id}
Delete an address

FormTypes

GET formtypes
Get a list of formtypes.

Location

GET locations/{id}

POST locations

Users

GET users
Get a list of users. This method can only be called by an admin.

POST users
Creates a user

GET users/transporters
Get a list of transporters. This method can only be called by a dispatcher.

GET users/{id}
Gets the user

GET users/{id}/configfile
Gets the config file for a user

PUT users/{id}/enable?sendMail={sendMail}
Activates the user

PUT users/{id}/disable
Deactivates the user

PUT users/{id}/password
Changes the password for the user

PUT users/{id}
Updates the user

DELETE users/{id}
Deletes the user

Forms

GET forms/sender
Get a list of forms, for the logged in sender. This can only be called by a sender

GET forms/dispatcher
Get a list of forms, for the logged in dispatcher. This can only be called by a dispatcher

GET forms/{id}
Get a form by id

POST forms
Upload a form as a multipart message. The first part of the message should be json, the second part must be base64 upload. Only the first part of the message is shown below.

PUT forms/{id}/customfields
No documentation available.

DELETE forms/{id}
Deletes a form

DELETE forms/{id}/superdelete
Deletes a form even if it is no longer in edit mode. This method only works when SuperDelete is enabled, only the administrator can decide if it is enabled or not.

DELETE forms/{id}/cancel
Cancels a form, and cancels it on a tablet when it gets synced

PUT forms/{id}/send
Assign a form to a dispatcher

GET forms/{id}/versions
Gets the diffirent versions of a a form

GET forms/{id}/versions/{version}
Gets a version of a form (json only)

GET forms/{id}/versions/{version}/file
Download a specific version of a form

POST forms/{id}/versions
Upload a new version of a form

GET forms/{id}/versions/{version}/attachments
Get a list of all attachments attached to a version of a form

POST forms/{id}/versions/{version}/attachments
Upload a new attachment

GET forms/{id}/versions/{version}/attachments/{attachment}
Gets data related to an attachment

GET forms/{id}/versions/{version}/attachments/{attachment}/file
The binary file

Enumerations

GET Enumerations/TrajectStates
Gets the available traject states

GET Enumerations/FormStates
Gets the available form states

GET Enumerations/Roles
Gets the available roles

GET Enumerations/Countries
Gets a list of countries

GET Enumerations/AttachmentCategories
Get a list of attachment categories

Trajects

GET trajects/dispatcher
Get a list of trajects, for a dispatcher company, which are either in edit mode or assigned to a transporter.

GET trajects/{id}
Gets a traject by id

POST trajects
Creates a new traject for the currently logged in user. Only a dispatcher can call this method.

PUT trajects/{id}
Updates the traject with the given Id. Only a dispatcher can call this method.

DELETE trajects/{id}
Deletes the traject with the given Id. Only a dispatcher can call this method.

DELETE trajects/{id}/superdelete
Deletes the traject with the given Id. Only a dispatcher can call this method. This method only works when SuperDelete is enabled, only the administrator can decide if it is enabled or not.

PUT trajects/{id}/transporter
Assigns a transporter to the traject and sends a mail to this transporter. Only a dispatcher can call this method.

DELETE trajects/{id}/transporter
Removes the transporter from the traject. Only a dispatcher can call this method.

GET trajects/{id}/rides
Get the rides for a traject

GET trajects/{id}/rides/{childId}
Gets a ride within a traject

POST trajects/{id}/rides
Creates a new ride in a traject. Only a dispatcher can call this method.

PUT trajects/{id}/rides/{childId}
Updates a ride. Only a dispatcher can call this method

DELETE trajects/{id}/rides/{childId}
Removes a ride from a traject. Only a dispatcher can call this method.

DELETE trajects/{id}/rides/{childId}/superdelete
Removes a ride from a traject. Only a dispatcher can call this method. This method only works when SuperDelete is enabled, only the administrator can decide if it is enabled or not.

PUT trajects/{id}/rides/{childId}/move
Moves a ride to another traject. This can only be done when the trajects have not yet been synced with a tablet. Only a dispatcher can call this method.

GET trajects/{id}/rides/{childId}/forms
Gets all forms attached to a ride.

GET trajects/{id}/rides/{childId}/forms/{grandChildId}
Gets the relation between a ride and a form.

POST trajects/{id}/rides/{childId}/forms
Attaches a form to a ride

DELETE trajects/{id}/rides/{childId}/forms/{grandChildId}
Detaches a form from a ride

DELETE trajects/{id}/rides/{childId}/forms/{grandChildId}/superdelete
Detaches a form from a ride. This method only works when SuperDelete is enabled, only the administrator can decide if it is enabled or not.