POST api/backoffice/v{version}/workordereventtypes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

WorkOrderEventType
NameDescriptionTypeAdditional information
id

integer

None.

code

string

None.

require_image

integer

None.

require_name

integer

None.

require_note

integer

None.

require_signature

integer

None.

require_document

integer

None.

require_options

integer

None.

signature_message

string

None.

require_items_edit

integer

None.

require_driver_confirmation

integer

None.

geofence_radius

integer

None.

driver_confirm_message

string

None.

generic_errormessage

string

None.

generic_regex

string

None.

generic_question

string

None.

options_question

string

None.

require_generic

integer

None.

status_id

integer

None.

company_id

integer

None.

system

integer

None.

system_view

integer

None.

system_received

integer

None.

workorder_required_fields

integer

None.

allow_after_complete

integer

None.

allow_item_select

integer

None.

affect_workorder_status

integer

None.

item_status

ItemStatusChange

None.

exclude_item_statuses

string

None.

updated_at

string

None.

created_at

string

None.

deleted_at

string

None.

require_input_if_not_scanned

integer

None.

event_type_options

WorkorderEventtypeOptionList

None.

screen_after_complete

string

None.

remove_no_one_to_sign

integer

None.

company

Company

None.

status

Status

None.

GeofenceEnabled

boolean

None.

HasEnabledOptions

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "code": "sample string 2",
  "require_image": 3,
  "require_name": 4,
  "require_note": 5,
  "require_signature": 6,
  "require_document": 7,
  "require_options": 8,
  "signature_message": "sample string 9",
  "require_items_edit": 10,
  "require_driver_confirmation": 11,
  "geofence_radius": 12,
  "driver_confirm_message": "sample string 13",
  "generic_errormessage": "sample string 14",
  "generic_regex": "sample string 15",
  "generic_question": "sample string 16",
  "options_question": "sample string 17",
  "require_generic": 18,
  "status_id": 19,
  "company_id": 20,
  "system": 21,
  "system_view": 22,
  "system_received": 23,
  "workorder_required_fields": 24,
  "allow_after_complete": 25,
  "allow_item_select": 26,
  "affect_workorder_status": 27,
  "item_status": 0,
  "exclude_item_statuses": "sample string 28",
  "updated_at": "sample string 29",
  "created_at": "sample string 30",
  "deleted_at": "sample string 31",
  "require_input_if_not_scanned": 32,
  "event_type_options": {
    "options": [
      {
        "id": 1,
        "option": "sample string 2",
        "event_type_id": 3,
        "enabled": 4,
        "order": 5
      },
      {
        "id": 1,
        "option": "sample string 2",
        "event_type_id": 3,
        "enabled": 4,
        "order": 5
      }
    ]
  },
  "screen_after_complete": "sample string 33",
  "remove_no_one_to_sign": 34,
  "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
    ]
  },
  "GeofenceEnabled": true,
  "HasEnabledOptions": false
}

text/html

Sample:
{"id":1,"code":"sample string 2","require_image":3,"require_name":4,"require_note":5,"require_signature":6,"require_document":7,"require_options":8,"signature_message":"sample string 9","require_items_edit":10,"require_driver_confirmation":11,"geofence_radius":12,"driver_confirm_message":"sample string 13","generic_errormessage":"sample string 14","generic_regex":"sample string 15","generic_question":"sample string 16","options_question":"sample string 17","require_generic":18,"status_id":19,"company_id":20,"system":21,"system_view":22,"system_received":23,"workorder_required_fields":24,"allow_after_complete":25,"allow_item_select":26,"affect_workorder_status":27,"item_status":0,"exclude_item_statuses":"sample string 28","updated_at":"sample string 29","created_at":"sample string 30","deleted_at":"sample string 31","require_input_if_not_scanned":32,"event_type_options":{"options":[{"id":1,"option":"sample string 2","event_type_id":3,"enabled":4,"order":5},{"id":1,"option":"sample string 2","event_type_id":3,"enabled":4,"order":5}]},"screen_after_complete":"sample string 33","remove_no_one_to_sign":34,"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]},"GeofenceEnabled":true,"HasEnabledOptions":false}

application/xml, text/xml

Sample:
<WorkOrderEventType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DispatchITV2.Models.Data">
  <affect_workorder_status>27</affect_workorder_status>
  <allow_after_complete>25</allow_after_complete>
  <allow_item_select>26</allow_item_select>
  <code>sample string 2</code>
  <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>20</company_id>
  <created_at>sample string 30</created_at>
  <deleted_at>sample string 31</deleted_at>
  <driver_confirm_message>sample string 13</driver_confirm_message>
  <event_type_options>
    <options>
      <WorkorderEventtypeOption>
        <enabled>4</enabled>
        <event_type_id>3</event_type_id>
        <id>1</id>
        <option>sample string 2</option>
        <order>5</order>
      </WorkorderEventtypeOption>
      <WorkorderEventtypeOption>
        <enabled>4</enabled>
        <event_type_id>3</event_type_id>
        <id>1</id>
        <option>sample string 2</option>
        <order>5</order>
      </WorkorderEventtypeOption>
    </options>
  </event_type_options>
  <exclude_item_statuses>sample string 28</exclude_item_statuses>
  <generic_errormessage>sample string 14</generic_errormessage>
  <generic_question>sample string 16</generic_question>
  <generic_regex>sample string 15</generic_regex>
  <geofence_radius>12</geofence_radius>
  <id>1</id>
  <item_status>None</item_status>
  <options_question>sample string 17</options_question>
  <remove_no_one_to_sign>34</remove_no_one_to_sign>
  <require_document>7</require_document>
  <require_driver_confirmation>11</require_driver_confirmation>
  <require_generic>18</require_generic>
  <require_image>3</require_image>
  <require_input_if_not_scanned>32</require_input_if_not_scanned>
  <require_items_edit>10</require_items_edit>
  <require_name>4</require_name>
  <require_note>5</require_note>
  <require_options>8</require_options>
  <require_signature>6</require_signature>
  <screen_after_complete>sample string 33</screen_after_complete>
  <signature_message>sample string 9</signature_message>
  <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>19</status_id>
  <system>21</system>
  <system_received>23</system_received>
  <system_view>22</system_view>
  <updated_at>sample string 29</updated_at>
  <workorder_required_fields>24</workorder_required_fields>
</WorkOrderEventType>

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 'WorkOrderEventType'.

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/" />