Generate an operation code that can be used to open a lock. INPUTS==> ROUTE ID, USER ID, ATM ID's RETURN==> Boolean
None.
OpenRouteNowRequest
OpenRouteNowRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| RouteId | string |
Required |
|
| UserId | string |
Required |
|
| AtmIds | Collection of string |
Required |
|
| 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 |
{
"RouteId": "sample string 1",
"UserId": "sample string 2",
"AtmIds": [
"sample string 1",
"sample string 2"
],
"FilterColumn": "sample string 3",
"FilterString": "sample string 4",
"SortOrder": 0,
"SortColumn": "sample string 5",
"Page": 6,
"PageSize": 7
}
<OpenRouteNowRequest 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">6</Page>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">7</PageSize>
<SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 5</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 3</FilterColumn>
<FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 4</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>
<RouteId>sample string 1</RouteId>
<UserId>sample string 2</UserId>
</OpenRouteNowRequest>
Sample not available.
OperationCodeOpenRouteResponse
AtmOpenRouteResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Operation code response message header. |
ResponseHeader |
None. |
| Body |
Operation code response message body. |
AtmOpenRouteResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| OnSuccess |
Generated Operation Code(s) |
boolean |
None. |
| ErrorId |
Error Atms |
Collection of string |
None. |
| ErrorMessages |
Error Message |
Collection of string |
None. |
{
"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"
]
}
}
<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>