GET request/user

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of UserView

Name	Type	Additional information
DepartmentId	byte	None.
Email	string	Required String length: inclusive between 0 and 250
FirstName	string	Required String length: inclusive between 0 and 100
FirsttimeLogin	boolean	None.
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
RoleName	string	None.
Title	string	String length: inclusive between 0 and 10
UserId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "userId": 1,
    "roleName": "sample string 2",
    "firsttimeLogin": true,
    "title": "sample string 4",
    "firstName": "sample string 5",
    "lastName": "sample string 6",
    "phone": "sample string 7",
    "email": "sample string 8",
    "password": "sample string 9",
    "roleId": 1,
    "departmentId": 64,
    "forcePasswordChange": true
  },
  {
    "userId": 1,
    "roleName": "sample string 2",
    "firsttimeLogin": true,
    "title": "sample string 4",
    "firstName": "sample string 5",
    "lastName": "sample string 6",
    "phone": "sample string 7",
    "email": "sample string 8",
    "password": "sample string 9",
    "roleId": 1,
    "departmentId": 64,
    "forcePasswordChange": true
  }
]

text/html

Sample:

[{"userId":1,"roleName":"sample string 2","firsttimeLogin":true,"title":"sample string 4","firstName":"sample string 5","lastName":"sample string 6","phone":"sample string 7","email":"sample string 8","password":"sample string 9","roleId":1,"departmentId":64,"forcePasswordChange":true},{"userId":1,"roleName":"sample string 2","firsttimeLogin":true,"title":"sample string 4","firstName":"sample string 5","lastName":"sample string 6","phone":"sample string 7","email":"sample string 8","password":"sample string 9","roleId":1,"departmentId":64,"forcePasswordChange":true}]

application/xml, text/xml

Sample:

<ArrayOfUserView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Users">
  <UserView>
    <DepartmentId>64</DepartmentId>
    <Email>sample string 8</Email>
    <FirstName>sample string 5</FirstName>
    <ForcePasswordChange>true</ForcePasswordChange>
    <LastName>sample string 6</LastName>
    <Password>sample string 9</Password>
    <Phone>sample string 7</Phone>
    <RoleId>1</RoleId>
    <Title>sample string 4</Title>
    <FirsttimeLogin>true</FirsttimeLogin>
    <RoleName>sample string 2</RoleName>
    <UserId>1</UserId>
  </UserView>
  <UserView>
    <DepartmentId>64</DepartmentId>
    <Email>sample string 8</Email>
    <FirstName>sample string 5</FirstName>
    <ForcePasswordChange>true</ForcePasswordChange>
    <LastName>sample string 6</LastName>
    <Password>sample string 9</Password>
    <Phone>sample string 7</Phone>
    <RoleId>1</RoleId>
    <Title>sample string 4</Title>
    <FirsttimeLogin>true</FirsttimeLogin>
    <RoleName>sample string 2</RoleName>
    <UserId>1</UserId>
  </UserView>
</ArrayOfUserView>