1. Help
  2. POST BROWSE_ROUTE

POST BROWSE_ROUTE

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

Request Information

URI Parameters

None.

Body Parameters

BrowseRouteDescRequest

BrowseRouteDescRequest
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: 
<BrowseRouteDescRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Route">
  <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>
</BrowseRouteDescRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BrowseRouteDescResponse

BrowseRouteDescResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

BrowseRouteDescResponseBody

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

BrowseRouteDescResponseBody
NameDescriptionTypeAdditional information
RouteDescs

List of routes

 Collection of RouteDescViewModel

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": {
    "RouteDescs": [
      {
        "RouteEntity": 1,
        "RouteId": "sample string 2",
        "Description": "sample string 3",
        "Location": "sample string 4",
        "DateUpdate": "2025-11-08T03:18:13.6595108-05:00",
        "LocationId": "sample string 5"
      },
      {
        "RouteEntity": 1,
        "RouteId": "sample string 2",
        "Description": "sample string 3",
        "Location": "sample string 4",
        "DateUpdate": "2025-11-08T03:18:13.6595108-05:00",
        "LocationId": "sample string 5"
      }
    ],
    "TotalCount": 1,
    "PageSize": 2,
    "Page": 3,
    "PageCount": 4
  }
}

application/xml, text/xml

Sample: 
<BrowseRouteDescResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Route">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Route" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <Page>3</Page>
    <PageCount>4</PageCount>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <d2p1:RouteDescs xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:RouteDescViewModel>
        <d3p1:DateUpdate>2025-11-08T03:18:13.6595108-05:00</d3p1:DateUpdate>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:Location>sample string 4</d3p1:Location>
        <d3p1:LocationId>sample string 5</d3p1:LocationId>
        <d3p1:RouteEntity>1</d3p1:RouteEntity>
        <d3p1:RouteId>sample string 2</d3p1:RouteId>
      </d3p1:RouteDescViewModel>
      <d3p1:RouteDescViewModel>
        <d3p1:DateUpdate>2025-11-08T03:18:13.6595108-05:00</d3p1:DateUpdate>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:Location>sample string 4</d3p1:Location>
        <d3p1:LocationId>sample string 5</d3p1:LocationId>
        <d3p1:RouteEntity>1</d3p1:RouteEntity>
        <d3p1:RouteId>sample string 2</d3p1:RouteId>
      </d3p1:RouteDescViewModel>
    </d2p1:RouteDescs>
  </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>
</BrowseRouteDescResponse>
© 2025 Sargent and Greenleaf