Stations - v1

Description

This service, is to set stations for optimization.

Input

  1. apiKey: In order to obtain your API KEY, first log into logvrp web application and click "Manage API Key" button.
  2. computationTicketID: You will get this using Ticket service.
  3. completeStationSet: Stations that will be used in the optimization.
    1. DistanceMatrix: This must equal to null for this service. Its values will be provided using DistanceMatrix service.
    2. DurationMatrix: This must equal to null for this service. Its values will be provided using DurationMatrix service.
    3. StationSet: Station Set information. Just for information, values are not important.
      1. ID: Station Set ID. You can use 0.
      2. SetName: Station Set Name.
      3. RelatedStationSetID: Just 0.
      4. OrganizationID: You can use 0.
      5. CreatorUserID: You can use 0.
      6. CreatorUserName: You can use "", empty string.
      7. CreationTime: You can use "", empty string.
      8. LastUpdatedUserID: You can use 0.
      9. LastUpdatedTime: You can use "", empty string.
      10. DataCount: Specify total number of stations that will be passed.
      11. IsDeleted: You can use false.
    4. Stations: This parameter is an array of stations. A station contains the following:
      1. ID: Station ID. An integer. Must be unique in the given array!
      2. N: Station Name. You can use "", empty string.
      3. Y: Y coordinate of the station. -90 <= Y <= 90.
      4. X: X coordinate of the station. -180 <= X <= 180.
      5. A: Is Active station. You can use true.
      6. DT: Is Depot Station. If the station is a depot station, then set true, else set false.
      7. AD: Full address of the station. You can use "", empty string.
      8. AS: Short address of the station. You can use "", empty string.
      9. C: Is changed Station. You can use false.
      10. CID: Creator User ID. You can use 0.
      11. D: Is Deleted. You can use false.
      12. OID: Organization ID. You can use 0.
      13. P: Precedence. You can use 0.
      14. SID: Station Set ID. You can use 0.
      15. BaseServiceTime: (NEW) Integer. Service time in seconds to be spent for this location. For example, this can be one of or sum of the following activities: parking, entrance, checking in, performing pick-up, delivery or service, checking out, etc.

Output

Data: Returned data
Message: Output message
ReturnCode: Return code of the output. If "Success" is true, then check this value.
Success: If unpected errors, or exceptions occur, this will be false.
success: Same as Success

REST - JSON

URL
Input
Body
{
  "apiKey": "your API key here",
  "computationTicketID": "your computation ticket here",
  "completeStationSet": {
    "StationSet": {
      "ID": 0,
      "SetName": "",
      "RelatedStationSetID": 0,
      "OrganizationID": 0,
      "CreatorUserID": 0,
      "CreatorUserName": "",
      "CreationTime": "2012-09-15 00:00:00",
      "LastUpdatedUserID": 0,
      "LastUpdatedTime": "2012-09-15 00:00:00",
      "DataCount": 5,
      "IsDeleted": false
    },
    "DistanceMatrix": null,
    "DurationMatrix"null,
    "Stations": [
      {
        "ID": "-1",
        "N": "Depot Station",
        "SID": "0",
        "OID": "0",
        "CID": "0",
        "X": "-73.9900875091553",
        "Y": "40.7385430411239",
        "AD": "",
        "AS": "",
        "P": "0",
        "A": "true",
        "DT": "true",
        "D": "false",
        "BaseServiceTime": 0
      },
      {
        "ID": "-2",
        "N": "Station 1",
        "SID": "0",
        "OID": "0",
        "CID": "0",
        "X": "-74.0105152130127",
        "Y": "40.7141509986716",
        "AD": "",
        "AS": "",
        "P": "0",
        "A": "true",
        "DT": "false",
        "D": "false",
        "BaseServiceTime": 0
      },
      {
        "ID": "-3",
        "N": "Station 2",
        "SID": "0",
        "OID": "0",
        "CID": "0",
        "X": "-73.9978981018066",
        "Y": "40.7120691303963",
        "AD": "",
        "AS": "",
        "P": "0",
        "A": "true",
        "DT": "false",
        "D": "false",
        "BaseServiceTime": 0
      },
      {
        "ID": "-4",
        "N": "Station 3",
        "SID": "0",
        "OID": "0",
        "CID": "0",
        "X": "-73.9854526519775",
        "Y": "40.762796123367",
        "AD": "",
        "AS": "",
        "P": "0",
        "A": "true",
        "DT": "false",
        "D": "false",
        "BaseServiceTime": 0
      },
      {
        "ID": "-5",
        "N": "Station 4",
        "SID": "0",
        "OID": "0",
        "CID": "0",
        "X": "-73.9722347259521",
        "Y": "40.7588954203221",
        "AD": "",
        "AS": "",
        "P": "0",
        "A": "true",
        "DT": "false",
        "D": "false",
        "BaseServiceTime": 0
      }
    ]
  }
}
 
Headers
Content-Type: application/json
Method:
 
POST 
 
Output
Response
{
  "Data": null,
  "Message": null,
  "ReturnCode": 0,
  "Success": true,
  "success": true
}

 

 
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk