View Work Order By ExternalId

Overview
Retrieve a work order by it's externalid.

URL Format
https://{domain}/api/rest/{clientId}/{versionNumber}/workOrder/view.html?token=XXXXXXXX&userId={userId}&externalId={externalId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: {0}
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
externalId required	Specified in URL as a parameter, is the ExternalID of the project to be retrieved
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 Work Order Object 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="workOrder"/>
      </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="workOrder">
    <xs:complexType>
      <xs:sequence>
        <xs:sequence minOccurs="0">
          <xs:element ref="mobiworkWorkOrderId"/>
          <xs:element ref="externalId"/>
          <xs:element ref="customerId"/>
          <xs:element ref="customerName"/>
          <xs:element ref="description"/>
          <xs:element ref="workOrderTypeId"/>
          <xs:element ref="workOrderType"/>
          <xs:element ref="status"/>
          <xs:element ref="customStatusId"/>
          <xs:element ref="customStatus"/>
          <xs:element ref="location"/>
          <xs:element ref="createdDate"/>
          <xs:element ref="closedDate"/>
          <xs:element ref="customFields"/>
          <xs:element ref="mobiForms"/>
          <xs:element ref="actionItemList"/>
          <xs:element ref="assetList"/>
        </xs:sequence>
        <xs:choice>
          <xs:element ref="id"/>
          <xs:element ref="statusEventList"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkWorkOrderId" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="customerName" type="xs:string"/>
  <xs:element name="workOrderTypeId" type="xs:integer"/>
  <xs:element name="workOrderType" type="xs:NCName"/>
  <xs:element name="customStatusId" type="xs:integer"/>
  <xs:element name="location">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="addressId"/>
        <xs:element ref="address1"/>
        <xs:element ref="address2"/>
        <xs:element ref="city"/>
        <xs:element ref="state"/>
        <xs:element ref="zipCode"/>
        <xs:element ref="countryId"/>
        <xs:element ref="latitude"/>
        <xs:element ref="longitude"/>
        <xs:element ref="name"/>
        <xs:element ref="baseDistance"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="addressId" type="xs:integer"/>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="address2">
    <xs:complexType/>
  </xs:element>
  <xs:element name="city" type="xs:string"/>
  <xs:element name="state" type="xs:NCName"/>
  <xs:element name="zipCode" type="xs:integer"/>
  <xs:element name="countryId" type="xs:integer"/>
  <xs:element name="latitude" type="xs:decimal"/>
  <xs:element name="longitude" type="xs:decimal"/>
  <xs:element name="baseDistance" type="xs:integer"/>
  <xs:element name="closedDate" type="xs:string"/>
  <xs:element name="mobiForms">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="mobiForm"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiForm">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="filledFormId"/>
        <xs:element ref="name"/>
        <xs:element ref="apiName"/>
        <xs:element ref="pdfUrl"/>
        <xs:element ref="status"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="createdByUserName"/>
        <xs:element ref="createdBy"/>
        <xs:element ref="formFields"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="filledFormId" type="xs:integer"/>
  <xs:element name="pdfUrl" type="xs:anyURI"/>
  <xs:element name="createdByUserName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="createdBy" type="xs:NCName"/>
  <xs:element name="formFields">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="formField"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="formField">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="fieldType"/>
        <xs:element ref="apiName"/>
        <xs:element ref="index"/>
        <xs:element ref="name"/>
        <xs:element ref="value"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="actionItemList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="actionItem"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="actionItem">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="description"/>
        <xs:element ref="status"/>
        <xs:element ref="type"/>
        <xs:element ref="externalId"/>
        <xs:element minOccurs="0" ref="mobiFormId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="type" type="xs:NCName"/>
  <xs:element name="mobiFormId" type="xs:integer"/>
  <xs:element name="assetList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="asset"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="asset">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkAssetId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="name"/>
        <xs:element ref="description"/>
        <xs:element ref="modelNumber"/>
        <xs:element ref="serialNumber"/>
        <xs:element ref="manufacturer"/>
        <xs:element ref="tag"/>
        <xs:element ref="beacon"/>
        <xs:element ref="rfid"/>
        <xs:element ref="barcode"/>
        <xs:element ref="sku"/>
        <xs:sequence minOccurs="0">
          <xs:element ref="customStatus"/>
          <xs:element ref="categoryId"/>
          <xs:element ref="category"/>
        </xs:sequence>
        <xs:element ref="customFields"/>
        <xs:element ref="status"/>
        <xs:element ref="enabled"/>
        <xs:element minOccurs="0" ref="workOrders"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkAssetId" type="xs:integer"/>
  <xs:element name="modelNumber" type="xs:string"/>
  <xs:element name="serialNumber" type="xs:NMTOKEN"/>
  <xs:element name="manufacturer">
    <xs:complexType/>
  </xs:element>
  <xs:element name="tag" type="xs:string"/>
  <xs:element name="beacon" type="xs:NCName"/>
  <xs:element name="rfid" type="xs:NCName"/>
  <xs:element name="barcode">
    <xs:complexType/>
  </xs:element>
  <xs:element name="sku" type="xs:string"/>
  <xs:element name="categoryId" type="xs:integer"/>
  <xs:element name="category" type="xs:string"/>
  <xs:element name="enabled" type="xs:boolean"/>
  <xs:element name="workOrders">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="workOrder"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="id" type="xs:integer"/>
  <xs:element name="statusEventList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="statusEvent"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="statusEvent">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="status"/>
        <xs:element ref="statusChange"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="statusChange">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="changeTime"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="changeTime" type="xs:string"/>
  <xs:element name="externalId" type="xs:string"/>
  <xs:element name="description" type="xs:string"/>
  <xs:element name="status">
    <xs:complexType mixed="true">
      <xs:choice minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="apiName"/>
        <xs:element ref="name"/>
      </xs:choice>
    </xs:complexType>
  </xs:element>
  <xs:element name="customStatus" type="xs:NCName"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="customFields">
    <xs:complexType>
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" ref="customField"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customField">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="fieldType"/>
        <xs:element ref="apiName"/>
        <xs:element minOccurs="0" ref="index"/>
        <xs:element ref="value"/>
        <xs:element ref="name"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="fieldType" type="xs:integer"/>
  <xs:element name="index" type="xs:integer"/>
  <xs:element name="value" type="xs:string"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/workOrder/view.html?token=COJL8X2FKSLMMRTYCH2B&externalId=AA-WO10001"
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <workOrder> <mobiworkWorkOrderId>15795734</mobiworkWorkOrderId> <externalId>AA-WO10001</externalId> <customerId>3457808</customerId> <customerName>Testing Company 33334</customerName> <description>You shouldnt see this from other user</description> <workOrderTypeId>28948</workOrderTypeId> <workOrderType>Maintenance</workOrderType> <status>ASSIGNED</status> <customStatusId>29078</customStatusId> <customStatus>Dispatched</customStatus> <location> <addressId>753283</addressId> <address1>160 Congress Park Drive</address1> <address2></address2> <city>Delray Beach</city> <state>FL</state> <zipCode>33445</zipCode> <countryId>1</countryId> <latitude>26.4582132</latitude> <longitude>-80.09405019999997</longitude> <name>Mobiwork HQ</name> <baseDistance>9022407</baseDistance> </location> <createdDate>2021/04/29 11:27:30</createdDate> <closedDate>2021/04/30 14:34:30</closedDate> <customFields> <customField> <fieldType>1</fieldType> <apiName>TestingField</apiName> <value></value> <name>Testing Field</name> </customField> </customFields> <mobiForms> <mobiForm> <filledFormId>0</filledFormId> <name>Work To Perform</name> <apiName>WorkToPerform</apiName> <pdfUrl>http://platform.mobiwork.com/internal/forms/56926/filledForm/0/pdfView.html?token=RqCAi7cxuqPcHeWU4JF0nIpxYRz8PSwdEtraIubGTJo8aUEK9E9eBQ%3D%3D</pdfUrl> <status></status> <createdDate></createdDate> <createdByUserName></createdByUserName> <createdBy>null</createdBy> <formFields> <formField> <fieldType>18</fieldType> <apiName>Description</apiName> <index>0</index> <name>Description</name> <value></value> </formField> <formField> <fieldType>25</fieldType> <apiName>Pictures</apiName> <index>0</index> <name>Picture</name> <value>null</value> </formField> <formField> <fieldType>8</fieldType> <apiName>Signature</apiName> <index>0</index> <name>Signature</name> <value></value> </formField> </formFields> </mobiForm> <mobiForm> <filledFormId>0</filledFormId> <name>Completion Form</name> <apiName>CompletionForm</apiName> <pdfUrl>http://platform.mobiwork.com/internal/forms/56927/filledForm/0/pdfView.html?token=DWcN9XYss1vcHeWU4JF0nN8GAtt01YR8EtraIubGTJo8aUEK9E9eBQ%3D%3D</pdfUrl> <status></status> <createdDate></createdDate> <createdByUserName></createdByUserName> <createdBy>null</createdBy> <formFields> <formField> <fieldType>18</fieldType> <apiName>Comments</apiName> <index>0</index> <name>Comments</name> <value></value> </formField> <formField> <fieldType>25</fieldType> <apiName>Pictures</apiName> <index>0</index> <name>Picture</name> <value>null</value> </formField> <formField> <fieldType>8</fieldType> <apiName>Signature</apiName> <index>0</index> <name>Signature</name> <value></value> </formField> </formFields> </mobiForm> </mobiForms> <actionItemList> <actionItem> <description>In Transit</description> <status>OPEN</status> <type>CHECK_IN</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Turn-by-turn Navigation</description> <status>OPEN</status> <type>NAVIGATION</type> <externalId>null</externalId> </actionItem> <actionItem> <description>On Site</description> <status>OPEN</status> <type>CHECK_IN</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Work To Perform</description> <status>OPEN</status> <type>FILL_WORK_ORDER_FORM</type> <externalId>null</externalId> <mobiFormId>56926</mobiFormId> </actionItem> <actionItem> <description>Options</description> <status>OPEN</status> <type>ACTION_ITEM_GROUP</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Missing Parts</description> <status>OPEN</status> <type>CREATE_PURCHASE_REQUEST</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Expense</description> <status>OPEN</status> <type>ADD_EXPENSE</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Estimate</description> <status>OPEN</status> <type>CREATE_ESTIMATE</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Sales Order</description> <status>OPEN</status> <type>CREATE_SALES_ORDER</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Time Tracking</description> <status>OPEN</status> <type>TIME_TRACKING</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Crew Time Tracking</description> <status>OPEN</status> <type>CREW_TIMETRACKING</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Completion Form</description> <status>OPEN</status> <type>FILL_WORK_ORDER_FORM</type> <externalId>null</externalId> <mobiFormId>56927</mobiFormId> </actionItem> <actionItem> <description>Invoice</description> <status>OPEN</status> <type>INVOICE</type> <externalId>null</externalId> </actionItem> <actionItem> <description>Close Work Order</description> <status>OPEN</status> <type>CLOSE_WORK_ORDER</type> <externalId>null</externalId> </actionItem> </actionItemList> <assetList> <asset> <mobiworkAssetId>56951</mobiworkAssetId> <externalId></externalId> <name>127-BSC</name> <description>127-BSC SINGLE USE SN FOR PT CATHERINE OSBORN LOT#10816020006</description> <modelNumber>10816020006</modelNumber> <serialNumber>127-BSC</serialNumber> <manufacturer></manufacturer> <tag>127-BSC</tag> <beacon>null</beacon> <rfid>null</rfid> <barcode></barcode> <sku>10816020006</sku> <customStatus>ACTIVE</customStatus> <categoryId>871</categoryId> <category>Commodes and Bath Safety</category> <customFields> <customField> <fieldType>3</fieldType> <apiName>LastServiceDate</apiName> <index>0</index> <value></value> <name>Last Service Date</name> </customField> <customField> <fieldType>3</fieldType> <apiName>PmDate</apiName> <index>0</index> <value></value> <name>Pm Date</name> </customField> <customField> <fieldType>6</fieldType> <apiName>RateType</apiName> <index>0</index> <value></value> <name>Rate Type</name> </customField> <customField> <fieldType>2</fieldType> <apiName>BillingRate</apiName> <index>0</index> <value>0</value> <name>Billing Rate</name> </customField> </customFields> <status>green</status> <enabled>false</enabled> </asset> <asset> <mobiworkAssetId>638200</mobiworkAssetId> <externalId></externalId> <name>Asset Rest API ADDWO 1</name> <description>Asset Rest API ADDWO 1</description> <modelNumber></modelNumber> <serialNumber>11111111</serialNumber> <manufacturer></manufacturer> <tag></tag> <beacon>null</beacon> <rfid>null</rfid> <barcode></barcode> <sku></sku> <customFields></customFields> <status>green</status> <enabled>true</enabled> <workOrders> <workOrder> <id>15795734</id> </workOrder> <workOrder> <id>15795756</id> </workOrder> <workOrder> <id>15795757</id> </workOrder> <workOrder> <id>15796360</id> </workOrder> <workOrder> <id>15796364</id> </workOrder> <workOrder> <id>15796883</id> </workOrder> <workOrder> <id>15796886</id> </workOrder> <workOrder> <id>15796887</id> </workOrder> <workOrder> <id>15796900</id> </workOrder> <workOrder> <id>15818321</id> </workOrder> <workOrder> <id>15818322</id> </workOrder> <workOrder> <id>15818323</id> </workOrder> <workOrder> <id>15818324</id> </workOrder> <workOrder> <id>15818330</id> </workOrder> <workOrder> <id>15818331</id> </workOrder> <workOrder> <id>15823426</id> </workOrder> <workOrder> <id>15824266</id> </workOrder> <workOrder> <id>15828415</id> </workOrder> <workOrder> <id>15832963</id> </workOrder> <workOrder> <id>15833104</id> </workOrder> <workOrder> <id>15835453</id> </workOrder> <workOrder> <id>15835494</id> </workOrder> <workOrder> <id>15835631</id> </workOrder> <workOrder> <id>15835664</id> </workOrder> <workOrder> <id>15836225</id> </workOrder> <workOrder> <id>15836226</id> </workOrder> <workOrder> <id>15836238</id> </workOrder> <workOrder> <id>15836788</id> </workOrder> <workOrder> <id>15836799</id> </workOrder> <workOrder> <id>15836808</id> </workOrder> <workOrder> <id>15837451</id> </workOrder> <workOrder> <id>15837463</id> </workOrder> <workOrder> <id>15837863</id> </workOrder> <workOrder> <id>15837865</id> </workOrder> <workOrder> <id>15837987</id> </workOrder> <workOrder> <id>15846435</id> </workOrder> <workOrder> <id>15846438</id> </workOrder> <workOrder> <id>15846440</id> </workOrder> <workOrder> <id>15846549</id> </workOrder> <workOrder> <id>15960120</id> </workOrder> <workOrder> <id>15961534</id> </workOrder> <workOrder> <id>15966812</id> </workOrder> <workOrder> <id>15966813</id> </workOrder> <workOrder> <id>15966816</id> </workOrder> <workOrder> <id>15966841</id> </workOrder> <workOrder> <id>15966842</id> </workOrder> <workOrder> <id>15966861</id> </workOrder> <workOrder> <id>15966937</id> </workOrder> <workOrder> <id>15966941</id> </workOrder> <workOrder> <id>15966979</id> </workOrder> <workOrder> <id>15966996</id> </workOrder> <workOrder> <id>15966998</id> </workOrder> <workOrder> <id>15967042</id> </workOrder> <workOrder> <id>15967121</id> </workOrder> </workOrders> </asset> </assetList> <statusEventList> <statusEvent> <status> <apiName>Open</apiName> <name>Open</name> </status> <statusChange> <changeTime>2021/04/30 09:36:23</changeTime> </statusChange> </statusEvent> <statusEvent> <status> <apiName>Scheduled</apiName> <name>Scheduled</name> </status> <statusChange> <changeTime>2021/04/29 15:15:00</changeTime> </statusChange> </statusEvent> <statusEvent> <status> <apiName>Dispatched</apiName> <name>Dispatched</name> </status> <statusChange> <changeTime>2021/04/30 16:30:38</changeTime> </statusChange> </statusEvent> <statusEvent> <status> <apiName>Atcustomersite</apiName> <name>Atcustomersite</name> </status> <statusChange> <changeTime>2021/04/29 11:27:30</changeTime> </statusChange> </statusEvent> <statusEvent> <status> <apiName>Closed</apiName> <name>Completed</name> </status> <statusChange> <changeTime>2021/04/30 09:36:10</changeTime> </statusChange> </statusEvent> </statusEventList> </workOrder> </response>