GET api/SocialDriver/GetExternalUser?username={username}&policyNumber={policyNumber}&imei={imei}
Get details of user
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
username |
The username being queried, this takes priority over policy number if both are specified |
string |
Default value is |
policyNumber |
The policy number being queried |
string |
Default value is |
imei |
The imei being queried |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
A ViewUserResponse
ViewUserExternallyResponseName | Description | Type | Additional information |
---|---|---|---|
Username |
A persons username |
string |
None. |
Timezone |
The user's timezone |
string |
None. |
Culture |
The user's culture |
string |
None. |
Firstname |
The user's first name |
string |
None. |
Lastname |
The user's last name |
string |
None. |
Dob |
The user's date of birth |
date |
None. |
Gender |
The user's gender |
string |
None. |
Address |
The user's address |
string |
None. |
Postcode |
The user's postcode |
string |
None. |
UserDistanceUnit |
The units the user wants distance in |
string |
None. |
UserSpeedUnit |
The units the user wants speed in |
string |
None. |
Title |
The user's title |
string |
None. |
MobileNumber |
The user's mobile number |
string |
None. |
PolicyNumber |
The users policy number |
string |
None. |
IMEI |
The users imei |
string |
None. |
VehicleRegistration |
The vehicle registration |
string |
None. |
UserStatus |
The status of the user |
UserStatus |
None. |
Branding |
The user's branding |
string |
None. |
RecoveryProviderId |
The id of the recovery provider or null if one isnt required |
integer |
None. |
MyCarClubBrandingId |
The my car club branding id |
integer |
None. |
Response Formats
application/json, text/json
{ "Username": "sample string 1", "Timezone": "sample string 2", "Culture": "sample string 3", "Firstname": "sample string 4", "Lastname": "sample string 5", "Dob": "2025-04-27T16:14:33.0685255+00:00", "Gender": "sample string 7", "Address": "sample string 8", "Postcode": "sample string 9", "UserDistanceUnit": "sample string 10", "UserSpeedUnit": "sample string 11", "Title": "sample string 12", "MobileNumber": "sample string 13", "PolicyNumber": "sample string 14", "IMEI": "sample string 15", "VehicleRegistration": "sample string 16", "UserStatus": 0, "Branding": "sample string 17", "RecoveryProviderId": 1, "MyCarClubBrandingId": 18 }
application/xml, text/xml
<ViewUserExternallyResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Username>sample string 1</Username> <Timezone>sample string 2</Timezone> <Culture>sample string 3</Culture> <Firstname>sample string 4</Firstname> <Lastname>sample string 5</Lastname> <Dob>2025-04-27T16:14:33.0685255+00:00</Dob> <Gender>sample string 7</Gender> <Address>sample string 8</Address> <Postcode>sample string 9</Postcode> <UserDistanceUnit>sample string 10</UserDistanceUnit> <UserSpeedUnit>sample string 11</UserSpeedUnit> <Title>sample string 12</Title> <MobileNumber>sample string 13</MobileNumber> <PolicyNumber>sample string 14</PolicyNumber> <IMEI>sample string 15</IMEI> <VehicleRegistration>sample string 16</VehicleRegistration> <UserStatus>Enable</UserStatus> <Branding>sample string 17</Branding> <RecoveryProviderId>1</RecoveryProviderId> <MyCarClubBrandingId>18</MyCarClubBrandingId> </ViewUserExternallyResponse>