POST User/GetUserByID
Request Information
URI Parameters
None.
Body Parameters
UserAccountProxy| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | integer |
Required |
|
| AccountNumber | integer |
Required |
|
| UserType | byte |
None. |
|
| HomePhone | string |
String length: inclusive between 0 and 20 |
|
| MobilePhone | string |
String length: inclusive between 0 and 20 |
|
| EmailID | string |
None. |
|
| AlternateEmailID | string |
None. |
|
| UtilityAccountNumber | string |
String length: inclusive between 0 and 100 |
|
| GroupId | integer |
None. |
|
| LanguageCode | string |
Required |
|
| IsRegistration | boolean |
None. |
|
| PersonaId | byte |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
UserEntity| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID | integer |
None. |
|
| UserName | string |
String length: inclusive between 0 and 100 |
|
| Password | string |
String length: inclusive between 0 and 100 |
|
| EmailID | string |
String length: inclusive between 0 and 100 |
|
| IsLocked | boolean |
None. |
|
| LoginAttempt | byte |
None. |
|
| LastLoginAttempt | date |
None. |
|
| PushToken | string |
String length: inclusive between 0 and 100 |
|
| Status | byte |
None. |
|
| LoginToken | string |
String length: inclusive between 0 and 100 |
|
| LoginTokenDate | date |
None. |
|
| SecurityQuestionId | integer |
None. |
|
| HintsAns | string |
String length: inclusive between 0 and 100 |
|
| SecurityQuestionId2 | integer |
None. |
|
| HintsAns2 | string |
String length: inclusive between 0 and 100 |
|
| CreatedDate | date |
None. |
|
| LastUpdated | date |
None. |
|
| AlternateEmailID | string |
String length: inclusive between 0 and 100 |
|
| UserVerificationID | globally unique identifier |
None. |
|
| UtilityID | integer |
None. |
|
| ReminderDate | date |
None. |
|
| DeviceId | string |
String length: inclusive between 0 and 50 |
|
| DashboardOption | byte |
None. |
|
| GraphMode | boolean |
None. |
|
| IsShowGallon | boolean |
None. |
|
| IsShowHCF | boolean |
None. |
|
| IPAddress | string |
String length: inclusive between 0 and 100 |
|
| MobilePhone | string |
String length: inclusive between 0 and 20 |
|
| IsModernStyle | boolean |
None. |
|
| UserFont | string |
String length: inclusive between 0 and 50 |
|
| HomePhone | string |
String length: inclusive between 0 and 20 |
|
| DeactivationDate | date |
None. |
|
| TimeZoneId | integer |
None. |
|
| UserType | byte |
None. |
|
| ParentUserID | integer |
None. |
|
| ProgramID | integer |
None. |
|
| AdminUser | string |
String length: inclusive between 0 and 100 |
|
| FullName | string |
String length: inclusive between 0 and 100 |
|
| IsType | string |
String length: inclusive between 0 and 100 |
|
| ValidateToken | string |
String length: inclusive between 0 and 100 |
|
| placeholderId | string |
String length: inclusive between 0 and 30 |
|
| MessageBody | string |
String length: inclusive between 0 and 500 |
|
| ExpiryDate | date |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.