POST api/backoffice/v{version}/workorders

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

Workorder

Name	Type	Additional information
id	integer	None.
customer	string	None.
type	string	None.
datetime	string	None.
instructions	string	None.
order	integer	None.
require_image	integer	None.
require_name	integer	None.
require_signature	integer	None.
require_document	integer	None.
require_note	integer	None.
require_generic	integer	None.
vehicle	string	None.
trailer	string	None.
summary_text	string	None.
summary_title	string	None.
summary_text_2	string	None.
require_items_edit	integer	None.
require_driver_confirmation	integer	None.
secondary_workorder_eventtype_id	Object	None.
created_at	string	None.
updated_at	string	None.
status_id	integer	None.
user_id	integer	None.
require_input_if_not_scanned	integer	None.
override_client_status	integer	None.
remove_no_one_to_sign	integer	None.
user	User	None.
status	Status	None.
items	Collection of Item	None.
addresses	Collection of WorkorderAddress	None.
references	Collection of WorkorderReference	None.
required_event_types	Collection of WorkorderEventTypeRequired	None.
secondary_event_type	Collection of SecondaryWorkorderEventType	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "customer": "sample string 2",
  "type": "sample string 3",
  "datetime": "sample string 4",
  "instructions": "sample string 5",
  "order": 6,
  "require_image": 1,
  "require_name": 1,
  "require_signature": 1,
  "require_document": 1,
  "require_note": 1,
  "require_generic": 1,
  "vehicle": "sample string 7",
  "trailer": "sample string 8",
  "summary_text": "sample string 9",
  "summary_title": "sample string 10",
  "summary_text_2": "sample string 11",
  "require_items_edit": 12,
  "require_driver_confirmation": 13,
  "secondary_workorder_eventtype_id": {},
  "created_at": "sample string 15",
  "updated_at": "sample string 16",
  "status_id": 17,
  "user_id": 18,
  "require_input_if_not_scanned": 19,
  "override_client_status": 20,
  "remove_no_one_to_sign": 21,
  "user": {
    "id": 1,
    "username": "sample string 2",
    "email": "sample string 3",
    "phone": "sample string 4",
    "password": "sample string 5",
    "device_id": "sample string 6",
    "enabled": 7,
    "created_at": "sample string 8",
    "updated_at": "sample string 9",
    "has_signature": true,
    "signature_updated_at": "sample string 11",
    "type": "sample string 12",
    "app_version": "sample string 13",
    "company_id": 14,
    "company": {
      "id": 1,
      "name": "sample string 2",
      "api_Key": "sample string 3",
      "enabled": 4,
      "docscanner": 5
    }
  },
  "status": {
    "id": 1,
    "code": "sample string 2",
    "colour": "sample string 3",
    "complete": 4,
    "cancelled": 5,
    "company_id": 6,
    "primary_eventtype_id": 7,
    "updated_at": "sample string 8",
    "created_at": "sample string 9",
    "deleted_at": "sample string 10",
    "status_eventtype_ids": [
      1,
      2
    ]
  },
  "items": [
    {
      "moveit_id": 1,
      "quantity": 2,
      "workorder_id": 3,
      "sub_unit_type": "sample string 4",
      "sub_quantity": 5,
      "description": "sample string 6",
      "weight": 7,
      "id": 8,
      "unit_type": "sample string 9",
      "reference": "sample string 10",
      "status": 0
    },
    {
      "moveit_id": 1,
      "quantity": 2,
      "workorder_id": 3,
      "sub_unit_type": "sample string 4",
      "sub_quantity": 5,
      "description": "sample string 6",
      "weight": 7,
      "id": 8,
      "unit_type": "sample string 9",
      "reference": "sample string 10",
      "status": 0
    }
  ],
  "addresses": [
    {
      "country": "sample string 1",
      "workorder_id": 2,
      "town": "sample string 3",
      "postcode": "sample string 4",
      "primary_address": 5,
      "signature_available": 6,
      "description": "sample string 7",
      "lon": "sample string 8",
      "phone": "sample string 9",
      "contact": "sample string 10",
      "name": "sample string 11",
      "id": 12,
      "region": "sample string 13",
      "line2": "sample string 14",
      "line1": "sample string 15",
      "lat": "sample string 16",
      "order": 17
    },
    {
      "country": "sample string 1",
      "workorder_id": 2,
      "town": "sample string 3",
      "postcode": "sample string 4",
      "primary_address": 5,
      "signature_available": 6,
      "description": "sample string 7",
      "lon": "sample string 8",
      "phone": "sample string 9",
      "contact": "sample string 10",
      "name": "sample string 11",
      "id": 12,
      "region": "sample string 13",
      "line2": "sample string 14",
      "line1": "sample string 15",
      "lat": "sample string 16",
      "order": 17
    }
  ],
  "references": [
    {
      "workorder_id": 1,
      "name": "sample string 2",
      "id": 3,
      "value": "sample string 4"
    },
    {
      "workorder_id": 1,
      "name": "sample string 2",
      "id": 3,
      "value": "sample string 4"
    }
  ],
  "required_event_types": [
    {
      "workorder_eventtype_id": 1,
      "workorder_id": 2,
      "updated_at": "sample string 3",
      "created_at": "sample string 4",
      "id": 5
    },
    {
      "workorder_eventtype_id": 1,
      "workorder_id": 2,
      "updated_at": "sample string 3",
      "created_at": "sample string 4",
      "id": 5
    }
  ],
  "secondary_event_type": [
    {
      "code": "sample string 1",
      "generic_regex": "sample string 2",
      "require_signature": 3,
      "company_id": 4,
      "generic_errormessage": "sample string 5",
      "created_at": "sample string 6",
      "system": 7,
      "status_id": 8,
      "require_name": 9,
      "updated_at": "sample string 10",
      "require_image": 11,
      "generic_question": "sample string 12",
      "id": 13,
      "require_generic": 14,
      "require_note": 15
    },
    {
      "code": "sample string 1",
      "generic_regex": "sample string 2",
      "require_signature": 3,
      "company_id": 4,
      "generic_errormessage": "sample string 5",
      "created_at": "sample string 6",
      "system": 7,
      "status_id": 8,
      "require_name": 9,
      "updated_at": "sample string 10",
      "require_image": 11,
      "generic_question": "sample string 12",
      "id": 13,
      "require_generic": 14,
      "require_note": 15
    }
  ]
}

