Get availability for a Fleet/Program with intervals

URL Expired

The URL for this request expired after 30 days.

API Parameters

• group_id
  integer, required
  The id of the Fleet/Program

• start_at
  date-time, required
  The timestamp for the start of the availability range

• end_at
  date-time, required
  The timestamp for the end of the availability range

• time_slot_interval
  string, enum, required
  Format response in intervals. 5-minute increments from 15 to 55 minutes, or 1 hour.
  Possible values:

  • 15minutes
  • 20minutes
  • 25minutes
  • 30minutes
  • 35minutes
  • 40minutes
  • 45minutes
  • 50minutes
  • 55minutes
  • 1hour

• ignore_reservation_ids
  string
  Comma-separated list of reservation IDs to ignore when calculating availability. Useful for modifying existing reservations.

• api-version
  integer, required
  Target API version

Response Codes

• 200 Success
  array of objects

  • id
    integer
    Origin group id
  • name
    string
    Group name generated from model description, or existing group name
  • intervals
    array of objects
    • start_at
      string
      date and time for the start of the interval
    • end_at
      string
      date and time for the end of the interval
    • groups
      array of objects
      • make
        string
        Vehicle make for the group
      • model
        string
        Vehicle model for the group
      • trim
        string
        Vehicle trim for the group
      • body_type
        string
        Vehicle body type for the group
      • power_train
        string
        Vehicle power train for the group
      • available_vehicles
        array of objects
        • id
          integer
          Origin vehicle id
        • vin
          string
          Vehicle VIN
        • base_msrp
          string
          Base MSRP

• 400 Bad Request

• 403 Forbidden

• 404 Not Found

Example CURL Request

curl --request GET \
     --url 'https://api.dealerware.com/admin/availability/groups/group_id/intervals?time_slot_interval=15minutes' \
     --header 'accept: application/json'

Example JSON Response

[
  {
    "id": 42,
    "name": "2 Door Coupe/Convertible Roadster",
    "intervals": [
      {
        "start_at": "2020-06-15T08:00:00Z",
        "end_at": "2020-06-15T09:00:00Z",
        "groups": [
          {
            "make": "GMC",
            "model": "Sierra 1500",
            "trim": "Elevation",
            "body_type": "Crew Cab",
            "power_train": "mechanical",
            "available_vehicles": [
              {
                "id": 42,
                "vin": "1G1YY22G8X5123456",
                "base_msrp": "$28,760.00"
              }
            ]
          }
        ]
      }
    ]
  }
]