Add Work Order

Overview
Creates a Work Order in MobiWork

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/workOrder/add.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 Work Order Object if work order creation is successful or errors will be returned

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="workOrder">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="externalId" minOccurs="0"/>
        <xs:element ref="customerId"/>
        <xs:element ref="customerName"/>
        <xs:element ref="description "minOccurs="0"/>
        <xs:element ref="workOrderTypeId" minOccurs="0"/>
        <xs:element ref="workOrderTypeName" minOccurs="0"/>
        <xs:element ref="assignedTo" minOccurs="0"/>
        <xs:element ref="apptDuration" minOccurs="0"/>
        <xs:element ref="projectId" minOccurs="0"/>
        <xs:element ref="projectName" minOccurs="0"/>
        <xs:element ref="workOrderNumber" minOccurs="0"/>
        <xs:element ref="status" minOccurs="0"/>
        <xs:element ref="customStatusId" minOccurs="0"/>
        <xs:element ref="customStatus" minOccurs="0"/>
        <xs:element ref="contact" minOccurs="0"/>
        <xs:element ref="location" minOccurs="0"/>
        <xs:element ref="assetList" minOccurs="0"/>
        <xs:element ref="scheduleList" minOccurs="0"/>
        <xs:element ref="genericEntityList" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customerId" type="xs:string"/>
  <xs:element name="customerName" type="xs:string"/>
  <xs:element name="workOrderTypeId" type="xs:integer"/>
  <xs:element name="workOrderTypeName" type="xs:NCName"/>
  <xs:element name="assignedTo" type="xs:string"/>
  <xs:element name="apptDuration" type="xs:integer"/>
  <xs:element name="projectId" type="xs:integer"/>
  <xs:element name="projectName" type="xs:string"/>
  <xs:element name="workOrderNumber" type="xs:integer"/>
  <xs:element name="status" type="xs:NCName"/>
  <xs:element name="customStatusId" type="xs:integer"/>
  <xs:element name="customStatus" type="xs:NCName"/>
  <xs:element name="contact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="title"/>
        <xs:element ref="email"/>
        <xs:element ref="phoneNumber"/>
        <xs:element ref="phoneExt"/>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="pin"/>
        <xs:element ref="enabled"/>
        <xs:element ref="fax"/>
        <xs:element ref="admin" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="firstName" type="xs:NCName"/>
  <xs:element name="lastName" type="xs:NCName"/>
  <xs:element name="title" type="xs:NCName" minOccurs="0"/>
  <xs:element name="email" type="xs:string" minOccurs="0"/>
  <xs:element name="phoneNumber" type="xs:integer"/>
  <xs:element name="phoneExt" type="xs:integer" minOccurs="0"/>
  <xs:element name="altPhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="pin" type="xs:integer"/>
  <xs:element name="fax" type="xs:integer"/>
  <xs:element name="admin" type="xs:boolean"/>
  <xs:element name="location">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="address"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="address">
    <xs:complexType>
      <xs:sequence>
        <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:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="address2" type="xs:string" minOccurs="0"/>
  <xs:element name="city" type="xs:string" minOccurs="0"/>
  <xs:element name="state" type="xs:NCName" minOccurs="0"/>
  <xs:element name="zipCode" type="xs:integer" minOccurs="0"/>
  <xs:element name="countryId" type="xs:integer" minOccurs="0"/>
  <xs:element name="latitude" type="xs:decimal" minOccurs="0"/>
  <xs:element name="longitude" type="xs:decimal" minOccurs="0"/>
  <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" minOccurs="0"/>
        <xs:element ref="externalId" minOccurs="0"/>
        <xs:element ref="name" minOccurs="0"/>
        <xs:element ref="description" minOccurs="0"/>
        <xs:element ref="modelNumber" minOccurs="0"/>
        <xs:element ref="serialNumber"/>
        <xs:element ref="categoryId" minOccurs="0"/>
        <xs:element ref="category" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkAssetId" type="xs:string"/>
  <xs:element name="modelNumber" type="xs:NMTOKEN"/>
  <xs:element name="serialNumber" type="xs:integer"/>
  <xs:element name="category" type="xs:NCName"/>
  <xs:element name="scheduleList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="schedule"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="schedule">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="time"/>
        <xs:element ref="date"/>
        <xs:element ref="userId"/>
        <xs:element ref="userName"/>
        <xs:element ref="duration"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="time" type="xs:NMTOKEN" minOccurs="0"/>
  <xs:element name="date" type="xs:string"/>
  <xs:element name="userId" type="xs:string" minOccurs="0"/>
  <xs:element name="userName" type="xs:NCName" minOccurs="0"/>
  <xs:element name="duration" type="xs:integer" minOccurs="0"/>
  <xs:element name="genericEntityList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="genericEntity"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="genericEntity">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="genericEntityId"/>
        <xs:element ref="genericEntityOptionId"/>
        <xs:element ref="entityTag"/>
        <xs:element ref="integrationStatus"/>
        <xs:element ref="entityId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="name"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="createdById"/>
        <xs:element ref="createdByName"/>
        <xs:element ref="statusId"/>
        <xs:element ref="statusName"/>
        <xs:element ref="categoryId"/>
        <xs:element ref="categoryName"/>
        <xs:element ref="enabled"/>
        <xs:element ref="userList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="genericEntityId" type="xs:integer" minOccurs="0"/>
  <xs:element name="genericEntityOptionId" type="xs:integer" minOccurs="0"/>
  <xs:element name="entityTag" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="integrationStatus" type="xs:NCName" minOccurs="0"/>
  <xs:element name="entityId" type="xs:integer" minOccurs="0"/>
  <xs:element name="createdDate" type="xs:string" minOccurs="0"/>
  <xs:element name="createdById" type="xs:integer" minOccurs="0"/>
  <xs:element name="createdByName" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="statusId" type="xs:integer" minOccurs="0"/>
  <xs:element name="statusName" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="categoryName" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="userList" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="externalId" type="xs:NCName" minOccurs="0"/>
  <xs:element name="description" type="xs:string" minOccurs="0"/>
  <xs:element name="enabled" type="xs:boolean" minOccurs="0"/>
  <xs:element name="name" type="xs:string" minOccurs="0"/>
  <xs:element name="categoryId" type="xs:string" minOccurs="0"/>
