GET api/runs?serviceTypeId={serviceTypeId}&date={date}

Gets runs

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceTypeId

The service type to use to filter the runs

integer

Required

date

The date to get runs for

date

Required

Body Parameters

None.

Response Information

Resource Description

The runs matching the given serviceType and date

Collection of Run
NameDescriptionTypeAdditional information
Name

The name of the run

string

None.

Events

The events in the run

Collection of Event

None.

Vehicle

Information about the vehicle assigned to the run

RunVehicle

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "name": "sample string 1",
    "events": [
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2021-06-24T03:24:57.6603959-06:00"
      },
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2021-06-24T03:24:57.6603959-06:00"
      }
    ],
    "vehicle": {
      "vehicleId": 1,
      "gpsData": {
        "latitude": 1.1,
        "longitude": 2.1,
        "direction": 1.1,
        "gpsTime": "2021-06-24T03:24:57.6613973-06:00"
      },
      "vehicleNumber": "sample string 2",
      "description": "sample string 3",
      "year": 1,
      "make": "sample string 4",
      "model": "sample string 5",
      "licensePlate": "sample string 6"
    }
  },
  {
    "name": "sample string 1",
    "events": [
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2021-06-24T03:24:57.6603959-06:00"
      },
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2021-06-24T03:24:57.6603959-06:00"
      }
    ],
    "vehicle": {
      "vehicleId": 1,
      "gpsData": {
        "latitude": 1.1,
        "longitude": 2.1,
        "direction": 1.1,
        "gpsTime": "2021-06-24T03:24:57.6613973-06:00"
      },
      "vehicleNumber": "sample string 2",
      "description": "sample string 3",
      "year": 1,
      "make": "sample string 4",
      "model": "sample string 5",
      "licensePlate": "sample string 6"
    }
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.