View Work Order

Overview
Retrieve a Work Order's information of the client

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

Arguments

token required	Part of URL as a request parameter and is required in every call to verify access to API calls
workOrderId required	The identifier of the work order to be retrieved
userId optional	If provided, this User ID will be taken as a logged in user

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="status"/>
          <xs:element ref="location"/>
          <xs:element ref="createdDate"/>
          <xs:element ref="customFields"/>
          <xs:element ref="mobiForms"/>
          <xs:element ref="assetList"/>
        </xs:sequence>
        <xs:element minOccurs="0" ref="id"/>
      </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="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="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="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="customStatus" type="xs:NCName"/>
  <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="externalId" type="xs:string"/>
  <xs:element name="description" type="xs:string"/>
  <xs:element name="status" type="xs:string"/>
  <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 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/3200090/view.html?token=COJL8X2FKSLMMRTYCH2B"
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <workOrder> <mobiworkWorkOrderId>3200090</mobiworkWorkOrderId> <externalId></externalId> <customerId>18614</customerId> <customerName>herve rivere</customerName> <description>yrdyhsfd dfshfdsfhds</description> <workOrderTypeId>2415</workOrderTypeId> <workOrderType>EstimateQuote</workOrderType> <status>ASSIGNED</status> <customStatusId>600</customStatusId> <customStatus>Atcustomersite</customStatus> <location> <addressId>36180</addressId> <address1>4972 garden drive</address1> <address2></address2> <city>delray beach</city> <state>Florida</state> <zipCode>33445</zipCode> <countryId>1</countryId> <latitude>26.431517</latitude> <longitude>-80.120069</longitude> <name>Primary Address</name> <baseDistance>9024759</baseDistance> </location> <createdDate>Wed Aug 24 12:22:52 EDT 2016</createdDate> <customFields> <customField> <fieldType>1</fieldType> <apiName>AnewField</apiName> <value></value> <name>A new Field</name> </customField> </customFields> <mobiForms> <mobiForm> <filledFormId>0</filledFormId> <name>GV Panel Form Order</name> <apiName>GVPanelFormOrder</apiName> <pdfUrl>http://www.mobiwork.com/internal/forms/8516/filledForm/0/pdfView.html?token=qx%2FriLnGbkSd1JT4OxGX%2BDzB6rHu1Duk78JLNjY0BSs%3D</pdfUrl> <createdDate></createdDate> <formFields> <formField> <fieldType>6</fieldType> <apiName>PlaceVisited</apiName> <value></value> <name>Place Visited</name> </formField> <formField> <fieldType>26</fieldType> <apiName>SelecttheParts</apiName> <name>Select the Parts</name> </formField> <formField> <fieldType>26</fieldType> <apiName>SelecttheParts</apiName> <value></value> <name>Select the Parts</name> </formField> <formField> <fieldType>1</fieldType> <apiName>SelectTeam</apiName> <value></value> <name>Select Team</name> </formField> <formField> <fieldType>1</fieldType> <apiName>Observations</apiName> <value></value> <name>Observations</name> </formField> <formField> <fieldType>1</fieldType> <apiName>SelectTeam1</apiName> <value></value> <name>Select Team</name> </formField> <formField> <fieldType>1</fieldType> <apiName>RepairDetails</apiName> <value></value> <name>Repair Details</name> </formField> <formField> <fieldType>1</fieldType> <apiName>Reasonnottovisit</apiName> <value></value> <name>Reason not to visit</name> </formField> <formField> <fieldType>1</fieldType> <apiName>Observations1</apiName> <value></value> <name>Observations</name> </formField> <formField> <fieldType>1</fieldType> <apiName>Datenextvisit</apiName> <value></value> <name>Date next visit</name> </formField> <formField> <fieldType>6</fieldType> <apiName>VisitType</apiName> <value></value> <name>Visit Type</name> </formField> <formField> <fieldType>6</fieldType> <apiName>SparePartsUsed</apiName> <value></value> <name>Spare Parts Used?</name> </formField> </formFields> </mobiForm> </mobiForms> <scheduleList> <schedule> <userId>34445</userId> <date>2016/09/20</date> <duration>60</duration> </schedule> <schedule> <userId>34445</userId> <date>2016/09/21</date> <duration>60</duration> </schedule> <schedule> <userId>34445</userId> <date>2016/09/22</date> <duration>60</duration> </schedule> </scheduleList> <timeTrackingList></timeTrackingList> <timeTrackingList></timeTrackingList> <timeTrackingList></timeTrackingList> </workOrder> </response>