Features - Connectors Framework - Inbound REST API - Customers
View Customer by ExternalID
Overview
Retrieve a Customer's information of the client using externalID of the customer
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/customer/{customerId}/view.html?token=XXXXXXXX&userId={userId}&externalId={externalId}
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
externalId
required
Specified in URL as a parameter, is the ExternalID of the customer to be retrieved
userId
optional
If provided, this User ID will be taken as a logged in user
Return
Returns an Customer Object if valid arguments are provided. Returns an error if not a valid request
Request Body XSD
None
Response Body XSD
Curl Example
HTTP Method: GET
Request: curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/customer/54782/view.html?token=COJL8X2FKSLMMRTYCH2B&externalId=ext555"
Response: <?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1">
<customer>
<mobiworkCustomerId>501266</mobiworkCustomerId>
<externalCustomerId>API4444</externalCustomerId>
<companyName>API Test</companyName>
<typeId>BUSINESS</typeId>
<statusId>589</statusId>
<enabled>true</enabled>
<address>
<addressId>818635</addressId>
<address1>160 Congress Park Dr</address1>
<address2></address2>
<city>Delray Beach</city>
<state>Florida</state>
<zipCode>33445</zipCode>
<countryId>1</countryId>
<latitude>26.4582132</latitude>
<longitude>-80.0940502</longitude>
<name>Primary Address</name>
<baseDistance>9022407</baseDistance>
</address>
<contact>
<contactId>685033</contactId>
<customerId>501266</customerId>
<firstName>API4</firstName>
<lastName>API4</lastName>
<title></title>
<email></email>
<phoneNumber>516156111</phoneNumber>
<altPhoneNumber></altPhoneNumber>
<phoneExt></phoneExt>
<altPhoneExt></altPhoneExt>
<pin>8921</pin>
<enabled>true</enabled>
<createdDate>Mon Sep 26 06:35:29 EDT 2016</createdDate>
<fax></fax>
<admin>true</admin>
<employeeId></employeeId>
<loginId></loginId>
<password></password>
</contact>
<customFieldList>
<customField>
<apiName>ServiceContract</apiName>
<fieldType>4</fieldType>
<value>false</value>
<name>Service Contract?</name>
</customField>
<customField>
<apiName>ReqField</apiName>
<fieldType>1</fieldType>
<value>Test after return code</value>
<name>Req Field</name>
</customField>
</customFieldList>
</customer>
</response>