POST request/user
Add a new user
Request Information
URI Parameters
None.
Body Parameters
UserPost| Name | Description | Type | Additional information |
|---|---|---|---|
| DepartmentId | byte |
None. |
|
| string |
Required String length: inclusive between 0 and 250 |
||
| FirstName | string |
Required String length: inclusive between 0 and 100 |
|
| ForcePasswordChange | boolean |
None. |
|
| LastName | string |
String length: inclusive between 0 and 100 |
|
| Password | string |
String length: inclusive between 0 and 250 |
|
| Phone | string |
String length: inclusive between 0 and 20 |
|
| 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",
"phone": "sample string 4",
"email": "sample string 5",
"password": "sample string 6",
"roleId": 1,
"departmentId": 64,
"forcePasswordChange": true
}
text/html
Sample:
{"title":"sample string 1","firstName":"sample string 2","lastName":"sample string 3","phone":"sample string 4","email":"sample string 5","password":"sample string 6","roleId":1,"departmentId":64,"forcePasswordChange":true}
application/xml, text/xml
Sample:
<UserPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Users"> <DepartmentId>64</DepartmentId> <Email>sample string 5</Email> <FirstName>sample string 2</FirstName> <ForcePasswordChange>true</ForcePasswordChange> <LastName>sample string 3</LastName> <Password>sample string 6</Password> <Phone>sample string 4</Phone> <RoleId>1</RoleId> <Title>sample string 1</Title> </UserPost>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserPostResponse| Name | 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/CCSCommercialAPI.Models.Users"> <Id>1</Id> </UserPostResponse>