POST request/user/brand/{brandid}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
brandid | integer |
Required |
Body Parameters
UserPostName | Description | Type | Additional information |
---|---|---|---|
AdministratorId | integer |
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 |
|
Password | string |
String length: inclusive between 0 and 250 |
|
RoleId | integer |
Required |
|
Title | string |
String length: inclusive between 0 and 10 |
Request Formats
application/json, text/json
Sample:
{ "title": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "landLine": "sample string 4", "mobileNumber": "sample string 5", "jobTitle": "sample string 6", "email": "sample string 7", "password": "sample string 8", "roleId": 9, "administratorId": 1, "forcePasswordChange": true, "isOptInToBeContacted": true }
text/html
Sample:
{"title":"sample string 1","firstName":"sample string 2","lastName":"sample string 3","landLine":"sample string 4","mobileNumber":"sample string 5","jobTitle":"sample string 6","email":"sample string 7","password":"sample string 8","roleId":9,"administratorId":1,"forcePasswordChange":true,"isOptInToBeContacted":true}
application/xml, text/xml
Sample:
<UserPost 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 7</Email> <FirstName>sample string 2</FirstName> <ForcePasswordChange>true</ForcePasswordChange> <IsOptInToBeContacted>true</IsOptInToBeContacted> <JobTitle>sample string 6</JobTitle> <LandLine>sample string 4</LandLine> <LastName>sample string 3</LastName> <MobileNumber>sample string 5</MobileNumber> <Password>sample string 8</Password> <RoleId>9</RoleId> <Title>sample string 1</Title> </UserPost>
Response Information
Resource Description
UserPostResponseName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "id": 1 }
text/html
Sample:
{"id":1}
application/xml, text/xml
Sample:
<UserPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.UsersDto"> <Id>1</Id> </UserPostResponse>