Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

GetDispatchersResponse

GetDispatchersResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

GetDispatchersResponseBody

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

GetDispatchersResponseBody
NameDescriptionTypeAdditional information
Dispatcher

Get dispatcher List.

Collection of DispatcherViewModel

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": {
    "Dispatcher": [
      {
        "DispOwnerName": "sample string 1",
        "DispEntity": 2,
        "OwnerId": "sample string 3",
        "DispatcherBlock": "sample string 4",
        "OwnerName": "sample string 5",
        "Name": "sample string 6"
      },
      {
        "DispOwnerName": "sample string 1",
        "DispEntity": 2,
        "OwnerId": "sample string 3",
        "DispatcherBlock": "sample string 4",
        "OwnerName": "sample string 5",
        "Name": "sample string 6"
      }
    ],
    "TotalCount": 1,
    "PageSize": 2,
    "Page": 3,
    "PageCount": 4
  }
}

application/xml, text/xml

Sample:
<GetDispatchersResponse 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>3</Page>
    <PageCount>4</PageCount>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <d2p1:Dispatcher xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:DispatcherViewModel>
        <d3p1:DispEntity>2</d3p1:DispEntity>
        <d3p1:DispOwnerName>sample string 1</d3p1:DispOwnerName>
        <d3p1:DispatcherBlock>sample string 4</d3p1:DispatcherBlock>
        <d3p1:Name>sample string 6</d3p1:Name>
        <d3p1:OwnerId>sample string 3</d3p1:OwnerId>
        <d3p1:OwnerName>sample string 5</d3p1:OwnerName>
      </d3p1:DispatcherViewModel>
      <d3p1:DispatcherViewModel>
        <d3p1:DispEntity>2</d3p1:DispEntity>
        <d3p1:DispOwnerName>sample string 1</d3p1:DispOwnerName>
        <d3p1:DispatcherBlock>sample string 4</d3p1:DispatcherBlock>
        <d3p1:Name>sample string 6</d3p1:Name>
        <d3p1:OwnerId>sample string 3</d3p1:OwnerId>
        <d3p1:OwnerName>sample string 5</d3p1:OwnerName>
      </d3p1:DispatcherViewModel>
    </d2p1:Dispatcher>
  </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>
</GetDispatchersResponse>

© 2025 Sargent and Greenleaf