List Generic Entities

List Generic Entities
Retrieve a list of generic entities from the MobiWork system

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

Arguments

clientID Required	MobiWork assigned unique ID of the company
versionNumber Required	Version number of MobiWork API SDK release
genericEntityId Required	The identifier of the generic entity to be retrieved
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

Filter or Search Criteria

optionsId	By the optionId of the generic entity
enabled	By the enabled status of the generic entity
entityTag	By the entity tag of the generic entity
externalId	By the externalId of the generic entity
entityId	By the Id of generic entity
integrationStatus	By the integration status of the generic entity

Return
Returns a list Generic Entity objects if valid arguments are provided. Returns an error if not a valid request.

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="genericEntitySearch">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="optionsId"/>
        <xs:element ref="enabled"/>
        <xs:element ref="entityTag"/>
        <xs:element ref="externalId"/>
        <xs:element ref="entityId"/>
        <xs:element ref="integrationStatus"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="optionsId" type="xs:integer" minOccurs="0"/>
  <xs:element name="enabled" type="xs:integer" minOccurs="0"/>
  <xs:element name="entityTag" type="xs:NCName" minOccurs="0"/>
  <xs:element name="externalId" type="xs:NCName" minOccurs="0"/>
  <xs:element name="entityId" type="xs:integer" minOccurs="0"/>
  <xs:element name="integrationStatus" type="xs:NCName" 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="genericEntityList"/>
      </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="genericEntityList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" 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"/>
  <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" type="xs:NCName"/>
  <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 Request

HTTP Method:	GET
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/genericentity/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data'<genericEntitySearch><optionsId>1</optionsId><enabled>1</enabled></genericEntitySearch>'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <genericEntityList> <genericEntity> <mobiworkGenericEntityId>501266</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>501266</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> </genericEntityList> </response>