1. Help
  2. POST BROWSE_USER

POST BROWSE_USER

This function will return a list of all available users in the database. INPUTS==> sort information (FILTER STRING, COLUMN, SORT ORDER). RETURN==> list of users

Request Information

URI Parameters

None.

Body Parameters

BrowseUserRequest

BrowseUserRequest
NameDescriptionTypeAdditional 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

Request Formats

application/json, text/json

Sample: 
{
  "FilterColumn": "firstname",
  "FilterString": "John",
  "SortOrder": 0,
  "SortColumn": "firstname",
  "Page": 1,
  "PageSize": 15
}

application/xml, text/xml

Sample: 
<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">1</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">15</PageSize>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">firstname</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">firstname</FilterColumn>
  <FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">John</FilterString>
</BrowseUserRequest>

application/x-www-form-urlencoded

Sample: 
Page=1&PageSize=15&FilterColumn=firstname&FilterString=John&SortColumn=firstname&SortOrder=Ascending

Response Information

Resource Description

BrowseUserResponse

BrowseUserResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

BrowseUserResponseBody

None.

Response Header Description

ResponseHeader
NameDescriptionTypeAdditional information
Message

Message

 string

None.
StatusCode

Status code

 ResponseStatus

None.
Status

Status

 string

None.
ErrorId

Error id

 string

None.

Response Body Description

BrowseUserResponseBody
NameDescriptionTypeAdditional 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.

Response Formats

application/json, text/json

Sample: 
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "Users": [
      {
        "AccessorId": 1,
        "FirstName": "John",
        "MiddleName": "A",
        "LastName": "Travis",
        "EmployeeId": "122112",
        "AccessorType": "USER",
        "Pin": "1234",
        "PinEncrypted": null,
        "GroupId": "Group",
        "Location": "Spare",
        "PhoneNo": "885-9411",
        "PagerNo": "887-2057",
        "UserType": "Multiple",
        "UserLevel": "U",
        "Status": true,
        "LocationId": "123456",
        "BitActive": "Active Combo"
      },
      {
        "AccessorId": 2,
        "FirstName": "Johnny",
        "MiddleName": "",
        "LastName": "Jones",
        "EmployeeId": "FT02398",
        "AccessorType": "USER",
        "Pin": "1111",
        "PinEncrypted": null,
        "GroupId": "Group",
        "Location": "Spare",
        "PhoneNo": "887-2057",
        "PagerNo": "885-9411",
        "UserType": "Multiple",
        "UserLevel": "M",
        "Status": false,
        "LocationId": "123456",
        "BitActive": ""
      },
      {
        "AccessorId": 3,
        "FirstName": "Johnny",
        "MiddleName": "",
        "LastName": "Thompson",
        "EmployeeId": "RH7182",
        "AccessorType": "USER",
        "Pin": "4444",
        "PinEncrypted": null,
        "GroupId": "Group",
        "Location": "Spare",
        "PhoneNo": "(859) 885-9411",
        "PagerNo": "(859) 887-2057",
        "UserType": "Single",
        "UserLevel": "U",
        "Status": true,
        "LocationId": "123456",
        "BitActive": "Active Combo"
      }
    ],
    "TotalCount": 82,
    "PageSize": 15,
    "Page": 1,
    "PageCount": 6
  }
}

application/xml, text/xml

Sample: 
<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>1</Page>
    <PageCount>6</PageCount>
    <PageSize>15</PageSize>
    <TotalCount>82</TotalCount>
    <d2p1:Users xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:UserViewModel>
        <d3p1:AccessorId>1</d3p1:AccessorId>
        <d3p1:AccessorType>USER</d3p1:AccessorType>
        <d3p1:BitActive>Active Combo</d3p1:BitActive>
        <d3p1:EmployeeId>122112</d3p1:EmployeeId>
        <d3p1:FirstName>John</d3p1:FirstName>
        <d3p1:GroupId>Group</d3p1:GroupId>
        <d3p1:LastName>Travis</d3p1:LastName>
        <d3p1:Location>Spare</d3p1:Location>
        <d3p1:LocationId>123456</d3p1:LocationId>
        <d3p1:MiddleName>A</d3p1:MiddleName>
        <d3p1:PagerNo>887-2057</d3p1:PagerNo>
        <d3p1:PhoneNo>885-9411</d3p1:PhoneNo>
        <d3p1:Pin>1234</d3p1:Pin>
        <d3p1:PinEncrypted i:nil="true" />
        <d3p1:Status>true</d3p1:Status>
        <d3p1:UserLevel>U</d3p1:UserLevel>
        <d3p1:UserType>Multiple</d3p1:UserType>
      </d3p1:UserViewModel>
      <d3p1:UserViewModel>
        <d3p1:AccessorId>2</d3p1:AccessorId>
        <d3p1:AccessorType>USER</d3p1:AccessorType>
        <d3p1:BitActive></d3p1:BitActive>
        <d3p1:EmployeeId>FT02398</d3p1:EmployeeId>
        <d3p1:FirstName>Johnny</d3p1:FirstName>
        <d3p1:GroupId>Group</d3p1:GroupId>
        <d3p1:LastName>Jones</d3p1:LastName>
        <d3p1:Location>Spare</d3p1:Location>
        <d3p1:LocationId>123456</d3p1:LocationId>
        <d3p1:MiddleName></d3p1:MiddleName>
        <d3p1:PagerNo>885-9411</d3p1:PagerNo>
        <d3p1:PhoneNo>887-2057</d3p1:PhoneNo>
        <d3p1:Pin>1111</d3p1:Pin>
        <d3p1:PinEncrypted i:nil="true" />
        <d3p1:Status>false</d3p1:Status>
        <d3p1:UserLevel>M</d3p1:UserLevel>
        <d3p1:UserType>Multiple</d3p1:UserType>
      </d3p1:UserViewModel>
      <d3p1:UserViewModel>
        <d3p1:AccessorId>3</d3p1:AccessorId>
        <d3p1:AccessorType>USER</d3p1:AccessorType>
        <d3p1:BitActive>Active Combo</d3p1:BitActive>
        <d3p1:EmployeeId>RH7182</d3p1:EmployeeId>
        <d3p1:FirstName>Johnny</d3p1:FirstName>
        <d3p1:GroupId>Group</d3p1:GroupId>
        <d3p1:LastName>Thompson</d3p1:LastName>
        <d3p1:Location>Spare</d3p1:Location>
        <d3p1:LocationId>123456</d3p1:LocationId>
        <d3p1:MiddleName></d3p1:MiddleName>
        <d3p1:PagerNo>(859) 887-2057</d3p1:PagerNo>
        <d3p1:PhoneNo>(859) 885-9411</d3p1:PhoneNo>
        <d3p1:Pin>4444</d3p1:Pin>
        <d3p1:PinEncrypted i:nil="true" />
        <d3p1:Status>true</d3p1:Status>
        <d3p1:UserLevel>U</d3p1:UserLevel>
        <d3p1:UserType>Single</d3p1:UserType>
      </d3p1:UserViewModel>
    </d2p1:Users>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</BrowseUserResponse>
© 2025 Sargent and Greenleaf