Documentation

Preventive workorder

Create preventive workorder

POST/supplier/v1/preventiveworkorder Provide a preventive workorder

A preventive workorder should be created using 3.1 from where the process will be continued to execute the workorder with 2.3. If documents need to be attached to the workorder the API 2.4 can be used.

Call guidelines

{
  "SupplierID": "string",
  "SupplierWorkOrderNr": "string",
  "Subject": "string",
  "Description": "string",
  "DateStart": "2021-02-01",
  "DateEnd": "2021-02-01",
  "Property": 0,
  "Asset": 0
}

SupplierID, SupplierWorkOrderNr, Subject are obligatory.'

  • Property: Property reference as used in Axxerion
  • Asset: Asset reference as used in Axxerion

Response fields

{
  "data": [
    {
      "WorkOrderId": "string",
      "response": "string",
      "warningMessage": "string",
      "errorMessage": "string",
      "id": "string",
      "objectNameId": "string"
    }
  ]
}

PostNLWorkOrderNr is the reference used in Axxerion and can be used in other API calls.

Possible error messages

  • SupplierID cannot be empty
  • Unknown SupplierID specified
  • SupplierWorkOrderNr cannot be empty
  • There is allready a WorkOrder with SupplierID in combination with SupplierWorkOrderNr
  • Document not found in Axxerion
  • Propertyreference is not known in Axxerion
  • Assetreference is not known in Axxerion
  • Subject cannot be empty
  • Cannot create new object
  • SupplierID is does not have a valid supplier-Category
  • Start dateformat is not valid
  • End dateformat is not valid

Preventive workorder information

GET/supplier/v1/preventiveworkorder Retrieve a preventive workorder confirmation

This call returns all data on preventive workorders to complete te registration started at 3.1.

Call guidelines

Field SupplierID is required

Response fields

{
  "data": [
    {
      "Id": "string",
      "SupplierID": "string",
      "SupplierWorkOrderNr": "string",
      "PostNLWorkOrderNr": "string",
      "Subject": "string",
      "Description": "string",
      "Priority": "string",
      "DateStart": "2021-02-01",
      "PropertyId": "string",
      "Street": "string",
      "Number": "string",
      "NumberAddition": "string",
      "PostalCode6": "string",
      "PostalCode4": "string",
      "City": "string",
      "CountryCode": "NL",
      "Area": "string",
      "Asset": "string",
      "LocationOpenTime": "string",
      "LocationContactPostNL": "string",
      "LocationPhonePostNL": "string",
      "LocationMailPostNL": "string",
      "Attachment1": "string",
      "AttachmentUrl1": "string",
      "Attachment2": "string",
      "AttachmentUrl2": "string",
      "Attachment3": "string",
      "AttachmentUrl3": "string",
      "Attachment4": "string",
      "AttachmentUrl4": "string",
      "Attachment5": "string",
      "AttachmentUrl5": "string",
      "response": "string",
      "warningMessage": "string",
      "errorMessage": "string",
      "id": "string",
      "objectNameId": "string"
    }
  ]
}

Possible error messages

  • SupplierID cannot be empty
  • Unknown SupplierID specified
  • SupplierID does not have a valid supplier-Category