Features - Connectors Framework - Inbound REST API - Generic Entities
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
Response Body XSD
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>