POST ADD_DISPATCHER

Request Information

URI Parameters

None.

Body Parameters

AddDispatcherRequest.

Name	Description	Type	Additional information
DispEntity	Dispatcher Entity.	integer	None.
DispatchId	Dispatcher Id.	string	Required Matching regular expression pattern: [A-F0-9]{6} String length: inclusive between 6 and 6
Name	Name.	string	Required Max length: 50
Location	Location.	string	Max length: 50
PhoneNo	Phone Number.	string	Data type: PhoneNumber Max length: 20
DispatcherBlock	Dispatcher Block.	string	Max length: 32
SystemOwner	System Owner.	boolean	None.
ExportStartDate	Export Start Date.	string	Required Max length: 10
ExportEndDate	Export End Date.	string	Required Max length: 10
IsResetUserTouchKey		boolean	None.
IsResetTamper		boolean	None.
IsDownloadAudit		boolean	None.
IsOpenLock		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "DispEntity": 1,
  "DispatchId": "sample string 1",
  "Name": "sample string 2",
  "Location": "sample string 3",
  "PhoneNo": "sample string 4",
  "DispatcherBlock": "sample string 5",
  "SystemOwner": true,
  "ExportStartDate": "sample string 6",
  "ExportEndDate": "sample string 7",
  "IsResetUserTouchKey": true,
  "IsResetTamper": true,
  "IsDownloadAudit": true,
  "IsOpenLock": true
}

application/xml, text/xml

Sample:

<AddDispatcherRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Dispatcher">
  <DispEntity>1</DispEntity>
  <DispatchId>sample string 1</DispatchId>
  <DispatcherBlock>sample string 5</DispatcherBlock>
  <ExportEndDate>sample string 7</ExportEndDate>
  <ExportStartDate>sample string 6</ExportStartDate>
  <IsDownloadAudit>true</IsDownloadAudit>
  <IsOpenLock>true</IsOpenLock>
  <IsResetTamper>true</IsResetTamper>
  <IsResetUserTouchKey>true</IsResetUserTouchKey>
  <Location>sample string 3</Location>
  <Name>sample string 2</Name>
  <PhoneNo>sample string 4</PhoneNo>
  <SystemOwner>true</SystemOwner>
</AddDispatcherRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddDispatcherResponse

Name	Description	Type	Additional information
Header		ResponseHeader	None.
Body		AddDispatcherResponseBody	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

AddDispatcherResponseBody

Name	Description	Type	Additional information
IsSuccess	Flag to show if dispatcher successfully added	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "IsSuccess": true
  }
}

application/xml, text/xml

Sample:

<AddDispatcherResponse 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">
    <d2p1:IsSuccess>true</d2p1:IsSuccess>
  </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>
</AddDispatcherResponse>