PUT EDIT_ROUTE

Request Information

URI Parameters

None.

Body Parameters

EditRouteDescRequest.

Name	Description	Type	Additional information
RouteEntity		integer	Required
RouteId		string	Required
Description	Route Description	string	Required
Location		string	None.
DateUpdate	Date of when route is updated	date	None.
LocationId	Location Id	string	None.
ATMs	Assigned ATMs	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "RouteEntity": 1,
  "RouteId": "sample string 2",
  "Description": "sample string 3",
  "Location": "sample string 4",
  "DateUpdate": "2025-11-08T03:19:51.7495275-05:00",
  "LocationId": "sample string 5",
  "ATMs": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<EditRouteDescRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Route">
  <ATMs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ATMs>
  <DateUpdate>2025-11-08T03:19:51.7495275-05:00</DateUpdate>
  <Description>sample string 3</Description>
  <Location>sample string 4</Location>
  <LocationId>sample string 5</LocationId>
  <RouteEntity>1</RouteEntity>
  <RouteId>sample string 2</RouteId>
</EditRouteDescRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EditRouteDescResponse

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

EditRouteDescResponseBody

Name	Description	Type	Additional information
RouteSaved	Flag to show if route was successfully modified	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": {
    "RouteSaved": true
  }
}

application/xml, text/xml

Sample:

<EditRouteDescResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Route">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Route" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:RouteSaved>true</d2p1:RouteSaved>
  </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>
</EditRouteDescResponse>