This function will return a list of a manager records in the database. INPUTS==> sort information (FILTER STRING, COLUMN, SORT ORDER). RETURN==> list of manager records
None.
BrowseUserRequest
BrowseUserRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| FilterColumn | string |
None. |
|
| FilterString | string |
None. |
|
| SortOrder | SortOrder |
None. |
|
| SortColumn | string |
None. |
|
| Page |
PageNumber |
integer |
Range: inclusive between 1 and 100000 |
| PageSize |
Page Size |
integer |
Range: inclusive between 1 and 100000 |
{
"FilterColumn": "sample string 1",
"FilterString": "sample string 2",
"SortOrder": 0,
"SortColumn": "sample string 3",
"Page": 4,
"PageSize": 5
}
<BrowseUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.User"> <Page xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">4</Page> <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">5</PageSize> <SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 3</SortColumn> <SortOrder xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">Ascending</SortOrder> <FilterColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 1</FilterColumn> <FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 2</FilterString> </BrowseUserRequest>
Sample not available.
BrowseUserResponse
BrowseUserResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | BrowseUserResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Users |
List of users in the system |
Collection of UserViewModel |
None. |
| TotalCount |
Total records count. |
integer |
None. |
| PageSize |
Page size. |
integer |
None. |
| Page |
Page |
integer |
None. |
| PageCount |
Number of pages. |
integer |
None. |
{
"Header": {
"Message": "sample string 1",
"StatusCode": 0,
"Status": "sample string 2",
"ErrorId": "sample string 3"
},
"Body": {
"Users": [
{
"AccessorId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"EmployeeId": "sample string 5",
"AccessorType": "sample string 6",
"Pin": "sample string 7",
"PinEncrypted": "sample string 8",
"GroupId": "sample string 9",
"Location": "sample string 10",
"PhoneNo": "sample string 11",
"PagerNo": "sample string 12",
"UserType": "sample string 13",
"UserLevel": "sample string 14",
"Status": true,
"LocationId": "sample string 16",
"BitActive": "sample string 17"
},
{
"AccessorId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"EmployeeId": "sample string 5",
"AccessorType": "sample string 6",
"Pin": "sample string 7",
"PinEncrypted": "sample string 8",
"GroupId": "sample string 9",
"Location": "sample string 10",
"PhoneNo": "sample string 11",
"PagerNo": "sample string 12",
"UserType": "sample string 13",
"UserLevel": "sample string 14",
"Status": true,
"LocationId": "sample string 16",
"BitActive": "sample string 17"
}
],
"TotalCount": 1,
"PageSize": 2,
"Page": 3,
"PageCount": 4
}
}
<BrowseUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User">
<Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<Page>3</Page>
<PageCount>4</PageCount>
<PageSize>2</PageSize>
<TotalCount>1</TotalCount>
<d2p1:Users xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
<d3p1:UserViewModel>
<d3p1:AccessorId>1</d3p1:AccessorId>
<d3p1:AccessorType>sample string 6</d3p1:AccessorType>
<d3p1:BitActive>sample string 17</d3p1:BitActive>
<d3p1:EmployeeId>sample string 5</d3p1:EmployeeId>
<d3p1:FirstName>sample string 2</d3p1:FirstName>
<d3p1:GroupId>sample string 9</d3p1:GroupId>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:Location>sample string 10</d3p1:Location>
<d3p1:LocationId>sample string 16</d3p1:LocationId>
<d3p1:MiddleName>sample string 3</d3p1:MiddleName>
<d3p1:PagerNo>sample string 12</d3p1:PagerNo>
<d3p1:PhoneNo>sample string 11</d3p1:PhoneNo>
<d3p1:Pin>sample string 7</d3p1:Pin>
<d3p1:PinEncrypted>sample string 8</d3p1:PinEncrypted>
<d3p1:Status>true</d3p1:Status>
<d3p1:UserLevel>sample string 14</d3p1:UserLevel>
<d3p1:UserType>sample string 13</d3p1:UserType>
</d3p1:UserViewModel>
<d3p1:UserViewModel>
<d3p1:AccessorId>1</d3p1:AccessorId>
<d3p1:AccessorType>sample string 6</d3p1:AccessorType>
<d3p1:BitActive>sample string 17</d3p1:BitActive>
<d3p1:EmployeeId>sample string 5</d3p1:EmployeeId>
<d3p1:FirstName>sample string 2</d3p1:FirstName>
<d3p1:GroupId>sample string 9</d3p1:GroupId>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:Location>sample string 10</d3p1:Location>
<d3p1:LocationId>sample string 16</d3p1:LocationId>
<d3p1:MiddleName>sample string 3</d3p1:MiddleName>
<d3p1:PagerNo>sample string 12</d3p1:PagerNo>
<d3p1:PhoneNo>sample string 11</d3p1:PhoneNo>
<d3p1:Pin>sample string 7</d3p1:Pin>
<d3p1:PinEncrypted>sample string 8</d3p1:PinEncrypted>
<d3p1:Status>true</d3p1:Status>
<d3p1:UserLevel>sample string 14</d3p1:UserLevel>
<d3p1:UserType>sample string 13</d3p1:UserType>
</d3p1:UserViewModel>
</d2p1:Users>
</Body>
<Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<ErrorId>sample string 3</ErrorId>
<Message>sample string 1</Message>
<Status>sample string 2</Status>
<StatusCode>Ok</StatusCode>
</Header>
</BrowseUserResponse>