</xs:schema>

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: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="genericEntityList"/>
        <xs:element ref="statusEventList"/>
      </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="description" 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="customStatus" type="xs:NCName"/>
  <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:NCName"/>
  <xs:element name="address2">
    <xs:complexType/>
  </xs:element>
  <xs:element name="city" type="xs:NCName"/>
  <xs:element name="state" type="xs:string"/>
  <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="genericEntityList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="genericEntity"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="genericEntity">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="genericEntityId"/>
        <xs:element ref="genericEntityOptionId"/>
        <xs:element ref="entityTag"/>
        <xs:element ref="integrationStatus"/>
        <xs:element ref="entityId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="name"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="createdById"/>
        <xs:element ref="createdByName"/>
        <xs:element ref="statusId"/>
        <xs:element ref="statusName"/>
        <xs:element ref="categoryId"/>
        <xs:element ref="categoryName"/>
        <xs:element ref="enabled"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="genericEntityId" type="xs:integer"/>
  <xs:element name="genericEntityOptionId" type="xs:integer"/>
  <xs:element name="entityTag">
    <xs:complexType/>
  </xs:element>
  <xs:element name="integrationStatus">
    <xs:complexType/>
  </xs:element>
  <xs:element name="entityId" type="xs:integer"/>
  <xs:element name="createdById" type="xs:integer"/>
  <xs:element name="createdByName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="statusId" type="xs:integer"/>
  <xs:element name="statusName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="categoryId" type="xs:integer"/>
  <xs:element name="categoryName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="enabled" type="xs:boolean"/>
  <xs:element name="statusEventList">
    <xs:complexType>
      <xs:sequence>
        <xs:element 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:NCName"/>
  <xs:element name="status">
    <xs:complexType mixed="true">
      <xs:choice minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="name"/>
        <xs:element ref="apiName"/>
      </xs:choice>
    </xs:complexType>
  </xs:element>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="createdDate" type="xs:string"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/workOrder/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<workOrder> <externalId>AA-WO10001</externalId> <customerId>456300</customerId> <customerName>Mobiwork - Construction</customerName> <description>Add WO API add asset 1</description> <workOrderTypeId>2573</workOrderTypeId> <workOrderType>Repair</workOrderType> <workOrderNumber></workOrderNumber> <status>OPEN</status> <customStatusId>1617</customStatusId> <customStatus>Scheduled</customStatus> <location> <addressId>753283</addressId> <address1>160 Congress park drive</address1> <address2></address2> <city>Delray Beach</city> <state>Florida</state> <zipCode>33445</zipCode> <countryId>1</countryId> <latitude>26.4582132</latitude> <longitude>-80.09405019999997</longitude> <name>Mobiwork HQ</name> <baseDistance>9022407</baseDistance> </location> <assetList> <asset> <mobiworkAssetId>56951</mobiworkAssetId> <externalId>API4444</externalId> <name>Asset Rest API 4</name> <description>Asset Rest API 4</description> <modelNumber>44444444444</modelNumber> <serialNumber>111114444444</serialNumber> <categoryId>5020</categoryId> <category>Vehicle</category> </asset> <asset> <mobiworkAssetId></mobiworkAssetId> <externalId>APIWO-ADD1</externalId> <name>Asset Rest API ADDWO 1</name> <description>Asset Rest API ADDWO 1</description> <modelNumber>WO111111</modelNumber> <serialNumber>11111111</serialNumber> <categoryId></categoryId> <category>Rest</category> </asset> </assetList> </workOrder>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="1.0.0" statusCode="1"> <workOrder> <mobiworkWorkOrderId>3218924</mobiworkWorkOrderId> <externalId>AA-WO10001</externalId> <customerId>456300</customerId> <customerName>Mobiwork - Construction</customerName> <description></description> <workOrderNumber></workOrderNumber> <customStatusId>1617</customStatusId> <customStatus>Scheduled</customStatus> <location> <addressId>910512</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></name> <baseDistance>9022407</baseDistance> </location> <createdDate>2017/01/27 16:22:11</createdDate> <assetList> <asset> <mobiworkAssetId>56951</mobiworkAssetId> <externalId>API4444</externalId> <name>Asset Rest API 4</name> <description>Asset Rest API 4</description> <modelNumber>44444444444</modelNumber> <serialNumber>111114444444</serialNumber> <categoryId>5020</categoryId> <category>Vehicle</category> </asset> <asset> <mobiworkAssetId>56956</mobiworkAssetId> <externalId>null</externalId> <name>Asset Rest API ADDWO 1</name> <description>Asset Rest API ADDWO 1</description> <modelNumber>null</modelNumber> <serialNumber>11111111</serialNumber> </asset> </assetList> </workOrder> </response>