Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CDK Global query API

The query API from CDK Global — 6 operation(s) for query.

CDK Global query API is one of 13 APIs that CDK Global publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include query. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 6 paths, and defines 19 schemas. It is described by OpenAPI 2.0, at version 3.0.0.

Requests are made against the base URL https://api.fortellis.io.

6 operations 6 paths 19 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.0
Base URL
https://api.fortellis.io
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

CDK Global query API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (permission-model) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

query 6
GET
/
Query appointments
queryAppointments 13 params → 200400401403
GET
/{appointmentId}
Query an appointment
queryAppointment 10 params → 200400401403404
GET
/all-product-info
Server example operation
allProductInfo 6 params → 200400401403503
GET
/all-product-info/{productNumber}
Specific Product
productInformation 6 params → 200400401403503
GET
/all-product-info/{productNumber}/product-size
Specific Product Description
productDescription 4 params → 200400401403503
GET
/ping
Server heartbeat operation
healthMonitor 3 params → 200400401403503

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Appointment (12 properties), Price (7 properties), PathProductNumber (6 properties), ContactPreference (5 properties). Each schema is shown below with its type and property counts.

AllProducts
object
This endpoint gives the information on all of the products.
2 properties 1 required
BaseCollection
object
This field describes the base collection.
3 properties 3 required
Measurement
object
This field will let you know about the value and the units of measurement.
2 properties 2 required
BaseCollectionLinks
object
This field describes the base collection links for the particular endpoint.
3 properties 1 required
Price
object
This field lists the cost of the appointment.
7 properties 5 required
AppointmentCollection
object
This field describes a collection of appointments.
1 required
AppointmentResource
This field describes the appointment resources.
2 required
PathProductNumber
object
This gives you the unique identifier for the product.
6 properties 3 required
ProductSize
object
This describes the dimensions of the product to help determine if you have the space to store the product.
5 properties 5 required
ContactMethod
object
This is the method that the customer would like you to use to contact them.
3 properties 2 required
Health
object
This is the code that tells you the server is okay.
3 properties 3 required
VehicleSpecification
object
This field describes the vehicle.
3 properties 3 required
RequestedService
object
This fields describes the service requested.
4 properties 1 required
Appointment
object
This definition defines the information and format in appointments.
12 properties 2 required
AppointmentLinks
object
This field describes the appointment links.
1 property 1 required
ContactPreference
object
This fields shows the customer's contact preferences.
5 properties 2 required
LinkDescriptionObject
object
These are the linked objects that you send with the request to comply with HATEOAS.
4 properties 1 required
ErrorResponse
object
This is a generic error schema.
2 properties 2 required
ErrorResponse_2
object
Common error response object.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cdk-global-query-api-openapi.yml Raw ↑

Other APIs CDK Global publishes across the network.

Fortellis Platform
Fortellis Event Relay Data Plane Proxy (AsyncAPI)
Fortellis AsyncAPI Hello World Reference
CDK Global adopt API
CDK Global adopt delete API
CDK Global adopt update API
CDK Global cancel API
CDK Global create API
CDK Global events API
CDK Global manage API
CDK Global Service Booking API
CDK Global update API