GET api/Routes

Request Information

URI Parameters

None.

Body Parameters

RoutesReq
NameDescriptionTypeAdditional information
Company

The company name

string

Required

String length: inclusive between 0 and 6

Code

Optional to retrieve only a specific route code.

string

String length: inclusive between 0 and 6

Salesperson

Optional to retrieve only a specific SalesPerson code.

string

String length: inclusive between 0 and 5

Request Formats

application/json, text/json

Sample:
{
  "Company": "DEMO",
  "Code": "010",
  "Salesperson": "001"
}

Response Information

Resource Description

RoutesRes
NameDescriptionTypeAdditional information
msgControl

Contains information about the response

MsgControl

None.

RoutesList

List of Routes

Collection of Routes

None.

Response Formats

application/json, text/json

Sample:
{
  "msgControl": {
    "result": 0,
    "Message": "Corresponding success and error message",
    "MethodName": "api/SalesPerson GET",
    "AppName": "EsoftWebApi",
    "EsoftUser": "ESOFT",
    "User": "Username",
    "Password": "Password",
    "SystemDate": "2025-04-26T19:56:33.5066407+03:00",
    "GenList": [],
    "GenMsg1": "",
    "GenMsg2": "",
    "GenMsg3": ""
  },
  "RoutesList": [
    {
      "Code": "00001",
      "Description": "Description 00001",
      "VisitSequense": [
        {
          "Sequense": "001",
          "AccountCode": "320001",
          "Salesperson": "001",
          "Remarks": "Remarks 1"
        },
        {
          "Sequense": "002",
          "AccountCode": "320002",
          "Salesperson": "001",
          "Remarks": "Remarks 2"
        }
      ]
    }
  ]
}