GET request/user/currentuser
Display current user info
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
CurrentUserView| Name | Description | Type | Additional information |
|---|---|---|---|
| AdministratorId | integer |
None. |
|
| BrandId | integer |
None. |
|
| BrokerPhone | string |
None. |
|
| CanShowUplift | boolean |
None. |
|
| string |
Required String length: inclusive between 0 and 250 |
||
| FirstName | string |
Required String length: inclusive between 0 and 100 |
|
| ForcePasswordChange | boolean |
None. |
|
| IsOptInToBeContacted | boolean |
None. |
|
| JobTitle | string |
String length: inclusive between 0 and 100 |
|
| LandLine | string |
String length: inclusive between 0 and 20 |
|
| LastName | string |
String length: inclusive between 0 and 100 |
|
| MobileNumber | string |
String length: inclusive between 0 and 20 |
|
| ParentBrandId | integer |
None. |
|
| Password | string |
String length: inclusive between 0 and 250 |
|
| RoleId | integer |
Required |
|
| RoleName | string |
None. |
|
| Title | string |
String length: inclusive between 0 and 10 |
|
| UserId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"userId": 1,
"brandId": 2,
"parentBrandId": 3,
"roleName": "sample string 4",
"canShowUplift": true,
"brokerPhone": "sample string 6",
"title": "sample string 7",
"firstName": "sample string 8",
"lastName": "sample string 9",
"landLine": "sample string 10",
"mobileNumber": "sample string 11",
"jobTitle": "sample string 12",
"email": "sample string 13",
"password": "sample string 14",
"roleId": 15,
"administratorId": 1,
"forcePasswordChange": true,
"isOptInToBeContacted": true
}
text/html
Sample:
{"userId":1,"brandId":2,"parentBrandId":3,"roleName":"sample string 4","canShowUplift":true,"brokerPhone":"sample string 6","title":"sample string 7","firstName":"sample string 8","lastName":"sample string 9","landLine":"sample string 10","mobileNumber":"sample string 11","jobTitle":"sample string 12","email":"sample string 13","password":"sample string 14","roleId":15,"administratorId":1,"forcePasswordChange":true,"isOptInToBeContacted":true}
application/xml, text/xml
Sample:
<CurrentUserView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.UsersDto"> <AdministratorId>1</AdministratorId> <Email>sample string 13</Email> <FirstName>sample string 8</FirstName> <ForcePasswordChange>true</ForcePasswordChange> <IsOptInToBeContacted>true</IsOptInToBeContacted> <JobTitle>sample string 12</JobTitle> <LandLine>sample string 10</LandLine> <LastName>sample string 9</LastName> <MobileNumber>sample string 11</MobileNumber> <Password>sample string 14</Password> <RoleId>15</RoleId> <Title>sample string 7</Title> <BrandId>2</BrandId> <BrokerPhone>sample string 6</BrokerPhone> <CanShowUplift>true</CanShowUplift> <ParentBrandId>3</ParentBrandId> <RoleName>sample string 4</RoleName> <UserId>1</UserId> </CurrentUserView>