Request Information

URI Parameters

None.

Body Parameters

BrowseDevicesRequest
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": "sample string 1",
  "FilterString": "sample string 2",
  "SortOrder": 0,
  "SortColumn": "sample string 3",
  "Page": 4,
  "PageSize": 5
}

application/xml, text/xml

Sample:
<BrowseDevicesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">
  <Page>4</Page>
  <PageSize>5</PageSize>
  <SortColumn>sample string 3</SortColumn>
  <SortOrder>Ascending</SortOrder>
  <FilterColumn>sample string 1</FilterColumn>
  <FilterString>sample string 2</FilterString>
</BrowseDevicesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BrowseDevicesResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

BrowseDevicesResponseBody

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

BrowseDevicesResponseBody
NameDescriptionTypeAdditional information
TotalRegistrationsAvailable

integer

None.

TotalRegistrationsUsed

integer

None.

TotalRegistrationsRemaining

integer

None.

Devices

Collection of DeviceViewModel

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": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "TotalRegistrationsAvailable": 1,
    "TotalRegistrationsUsed": 2,
    "TotalRegistrationsRemaining": 3,
    "Devices": [
      {
        "Id": 1,
        "DeviceId": "sample string 2",
        "Description": "sample string 3",
        "MACAddress": "sample string 4",
        "DateRegistered": "2025-05-28T13:15:56.3868874-07:00"
      },
      {
        "Id": 1,
        "DeviceId": "sample string 2",
        "Description": "sample string 3",
        "MACAddress": "sample string 4",
        "DateRegistered": "2025-05-28T13:15:56.3868874-07:00"
      }
    ],
    "TotalCount": 4,
    "PageSize": 5,
    "Page": 6,
    "PageCount": 7
  }
}

application/xml, text/xml

Sample:
<BrowseDevicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
  <Body>
    <Page>6</Page>
    <PageCount>7</PageCount>
    <PageSize>5</PageSize>
    <TotalCount>4</TotalCount>
    <Devices xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models">
      <d3p1:DeviceViewModel>
        <d3p1:DateRegistered>2025-05-28T13:15:56.3868874-07:00</d3p1:DateRegistered>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:DeviceId>sample string 2</d3p1:DeviceId>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:MACAddress>sample string 4</d3p1:MACAddress>
      </d3p1:DeviceViewModel>
      <d3p1:DeviceViewModel>
        <d3p1:DateRegistered>2025-05-28T13:15:56.3868874-07:00</d3p1:DateRegistered>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:DeviceId>sample string 2</d3p1:DeviceId>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:MACAddress>sample string 4</d3p1:MACAddress>
      </d3p1:DeviceViewModel>
    </Devices>
    <TotalRegistrationsAvailable>1</TotalRegistrationsAvailable>
    <TotalRegistrationsRemaining>3</TotalRegistrationsRemaining>
    <TotalRegistrationsUsed>2</TotalRegistrationsUsed>
  </Body>
  <Header>
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</BrowseDevicesResponse>

© 2025 Sargent and Greenleaf