text/html

Sample:

{"id":1,"customer":"sample string 2","type":"sample string 3","datetime":"sample string 4","instructions":"sample string 5","order":6,"require_image":1,"require_name":1,"require_signature":1,"require_document":1,"require_note":1,"require_generic":1,"vehicle":"sample string 7","trailer":"sample string 8","summary_text":"sample string 9","summary_title":"sample string 10","summary_text_2":"sample string 11","require_items_edit":12,"require_driver_confirmation":13,"secondary_workorder_eventtype_id":{},"created_at":"sample string 15","updated_at":"sample string 16","status_id":17,"user_id":18,"require_input_if_not_scanned":19,"override_client_status":20,"remove_no_one_to_sign":21,"user":{"id":1,"username":"sample string 2","email":"sample string 3","phone":"sample string 4","password":"sample string 5","device_id":"sample string 6","enabled":7,"created_at":"sample string 8","updated_at":"sample string 9","has_signature":true,"signature_updated_at":"sample string 11","type":"sample string 12","app_version":"sample string 13","company_id":14,"company":{"id":1,"name":"sample string 2","api_Key":"sample string 3","enabled":4,"docscanner":5}},"status":{"id":1,"code":"sample string 2","colour":"sample string 3","complete":4,"cancelled":5,"company_id":6,"primary_eventtype_id":7,"updated_at":"sample string 8","created_at":"sample string 9","deleted_at":"sample string 10","status_eventtype_ids":[1,2]},"items":[{"moveit_id":1,"quantity":2,"workorder_id":3,"sub_unit_type":"sample string 4","sub_quantity":5,"description":"sample string 6","weight":7,"id":8,"unit_type":"sample string 9","reference":"sample string 10","status":0},{"moveit_id":1,"quantity":2,"workorder_id":3,"sub_unit_type":"sample string 4","sub_quantity":5,"description":"sample string 6","weight":7,"id":8,"unit_type":"sample string 9","reference":"sample string 10","status":0}],"addresses":[{"country":"sample string 1","workorder_id":2,"town":"sample string 3","postcode":"sample string 4","primary_address":5,"signature_available":6,"description":"sample string 7","lon":"sample string 8","phone":"sample string 9","contact":"sample string 10","name":"sample string 11","id":12,"region":"sample string 13","line2":"sample string 14","line1":"sample string 15","lat":"sample string 16","order":17},{"country":"sample string 1","workorder_id":2,"town":"sample string 3","postcode":"sample string 4","primary_address":5,"signature_available":6,"description":"sample string 7","lon":"sample string 8","phone":"sample string 9","contact":"sample string 10","name":"sample string 11","id":12,"region":"sample string 13","line2":"sample string 14","line1":"sample string 15","lat":"sample string 16","order":17}],"references":[{"workorder_id":1,"name":"sample string 2","id":3,"value":"sample string 4"},{"workorder_id":1,"name":"sample string 2","id":3,"value":"sample string 4"}],"required_event_types":[{"workorder_eventtype_id":1,"workorder_id":2,"updated_at":"sample string 3","created_at":"sample string 4","id":5},{"workorder_eventtype_id":1,"workorder_id":2,"updated_at":"sample string 3","created_at":"sample string 4","id":5}],"secondary_event_type":[{"code":"sample string 1","generic_regex":"sample string 2","require_signature":3,"company_id":4,"generic_errormessage":"sample string 5","created_at":"sample string 6","system":7,"status_id":8,"require_name":9,"updated_at":"sample string 10","require_image":11,"generic_question":"sample string 12","id":13,"require_generic":14,"require_note":15},{"code":"sample string 1","generic_regex":"sample string 2","require_signature":3,"company_id":4,"generic_errormessage":"sample string 5","created_at":"sample string 6","system":7,"status_id":8,"require_name":9,"updated_at":"sample string 10","require_image":11,"generic_question":"sample string 12","id":13,"require_generic":14,"require_note":15}]}

