GET request/user/brand/{brandId}/all

Request Information

URI Parameters

NameDescriptionTypeAdditional information
brandId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of UserView
NameDescriptionTypeAdditional information
AdministratorId

integer

None.

Email

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

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",
    "title": "sample string 3",
    "firstName": "sample string 4",
    "lastName": "sample string 5",
    "landLine": "sample string 6",
    "mobileNumber": "sample string 7",
    "jobTitle": "sample string 8",
    "email": "sample string 9",
    "password": "sample string 10",
    "roleId": 11,
    "administratorId": 1,
    "forcePasswordChange": true,
    "isOptInToBeContacted": true
  },
  {
    "userId": 1,
    "roleName": "sample string 2",
    "title": "sample string 3",
    "firstName": "sample string 4",
    "lastName": "sample string 5",
    "landLine": "sample string 6",
    "mobileNumber": "sample string 7",
    "jobTitle": "sample string 8",
    "email": "sample string 9",
    "password": "sample string 10",
    "roleId": 11,
    "administratorId": 1,
    "forcePasswordChange": true,
    "isOptInToBeContacted": true
  }
]

text/html

Sample:
[{"userId":1,"roleName":"sample string 2","title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","landLine":"sample string 6","mobileNumber":"sample string 7","jobTitle":"sample string 8","email":"sample string 9","password":"sample string 10","roleId":11,"administratorId":1,"forcePasswordChange":true,"isOptInToBeContacted":true},{"userId":1,"roleName":"sample string 2","title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","landLine":"sample string 6","mobileNumber":"sample string 7","jobTitle":"sample string 8","email":"sample string 9","password":"sample string 10","roleId":11,"administratorId":1,"forcePasswordChange":true,"isOptInToBeContacted":true}]

application/xml, text/xml

Sample:
<ArrayOfUserView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.UsersDto">
  <UserView>
    <AdministratorId>1</AdministratorId>
    <Email>sample string 9</Email>
    <FirstName>sample string 4</FirstName>
    <ForcePasswordChange>true</ForcePasswordChange>
    <IsOptInToBeContacted>true</IsOptInToBeContacted>
    <JobTitle>sample string 8</JobTitle>
    <LandLine>sample string 6</LandLine>
    <LastName>sample string 5</LastName>
    <MobileNumber>sample string 7</MobileNumber>
    <Password>sample string 10</Password>
    <RoleId>11</RoleId>
    <Title>sample string 3</Title>
    <RoleName>sample string 2</RoleName>
    <UserId>1</UserId>
  </UserView>
  <UserView>
    <AdministratorId>1</AdministratorId>
    <Email>sample string 9</Email>
    <FirstName>sample string 4</FirstName>
    <ForcePasswordChange>true</ForcePasswordChange>
    <IsOptInToBeContacted>true</IsOptInToBeContacted>
    <JobTitle>sample string 8</JobTitle>
    <LandLine>sample string 6</LandLine>
    <LastName>sample string 5</LastName>
    <MobileNumber>sample string 7</MobileNumber>
    <Password>sample string 10</Password>
    <RoleId>11</RoleId>
    <Title>sample string 3</Title>
    <RoleName>sample string 2</RoleName>
    <UserId>1</UserId>
  </UserView>
</ArrayOfUserView>