Add Generic Entity

Add Generic Entity
Add a generic entity to the MobiWork system.

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/genericEntity/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
token Required	Part of the URL as a request parameter and is required in every call to verify access to API calls
userId Optional	If provided, this User ID wil be taken as a logged in user. If not provided, we use an active global administrator ID

Return
Returns the added Generic Entity object if successful, or an error if not.

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="genericEntity"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="genericEntity">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="genericEntityOptionId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="entityTag"/>
        <xs:element ref="name"/>
        <xs:element ref="status"/>
        <xs:element ref="categoryId"/>
        <xs:element ref="primaryAddress"/>
        <xs:element ref="primaryContact"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="genericEntityOptionId" type="xs:integer" minOccurs="0"/>
  <xs:element name="externalId" type="xs:NCName" minOccurs="0"/>
  <xs:element name="entityTag" type="xs:NCName" minOccurs="0"/>
  <xs:element name="status" type="xs:NCName" minOccurs="0"/>
  <xs:element name="categoryId" type="xs:integer" minOccurs="0"/>
  <xs:element name="primaryAddress">
    <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:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="addressId" type="xs:integer" minOccurs="0"/>
  <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" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="longitude" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="primaryContact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="genericEntityContactId" minOccurs="0"/>
        <xs:element ref="genericEntityId" minOccurs="0"/>
        <xs:element ref="title" minOccurs="0"/>
        <xs:element ref="firstName" minOccurs="0"/>
        <xs:element ref="lastName" minOccurs="0"/>
        <xs:element ref="email" minOccurs="0"/>
        <xs:element ref="phoneNumber" minOccurs="0"/>
        <xs:element ref="faxNumber" minOccurs="0"/>
        <xs:element ref="enabled" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="genericEntityContactId" type="xs:integer" minOccurs="0"/>
  <xs:element name="genericEntityId" type="xs:integer"/>
  <xs:element name="title" type="xs:NCName" minOccurs="0"/>
  <xs:element name="firstName" type="xs:NCName" minOccurs="0"/>
  <xs:element name="lastName" type="xs:NCName" minOccurs="0"/>
  <xs:element name="email" type="xs:string" minOccurs="0"/>
  <xs:element name="phoneNumber" type="xs:integer" minOccurs="0"/>
  <xs:element name="faxNumber" type="xs:integer" minOccurs="0"/>
  <xs:element name="enabled" type="xs:boolean" minOccurs="0"/>
  <xs:element name="name" type="xs:string"/>
</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="genericEntity"/>
      </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="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"/>
  <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="externalId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="createdDate" type="xs:string"/>
  <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="userList">
    <xs:complexType/>
  </xs:element>
</xs:schema>

Sample Call

HTTP Method:	POST
Request:	curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/genericEntity/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request> <genericEntity> <mobiworkGenericEntityId>1</mobiworkGenericEntityId> <externalId>ABC-123</externalId> <name>Generic Entitle Sample</name> <createdDate>01/01/2019</createdDate> <primaryAddress> <addressId>1</addressId> <address1>123 Way Place</address1> <address2></address2> <city>Delray Beach</city> <state>Florida</state> <zipCode>12345</zipCode> <countryId>1</countryId> <latitude></latitude> <longitude></longitude> <name>Primary Address</name> </primaryAddress> <primaryContact> <genericEntityContactId>1</genericEntityContactId> <genericEntityId>1</genericEntityId> <title>Primary</title> <firstName>John</firstName> <lastName>Doe</lastName> <email>john.doe@company.com</email> <phoneNumber>1234567891</phoneNumber> <faxNumber>1234567891</faxNumber> <enabled>true</enabled> <createdDate>01/01/2019</createdDate> </primaryContact> </genericEntity> </request>
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.156" statusCode="1"> <genericEntity> <mobiworkGenericEntityId>1</mobiworkGenericEntityId> <externalId>ABC-123</externalId> <name>Generic Entitle Sample</name> <createdDate>01/01/2019</createdDate> <primaryAddress> <addressId>1</addressId> <address1>123 Way Place</address1> <address2></address2> <city>Delray Beach</city> <state>Florida</state> <zipCode>12345</zipCode> <countryId>1</countryId> <latitude></latitude> <longitude></longitude> <name>Primary Address</name> </primaryAddress> <primaryContact> <genericEntityContactId>1</genericEntityContactId> <genericEntityId>1</genericEntityId> <title>Primary</title> <firstName>John</firstName> <lastName>Doe</lastName> <email>john.doe@company.com</email> <phoneNumber>1234567891</phoneNumber> <faxNumber>1234567891</faxNumber> <enabled>true</enabled> <createdDate>01/01/2019</createdDate> </primaryContact> </genericEntity> </response>