View User By ExternalID

Overview
Retrieve a User's information of the client by User's External Id

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/user/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	The external identifier of the user to be retrieved
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 a User Object if valid arguments are provided. Returns an error if not a valid request

Request Body XSD
None

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="user"/>
      </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="user">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkUserId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="email"/>
        <xs:element ref="loginId"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="phoneNumber"/>
        <xs:element ref="altPhoneNumber"/>
        <xs:element ref="faxNumber"/>
        <xs:element ref="status"/>
        <xs:element ref="jobTitle"/>
        <xs:element ref="userRole"/>
        <xs:element ref="address"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkUserId" type="xs:integer"/>
  <xs:element name="externalId" type="xs:NCName"/>
  <xs:element name="email" type="xs:string"/>
  <xs:element name="loginId" type="xs:NCName"/>
  <xs:element name="firstName" type="xs:NCName"/>
  <xs:element name="lastName" type="xs:NCName"/>
  <xs:element name="phoneNumber" type="xs:integer"/>
  <xs:element name="altPhoneNumber" type="xs:integer"/>
  <xs:element name="faxNumber">
    <xs:complexType/>
  </xs:element>
  <xs:element name="status" type="xs:NCName"/>
  <xs:element name="jobTitle">
    <xs:complexType/>
  </xs:element>
  <xs:element name="userRole" type="xs:NCName"/>
  <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">
    <xs:complexType/>
  </xs:element>
  <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">
    <xs:complexType/>
  </xs:element>
  <xs:element name="baseDistance" type="xs:integer"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/user/view.html?token=COJL8X2FKSLMMRTYCH2B&externalId=TESTING"
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <user> <mobiworkUserId>84334</mobiworkUserId> <externalId>TESTING</externalId> <email>alkin@mobiwork.com</email> <loginId>alkin</loginId> <firstName>Another</firstName> <lastName>User</lastName> <phoneNumber>1234567890</phoneNumber> <altPhoneNumber>5619218621</altPhoneNumber> <faxNumber></faxNumber> <status>ACTIVE</status> <jobTitle></jobTitle> <userRole>ROLE_CLIENT_ADMIN</userRole> <address> <addressId>4882382</addressId> <address1>160 Congress Park Drive</address1> <address2>Suites 201-203-205</address2> <city>Delray Beach</city> <state>Florida</state> <zipCode></zipCode> <countryId>0</countryId> <latitude>26.4581805</latitude> <longitude>-80.0940717</longitude> <name></name> <baseDistance>9022408</baseDistance> </address> </user> </response>