POST BROWSE_DISPATCHERS

Request Information

URI Parameters

None.

Body Parameters

BrowseDispatcherRequest

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

Request Formats

application/json, text/json

Sample:

{
  "FilterColumn": "Name",
  "FilterString": "",
  "SortOrder": 0,
  "SortColumn": "Name",
  "Page": 1,
  "PageSize": 15
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Page=1&PageSize=15&FilterColumn=Name&FilterString=&SortColumn=Name&SortOrder=Ascending

Response Information

Resource Description

BrowseDispatcherResponse

Name	Description	Type	Additional information
Header		ResponseHeader	None.
Body		BrowseDispatcherResponseBody	None.

Response Header Description

ResponseHeader

Name	Description	Type	Additional information
Message	Message	string	None.
StatusCode	Status code	ResponseStatus	None.
Status	Status	string	None.
ErrorId	Error id	string	None.

Response Body Description

BrowseDispatcherResponseBody

Name	Description	Type	Additional information
Dispatchers	List of Dispatchers	Collection of DispatchersViewModel	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": {
    "Dispatchers": [
      {
        "DispEntity": 0,
        "Name": "Locks R Us",
        "DispatchID": "86742D",
        "Location": "Kentucky",
        "PhoneNo": "5667899",
        "OwnerID": "11B9C9F5B06E",
        "SystemOwner": true,
        "DispatcherBlock": null,
        "ExportStartDate": null,
        "ExportEndDate": null,
        "IsResetUserTouchKey": false,
        "IsResetTamper": false,
        "IsDownloadAudit": false,
        "IsOpenLock": false,
        "privileges": null
      },
      {
        "DispEntity": 0,
        "Name": "Central Dispatch",
        "DispatchID": "86742E",
        "Location": "Michigan",
        "PhoneNo": "5667843",
        "OwnerID": "A0B5CA12213D",
        "SystemOwner": false,
        "DispatcherBlock": null,
        "ExportStartDate": null,
        "ExportEndDate": null,
        "IsResetUserTouchKey": false,
        "IsResetTamper": false,
        "IsDownloadAudit": false,
        "IsOpenLock": false,
        "privileges": null
      },
      {
        "DispEntity": 0,
        "Name": "Dispatch001",
        "DispatchID": "EEEE56",
        "Location": "New York",
        "PhoneNo": "5667825",
        "OwnerID": "11B9C9F5B06E",
        "SystemOwner": false,
        "DispatcherBlock": null,
        "ExportStartDate": null,
        "ExportEndDate": null,
        "IsResetUserTouchKey": false,
        "IsResetTamper": false,
        "IsDownloadAudit": false,
        "IsOpenLock": false,
        "privileges": null
      }
    ],
    "TotalCount": 12,
    "PageSize": 5,
    "Page": 1,
    "PageCount": 2
  }
}

application/xml, text/xml

Sample:

<BrowseDispatcherResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Dispatcher">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Dispatcher" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <Page>1</Page>
    <PageCount>2</PageCount>
    <PageSize>5</PageSize>
    <TotalCount>12</TotalCount>
    <d2p1:Dispatchers xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:DispatchersViewModel>
        <d3p1:DispEntity>0</d3p1:DispEntity>
        <d3p1:DispatchID>86742D</d3p1:DispatchID>
        <d3p1:DispatcherBlock i:nil="true" />
        <d3p1:ExportEndDate i:nil="true" />
        <d3p1:ExportStartDate i:nil="true" />
        <d3p1:IsDownloadAudit>false</d3p1:IsDownloadAudit>
        <d3p1:IsOpenLock>false</d3p1:IsOpenLock>
        <d3p1:IsResetTamper>false</d3p1:IsResetTamper>
        <d3p1:IsResetUserTouchKey>false</d3p1:IsResetUserTouchKey>
        <d3p1:Location>Kentucky</d3p1:Location>
        <d3p1:Name>Locks R Us</d3p1:Name>
        <d3p1:OwnerID>11B9C9F5B06E</d3p1:OwnerID>
        <d3p1:PhoneNo>5667899</d3p1:PhoneNo>
        <d3p1:SystemOwner>true</d3p1:SystemOwner>
        <d3p1:privileges i:nil="true" />
      </d3p1:DispatchersViewModel>
      <d3p1:DispatchersViewModel>
        <d3p1:DispEntity>0</d3p1:DispEntity>
        <d3p1:DispatchID>86742E</d3p1:DispatchID>
        <d3p1:DispatcherBlock i:nil="true" />
        <d3p1:ExportEndDate i:nil="true" />
        <d3p1:ExportStartDate i:nil="true" />
        <d3p1:IsDownloadAudit>false</d3p1:IsDownloadAudit>
        <d3p1:IsOpenLock>false</d3p1:IsOpenLock>
        <d3p1:IsResetTamper>false</d3p1:IsResetTamper>
        <d3p1:IsResetUserTouchKey>false</d3p1:IsResetUserTouchKey>
        <d3p1:Location>Michigan</d3p1:Location>
        <d3p1:Name>Central Dispatch</d3p1:Name>
        <d3p1:OwnerID>A0B5CA12213D</d3p1:OwnerID>
        <d3p1:PhoneNo>5667843</d3p1:PhoneNo>
        <d3p1:SystemOwner>false</d3p1:SystemOwner>
        <d3p1:privileges i:nil="true" />
      </d3p1:DispatchersViewModel>
      <d3p1:DispatchersViewModel>
        <d3p1:DispEntity>0</d3p1:DispEntity>
        <d3p1:DispatchID>EEEE56</d3p1:DispatchID>
        <d3p1:DispatcherBlock i:nil="true" />
        <d3p1:ExportEndDate i:nil="true" />
        <d3p1:ExportStartDate i:nil="true" />
        <d3p1:IsDownloadAudit>false</d3p1:IsDownloadAudit>
        <d3p1:IsOpenLock>false</d3p1:IsOpenLock>
        <d3p1:IsResetTamper>false</d3p1:IsResetTamper>
        <d3p1:IsResetUserTouchKey>false</d3p1:IsResetUserTouchKey>
        <d3p1:Location>New York</d3p1:Location>
        <d3p1:Name>Dispatch001</d3p1:Name>
        <d3p1:OwnerID>11B9C9F5B06E</d3p1:OwnerID>
        <d3p1:PhoneNo>5667825</d3p1:PhoneNo>
        <d3p1:SystemOwner>false</d3p1:SystemOwner>
        <d3p1:privileges i:nil="true" />
      </d3p1:DispatchersViewModel>
    </d2p1:Dispatchers>
  </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>
</BrowseDispatcherResponse>