List Work Order Types

Overview
Retrieve Work Order Types defined in work order settings of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/workOrder/type/list.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID

Return
Returns a list of work order types defined in work order settings if valid arguments are provided. Returns an error if not a valid request

Request Body XSD
None

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="workOrderTypeList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="workOrderTypeList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="workOrderType"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="workOrderType">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="workOrderTypeId"/>
        <xs:element ref="name"/>
        <xs:element ref="apiName"/>
        <xs:element ref="description"/>
        <xs:element ref="biddable"/>
        <xs:element ref="defaultWorkOrderDuration"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="workOrderTypeId" type="xs:integer"/>
  <xs:element name="name" type="xs:NCName"/>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="description" type="xs:string"/>
  <xs:element name="biddable" type="xs:boolean"/>
  <xs:element name="defaultWorkOrderDuration" type="xs:integer"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/workOrder/type/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <workOrderTypeList> <workOrderType> <workOrderTypeId>2415</workOrderTypeId> <name>Estimate/Quote</name> <apiName>EstimateQuote</apiName> <description>Estimate or Quote</description> <biddable>true</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>2341</workOrderTypeId> <name>General Service</name> <apiName>GeneralService</apiName> <description>Service call for misc issues</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>2153</workOrderTypeId> <name>Inspection</name> <apiName>Inspection</apiName> <description>Inspection</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>81</workOrderTypeId> <name>Repair </name> <apiName>null</apiName> <description>Repair </description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>68</workOrderTypeId> <name>Installation</name> <apiName>null</apiName> <description>Installation</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>67</workOrderTypeId> <name>Maintenance</name> <apiName>null</apiName> <description>Maintenance</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>115</workOrderTypeId> <name>Delivery</name> <apiName>Delivery</apiName> <description>USPS demo</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>1964</workOrderTypeId> <name>Le special</name> <apiName>Lespecial</apiName> <description>The new service available</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>2044</workOrderTypeId> <name>Asset Repair</name> <apiName>AssetRepair</apiName> <description>Asset Repair</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>2363</workOrderTypeId> <name>Pick up</name> <apiName>PickupWoType</apiName> <description>Pick up workOrder</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> <workOrderType> <workOrderTypeId>2364</workOrderTypeId> <name>Drop Off</name> <apiName>DropOffWoType</apiName> <description>Pick up workOrder</description> <biddable>false</biddable> <defaultWorkOrderDuration>-1</defaultWorkOrderDuration> </workOrderType> </workOrderTypeList> </response>