1. Help
  2. POST OPEN_ROUTE_NO_TOUCH_KEY

POST OPEN_ROUTE_NO_TOUCH_KEY

Generate an operation code that can be used to open a lock. INPUTS==> ATM ID, USER ID, START DATE, START TIME, TIME BLOCK, LOCK STATUS. RETURN==> OPERATION CODE (open lock)

Request Information

URI Parameters

None.

Body Parameters

OpenRouteNoTKRequest

OpenRouteNoTKRequest
NameDescriptionTypeAdditional information
RouteId

string

Required
UserId

string

Required
AtmIds

Collection of string

Required
Date

string

Required
Hour

integer

None.
TimeBlock

integer

None.
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: 
{
  "RouteId": "sample string 1",
  "UserId": "sample string 2",
  "AtmIds": [
    "sample string 1",
    "sample string 2"
  ],
  "Date": "sample string 3",
  "Hour": 4,
  "TimeBlock": 5,
  "FilterColumn": "sample string 6",
  "FilterString": "sample string 7",
  "SortOrder": 0,
  "SortColumn": "sample string 8",
  "Page": 9,
  "PageSize": 10
}

application/xml, text/xml

Sample: 
<OpenRouteNoTKRequest 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">9</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">10</PageSize>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 8</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 6</FilterColumn>
  <FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 7</FilterString>
  <AtmIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AtmIds>
  <Date>sample string 3</Date>
  <Hour>4</Hour>
  <RouteId>sample string 1</RouteId>
  <TimeBlock>5</TimeBlock>
  <UserId>sample string 2</UserId>
</OpenRouteNoTKRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationCodeOpenRouteResponse

AtmOpenRouteResponse
NameDescriptionTypeAdditional information
Header

Operation code response message header.

 ResponseHeader

None.
Body

Operation code response message body.

 AtmOpenRouteResponseBody

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

AtmOpenRouteResponseBody
NameDescriptionTypeAdditional information
OnSuccess

Generated Operation Code(s)

 boolean

None.
ErrorId

Error Atms

 Collection of string

None.
ErrorMessages

Error Message

 Collection of string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "OnSuccess": true,
    "ErrorId": [
      "sample string 1",
      "sample string 2"
    ],
    "ErrorMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample: 
<AtmOpenRouteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Route">
  <Body>
    <ErrorId xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ErrorId>
    <ErrorMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ErrorMessages>
    <OnSuccess>true</OnSuccess>
  </Body>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:ErrorId>sample string 3</d2p1:ErrorId>
    <d2p1:Message>sample string 1</d2p1:Message>
    <d2p1:Status>sample string 2</d2p1:Status>
    <d2p1:StatusCode>Ok</d2p1:StatusCode>
  </Header>
</AtmOpenRouteResponse>
© 2025 Sargent and Greenleaf