List Custom Status

Overview
Retrieve Work Order Custom Status List defined in work order settings of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/workOrder/customStatus/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 custom status 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="customStatusList"/>
      </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="customStatusList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="customStatus"/>
      </xs:sequence>
      <xs:attribute name="type" use="required" type="xs:NCName"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="customStatus">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="name"/>
        <xs:element ref="apiName"/>
        <xs:element ref="color"/>
        <xs:element ref="workOrderTypeId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="color" type="xs:string"/>
  <xs:element name="workOrderTypeId" 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/customStatus/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <customStatusList type="WorkOrder"> <customStatus> <name>Scheduled</name> <apiName>Atcustomersite</apiName> <color>#8a32df</color> <workOrderTypeId>0</workOrderTypeId> </customStatus> <customStatus> <name>In Transit</name> <apiName>Installingpart</apiName> <color>#f5a900</color> <workOrderTypeId>0</workOrderTypeId> </customStatus> <customStatus> <name>In Progress</name> <apiName>AcceptedInProgress</apiName> <color>#00aeef</color> <workOrderTypeId>0</workOrderTypeId> </customStatus> <customStatus> <name>Completed</name> <apiName>Completed</apiName> <color>#659ba7</color> <workOrderTypeId>0</workOrderTypeId> </customStatus> <customStatus> <name>Picked up</name> <apiName>LoadingCompleted</apiName> <color>null</color> <workOrderTypeId>0</workOrderTypeId> </customStatus> <customStatus> <name>Delivered</name> <apiName>SpecialPackageLoading</apiName> <color>#6dad00</color> <workOrderTypeId>0</workOrderTypeId> </customStatus> <customStatus> <name>Reschedule</name> <apiName>NotDelivered</apiName> <color>#dc1000</color> <workOrderTypeId>0</workOrderTypeId> </customStatus> <customStatus> <name>Waiting For PickUp</name> <apiName>newstatus2</apiName> <color></color> <workOrderTypeId>0</workOrderTypeId> </customStatus> </categoryList> </response>