Add Customer

Overview
Creates a Customer in MobiWork

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/customer/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 successful message or errors will be returned Customer Object if customer 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="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customer"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customer">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="externalCustomerId"/>
        <xs:element ref="companyName"/>
        <xs:element ref="type" minOccurs="0"/>
        <xs:element ref="statusId" minOccurs="0"/>
        <xs:element ref="customStatus" minOccurs="0"/>
        <xs:element ref="enabled" minOccurs="0"/>
        <xs:element ref="assignedTo" minOccurs="0"/>
        <xs:element ref="address"/>
        <xs:element ref="contact"/>
        <xs:element ref="addressList"/>
        <xs:element ref="contactList"/>
        <xs:element ref="customFields"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="externalCustomerId" type="xs:integer" minOccurs="0"/>
  <xs:element name="companyName" type="xs:string"/>
  <xs:element name="type" type="xs:NCName" minOccurs="0"/>
  <xs:element name="statusId" type="xs:integer" minOccurs="0"/>
  <xs:element name="customStatus" type="xs:NCName" minOccurs="0"/>
  <xs:element name="assignedTo" type="xs:integer" minOccurs="0"/>
  <xs:element name="addressList">
    <xs:complexType>
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" ref="address"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="contactList">
    <xs:complexType>
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" ref="contact"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <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" minOccurs="0" maxOccurs="unbounded">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="fieldType"/>
        <xs:element ref="apiName"/>
        <xs:element ref="recordIndex"/>
        <xs:element ref="value"/>
        <xs:element ref="name"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="fieldType" type="xs:integer"/>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="recordIndex" type="xs:integer"/>
  <xs:element name="value" type="xs:string"/>
  <xs:element name="enabled" type="xs:NCName"/>
  <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="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="altPhoneNumber"/>
        <xs:element ref="officePhone"/>
        <xs:element ref="phoneExt"/>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="officePhoneExt"/>
        <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:string" minOccurs="0"/>
  <xs:element name="email" type="xs:string" minOccurs="0"/>
  <xs:element name="phoneNumber" type="xs:integer"/>
  <xs:element name="altPhoneNumber" type="xs:integer" minOccurs="0"/>
  <xs:element name="officePhone" type="xs:integer" minOccurs="0"/>
  <xs:element name="phoneExt" type="xs:integer" minOccurs="0"/>
  <xs:element name="altPhoneExt" type="xs:integer" minOccurs="0"/>
  <xs:element name="officePhoneExt" type="xs:integer" minOccurs="0"/>
  <xs:element name="fax" type="xs:integer" minOccurs="0"/>
  <xs:element name="admin" type="xs:boolean" minOccurs="0"/>
  <xs:element name="name" 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="customer"/>
      </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="customer">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkCustomerId"/>
        <xs:element ref="externalCustomerId"/>
        <xs:element ref="companyName"/>
        <xs:element ref="fromDate"/>
        <xs:element ref="type"/>
        <xs:element ref="statusId"/>
        <xs:element ref="enabled"/>
        <xs:element ref="assignedTo"/>
        <xs:element ref="address"/>
        <xs:element ref="contact"/>
        <xs:element ref="addressList"/>
        <xs:element ref="contactList"/>
        <xs:element ref="mobiForms"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkCustomerId" type="xs:integer"/>
  <xs:element name="externalCustomerId" type="xs:integer"/>
  <xs:element name="companyName" type="xs:string"/>
  <xs:element name="fromDate" type="xs:string"/>
  <xs:element name="type" type="xs:NCName"/>
  <xs:element name="statusId" type="xs:integer"/>
  <xs:element name="assignedTo">
    <xs:complexType/>
  </xs:element>
  <xs:element name="address">
    <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" type="xs:string"/>
  <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="name" type="xs:string"/>
  <xs:element name="baseDistance" type="xs:integer"/>
  <xs:element name="contact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="contactId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="title"/>
        <xs:element ref="email"/>
        <xs:element ref="phoneNumber"/>
        <xs:element ref="altPhoneNumber"/>
        <xs:element ref="phoneExt"/>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="officePhone"/>
        <xs:element ref="officePhoneExt"/>
        <xs:element ref="pin"/>
        <xs:element ref="enabled"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="fax"/>
        <xs:element ref="admin"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="contactId" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="firstName" type="xs:NCName"/>
  <xs:element name="lastName" type="xs:NCName"/>
  <xs:element name="title" type="xs:NCName"/>
  <xs:element name="email" type="xs:string"/>
  <xs:element name="phoneNumber" type="xs:integer"/>
  <xs:element name="altPhoneNumber" type="xs:integer"/>
  <xs:element name="phoneExt" type="xs:integer"/>
  <xs:element name="altPhoneExt" type="xs:integer"/>
  <xs:element name="officePhone" type="xs:integer"/>
  <xs:element name="officePhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="pin" type="xs:integer"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="fax" type="xs:integer"/>
  <xs:element name="admin" type="xs:boolean"/>
  <xs:element name="addressList">
    <xs:complexType/>
  </xs:element>
  <xs:element name="contactList">
    <xs:complexType/>
  </xs:element>
  <xs:element name="mobiForms">
    <xs:complexType/>
  </xs:element>
  <xs:element name="enabled" type="xs:boolean"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/customer/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request> <customer> <externalCustomerId>123456</externalCustomerId> <companyName>Test Company 8001</companyName> <type>BUSINESS</type> <statusId>771</statusId> <customStatus>Lead</customStatus> <enabled>TRUE</enabled> <address> <address1>160 Congress Park Dr</address1> <address2>Ste 205</address2> <city>Delray Beach</city> <state>FL</state> <countryId>0</countryId> </address> <contact> <firstName>John</firstName> <lastName>Doe</lastName> <title/> <email>jdoe@gmail.com</email> <phoneNumber>12345678901</phoneNumber> <phoneExt/> <altPhoneExt/> <pin>4549</pin> <enabled>true</enabled> <fax/> <admin>true</admin> </contact> <addressList> <address> <address1>160 Congress Park Dr</address1> <address2>Ste 205</address2> <city>Delray Beach</city> <state>FL</state> <countryId>0</countryId> </address> </addressList> <contactList> <contact> <firstName>John</firstName> <lastName>Doe</lastName> <title/> <email>jdoe@gmail.com</email> <phoneNumber>561111115</phoneNumber> <phoneExt/> <altPhoneExt/> <pin>4549</pin> <enabled>true</enabled> <admin>false</admin> </contact> </contactList> <customFields> <customField> <fieldType>1</fieldType> <apiName>Text</apiName> <index>0</index> <value/> <name>Text</name> </customField> <customField> <fieldType>1</fieldType> <apiName>Text2</apiName> <index>0</index> <value/> <name>Text2</name> </customField> <customField> <fieldType>1</fieldType> <apiName>Text3</apiName> <index>0</index> <value/> <name>Text3</name> </customField> <customField> <fieldType>3</fieldType> <apiName>Date</apiName> <index>0</index> <value/> <name>Date</name> </customField> </customFields> </customer> </request> '
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.156" statusCode="1"> <customer> <mobiworkCustomerId>1223587</mobiworkCustomerId> <externalCustomerId>123456</externalCustomerId> <companyName>Test Company 8001</companyName> <fromDate>09/17/2018</fromDate> <type>BUSINESS</type> <statusId>771</statusId> <enabled>true</enabled> <address> <addressId>1788006</addressId> <address1>160 Congress Park Dr</address1> <address2>Ste 205</address2> <city>Delray Beach</city> <state>FL</state> <countryId>0</countryId> <latitude>26.4581805</latitude> <longitude>-80.0940717</longitude> <baseDistance>9022408</baseDistance> </address> <contact> <contactId>1728596</contactId> <customerId>1223587</customerId> <firstName>John</firstName> <lastName>Doe</lastName> <title></title> <email>jdoe@gmail.com</email> <phoneNumber>12345678901</phoneNumber> <phoneExt></phoneExt> <altPhoneExt></altPhoneExt> <pin>6674</pin> <enabled>true</enabled> <createdDate>09/17/2018 14:30:42</createdDate> <fax></fax> <admin>true</admin> </contact> <addressList/> <contactList/> <mobiForms/> </customer> </response>