This function will return the information for the specified route record. INPUTS==> ROUTE ENTITY. RETURN==> route information (ROUTE ENTITY, ROUTE ID, DESCRIPTION, ...)
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Entity value for the route (database value) |
integer |
Required |
None.
GetRouteDescResponse
GetRouteDescResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | GetRouteDescResponseBody |
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 |
|---|---|---|---|
| RouteDesc |
Route View Model |
RouteDescViewModel |
None. |
{
"Header": {
"Message": "sample string 1",
"StatusCode": 0,
"Status": "sample string 2",
"ErrorId": "sample string 3"
},
"Body": {
"RouteDesc": {
"RouteEntity": 1,
"RouteId": "sample string 2",
"Description": "sample string 3",
"Location": "sample string 4",
"DateUpdate": "2025-11-08T03:18:18.1881384-05:00",
"LocationId": "sample string 5"
}
}
}
<GetRouteDescResponse 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:RouteDesc xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
<d3p1:DateUpdate>2025-11-08T03:18:18.1881384-05:00</d3p1:DateUpdate>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Location>sample string 4</d3p1:Location>
<d3p1:LocationId>sample string 5</d3p1:LocationId>
<d3p1:RouteEntity>1</d3p1:RouteEntity>
<d3p1:RouteId>sample string 2</d3p1:RouteId>
</d2p1:RouteDesc>
</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>
</GetRouteDescResponse>