application/xml, text/xml

Sample:

<Workorder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DispatchITV2.Models.Data">
  <addresses>
    <WorkorderAddress>
      <contact>sample string 10</contact>
      <country>sample string 1</country>
      <description>sample string 7</description>
      <id>12</id>
      <lat>sample string 16</lat>
      <line1>sample string 15</line1>
      <line2>sample string 14</line2>
      <lon>sample string 8</lon>
      <name>sample string 11</name>
      <order>17</order>
      <phone>sample string 9</phone>
      <postcode>sample string 4</postcode>
      <primary_address>5</primary_address>
      <region>sample string 13</region>
      <signature_available>6</signature_available>
      <town>sample string 3</town>
      <workorder_id>2</workorder_id>
    </WorkorderAddress>
    <WorkorderAddress>
      <contact>sample string 10</contact>
      <country>sample string 1</country>
      <description>sample string 7</description>
      <id>12</id>
      <lat>sample string 16</lat>
      <line1>sample string 15</line1>
      <line2>sample string 14</line2>
      <lon>sample string 8</lon>
      <name>sample string 11</name>
      <order>17</order>
      <phone>sample string 9</phone>
      <postcode>sample string 4</postcode>
      <primary_address>5</primary_address>
      <region>sample string 13</region>
      <signature_available>6</signature_available>
      <town>sample string 3</town>
      <workorder_id>2</workorder_id>
    </WorkorderAddress>
  </addresses>
  <created_at>sample string 15</created_at>
  <customer>sample string 2</customer>
  <datetime>sample string 4</datetime>
  <id>1</id>
  <instructions>sample string 5</instructions>
  <items>
    <Item>
      <description>sample string 6</description>
      <id>8</id>
      <moveit_id>1</moveit_id>
      <quantity>2</quantity>
      <reference>sample string 10</reference>
      <status>None</status>
      <sub_quantity>5</sub_quantity>
      <sub_unit_type>sample string 4</sub_unit_type>
      <unit_type>sample string 9</unit_type>
      <weight>7</weight>
      <workorder_id>3</workorder_id>
    </Item>
    <Item>
      <description>sample string 6</description>
      <id>8</id>
      <moveit_id>1</moveit_id>
      <quantity>2</quantity>
      <reference>sample string 10</reference>
      <status>None</status>
      <sub_quantity>5</sub_quantity>
      <sub_unit_type>sample string 4</sub_unit_type>
      <unit_type>sample string 9</unit_type>
      <weight>7</weight>
      <workorder_id>3</workorder_id>
    </Item>
  </items>
  <order>6</order>
  <override_client_status>20</override_client_status>
  <references>
    <WorkorderReference>
      <id>3</id>
      <name>sample string 2</name>
      <value>sample string 4</value>
      <workorder_id>1</workorder_id>
    </WorkorderReference>
    <WorkorderReference>
      <id>3</id>
      <name>sample string 2</name>
      <value>sample string 4</value>
      <workorder_id>1</workorder_id>
    </WorkorderReference>
  </references>
  <remove_no_one_to_sign>21</remove_no_one_to_sign>
  <require_document>1</require_document>
  <require_driver_confirmation>13</require_driver_confirmation>
  <require_generic>1</require_generic>
  <require_image>1</require_image>
  <require_input_if_not_scanned>19</require_input_if_not_scanned>
  <require_items_edit>12</require_items_edit>
  <require_name>1</require_name>
  <require_note>1</require_note>
  <require_signature>1</require_signature>
  <required_event_types>
    <WorkorderEventTypeRequired>
      <created_at>sample string 4</created_at>
      <id>5</id>
      <updated_at>sample string 3</updated_at>
      <workorder_eventtype_id>1</workorder_eventtype_id>
      <workorder_id>2</workorder_id>
    </WorkorderEventTypeRequired>
    <WorkorderEventTypeRequired>
      <created_at>sample string 4</created_at>
      <id>5</id>
      <updated_at>sample string 3</updated_at>
      <workorder_eventtype_id>1</workorder_eventtype_id>
      <workorder_id>2</workorder_id>
    </WorkorderEventTypeRequired>
  </required_event_types>
  <secondary_event_type>
    <SecondaryWorkorderEventType>
      <code>sample string 1</code>
      <company_id>4</company_id>
      <created_at>sample string 6</created_at>
      <generic_errormessage>sample string 5</generic_errormessage>
      <generic_question>sample string 12</generic_question>
      <generic_regex>sample string 2</generic_regex>
      <id>13</id>
      <require_generic>14</require_generic>
      <require_image>11</require_image>
      <require_name>9</require_name>
      <require_note>15</require_note>
      <require_signature>3</require_signature>
      <status_id>8</status_id>
      <system>7</system>
      <updated_at>sample string 10</updated_at>
    </SecondaryWorkorderEventType>
    <SecondaryWorkorderEventType>
      <code>sample string 1</code>
      <company_id>4</company_id>
      <created_at>sample string 6</created_at>
      <generic_errormessage>sample string 5</generic_errormessage>
      <generic_question>sample string 12</generic_question>
      <generic_regex>sample string 2</generic_regex>
      <id>13</id>
      <require_generic>14</require_generic>
      <require_image>11</require_image>
      <require_name>9</require_name>
      <require_note>15</require_note>
      <require_signature>3</require_signature>
      <status_id>8</status_id>
      <system>7</system>
      <updated_at>sample string 10</updated_at>
    </SecondaryWorkorderEventType>
  </secondary_event_type>
  <secondary_workorder_eventtype_id />
  <status>
    <cancelled>5</cancelled>
    <code>sample string 2</code>
    <colour>sample string 3</colour>
    <company_id>6</company_id>
    <complete>4</complete>
    <created_at>sample string 9</created_at>
    <deleted_at>sample string 10</deleted_at>
    <id>1</id>
    <primary_eventtype_id>7</primary_eventtype_id>
    <status_eventtype_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </status_eventtype_ids>
    <updated_at>sample string 8</updated_at>
  </status>
  <status_id>17</status_id>
  <summary_text>sample string 9</summary_text>
  <summary_text_2>sample string 11</summary_text_2>
  <summary_title>sample string 10</summary_title>
  <trailer>sample string 8</trailer>
  <type>sample string 3</type>
  <updated_at>sample string 16</updated_at>
  <user>
    <app_version>sample string 13</app_version>
    <company>
      <api_Key>sample string 3</api_Key>
      <docscanner>5</docscanner>
      <enabled>4</enabled>
      <id>1</id>
      <name>sample string 2</name>
    </company>
    <company_id>14</company_id>
    <created_at>sample string 8</created_at>
    <device_id>sample string 6</device_id>
    <email>sample string 3</email>
    <enabled>7</enabled>
    <has_signature>true</has_signature>
    <id>1</id>
    <password>sample string 5</password>
    <phone>sample string 4</phone>
    <signature_updated_at>sample string 11</signature_updated_at>
    <type>sample string 12</type>
    <updated_at>sample string 9</updated_at>
    <username>sample string 2</username>
  </user>
  <user_id>18</user_id>
  <vehicle>sample string 7</vehicle>
</Workorder>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Workorder'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/html

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />