Dealer
Retrieve dealer inventory id, zip, enrollment provider name and provider id
GET /services/dealer
Retrieve dealer provider id, provider name and zipcode
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"inventory_id": 11001612,
"createdAt": {
"date": "2019-05-02 16:00:32.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updatedAt": {
"date": "2019-05-02 16:00:32.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"provider": "MINIEnrollmentProvider",
"zipcode": "90404",
"provider_id": "44779-01",
"_links": {
"self": {
"href": "http://localhost:8084/services/dealer/11001612"
}
}
}
POST /services/dealer
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /services/dealer[/:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /services/dealer[/:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /services/dealer[/:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /services/dealer[/:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
FcaDrivePlus
Create, Retrieve, Update and Delete FCA Drive Plus entries
GET /services/driveplus
Retrieve all Drive Plus dealer entries
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /services/driveplus
Create multiple FCA Drive Plus entries
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
{
"name": "Bob's Fiat",
"provider_id": "12345",
"enrolled": false
}
{
"name": "Tom's CDJR",
"provider_id": "12346",
"enrolled": true
}
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /services/driveplus[/:provider_id]
Get 1 FCA Drive plus entry by provider_id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"name": "Bob's Toyota C7r",
"provider_id": "12345",
"enrolled": false
}
PATCH /services/driveplus[/:provider_id]
Url requires provider id of record that is being patched
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Bob's Toyota C7r",
"provider_id": "12345",
"enrolled": false
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /services/driveplus[/:provider_id]
Create new FCA Drive Plus entity
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Bob's Toyota 7",
"provider_id": 123457,
"enrolled": true
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /services/driveplus[/:provider_id]
Delete FCA Drive Plus record by provider_id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /services/driveplus[/:provider_id]
Create new FCA Drive plus entry
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Bob's Toyota 7",
"provider_id": 123457,
"enrolled": true
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GMShopClickDrive
GET /services/GM/SCDFeatures[/:provider_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /services/GM/SCDFeatures[/:provider_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /services/GM/SCDFeatures[/:provider_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
MazdaEnrollment
CRUD service for Mazda Enrollments.
GET /services/mazdaenrollment
Get a list of all entries
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | YES | |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| recall_url | string | YES | |
| tire_store_id | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /services/mazdaenrollment
Create multiple entries. Provider_id (Shift id) must be unique
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | YES | |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| recall_url | string | YES | |
| tire_store_id | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
{
{
"name": "Simple Simon's Dealership",
"provider_id": 92834728,
"recall_url": "https://simple.com/recalls",
"tire_store_id": 3
},
{
"name": "Simple Simon's Second Dealership",
"provider_id": 808080,
"recall_url": "https://simple.com/recalls",
"tire_store_id": 3
}
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /services/mazdaenrollment[/:provider_id]
Retrieve single entry by provider id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | YES | |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| recall_url | string | YES | |
| tire_store_id | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /services/mazdaenrollment[/:provider_id]
Update existing entry by provider_id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | YES | |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| recall_url | string | YES | |
| tire_store_id | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Simple Simon's Dealership",
"recall_url": "https://simple.com/recalls",
"tire_store_id": 3
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /services/mazdaenrollment[/:provider_id]
Create new entry
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | YES | |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| recall_url | string | YES | |
| tire_store_id | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Simple Simon's Dealership",
"provider_id": 92834728,
"recall_url": "https://simple.com/recalls",
"tire_store_id": 3
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /services/mazdaenrollment[/:provider_id]
Delete entry by provider_id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | YES | |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| recall_url | string | YES | |
| tire_store_id | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /services/mazdaenrollment[/:provider_id]
Create new entry. Provider_id (Shift ID) must be unique.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | YES | |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| recall_url | string | YES | |
| tire_store_id | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Simple Simon's Dealership",
"provider_id": 92834728,
"recall_url": "https://simple.com/recalls",
"tire_store_id": 3
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
ModelPage
CRUD service for Model Page data.
GET /services/model-page
Get all or retrieve using params year, model_name, or provider
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /services/model-page
Delete model pages by year, model_name or provider. At least one of these query parameters is required so you don't blow away the whole table.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /services/model-page
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /services/model-page[/:model_page_id]
Get by record id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /services/model-page[/:model_page_id]
Update existing record. Record id must be in url
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"model_name": "Passat",
"year": 2019,
"provider": "VWEnrollmentProvider",
"model_data": {}
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /services/model-page[/:model_page_id]
Create model page. Must have a unique year/model_name combo.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"model_name": "Passat",
"year": 2019,
"provider": "VWEnrollmentProvider",
"model_data": {}
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /services/model-page[/:model_page_id]
Delete by record id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /services/model-page[/:model_page_id]
Create model page. Must have a unique year/model_name combo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| model_name | string | Model name to use as index in returned data |
YES |
| year | Integer | Model year |
YES |
| provider | string | Enrollments Provider name (i.e. AcuraEnrollmentProvider) |
YES |
| model_data | string | Data to be used in constructing the model page on the site, in json format. |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"model_name": "Passat",
"year": 2019,
"provider": "VWEnrollmentProvider",
"model_data": {}
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
VWCAEnrollment
GET /services/vwcaenrollment
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| has_tire_storage | boolean | YES | |
| has_service_xpress | boolean | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /services/vwcaenrollment
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| has_tire_storage | boolean | YES | |
| has_service_xpress | boolean | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /services/vwcaenrollment[/:provider_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| has_tire_storage | boolean | YES | |
| has_service_xpress | boolean | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /services/vwcaenrollment[/:provider_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| has_tire_storage | boolean | YES | |
| has_service_xpress | boolean | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /services/vwcaenrollment[/:provider_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| has_tire_storage | boolean | YES | |
| has_service_xpress | boolean | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /services/vwcaenrollment[/:provider_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| has_tire_storage | boolean | YES | |
| has_service_xpress | boolean | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /services/vwcaenrollment[/:provider_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| has_tire_storage | boolean | YES | |
| has_service_xpress | boolean | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
ClientOAuth2
POST /services/client
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| string | YES | ||
| password | string | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
CloneMazdaEnrollment
Pull Mazda Enrollments entries from the specified location to this location.
POST /services/mazdaenrollment/clone
Pull Mazda Enrollments entries from specified location to this location.
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"sourceEnvironment": "from-test",
"notify": "<@U0CPD7SV9>"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
CloneModelPage
Pull Model Pages from specified location to this location. This functionality is always a 'pull'.
POST /services/model-page/clone
Pull Model Pages from specified location to this location. The 'provider' query param can be added to copy specific pages by OEM: /services/model-page/clone?provider=AcuraEnrollmentProvider
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"sourceEnvironment": "from-test",
"notify": "<@U0CPD7SV9>"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
CloneVWCAEnrollment
POST /services/vwcaenrollment/clone
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
CreateAdmin
POST /services/bootstrap
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DealerSPOTInfo
Retrieve all dealer's enrollments information by DI dealer id.
GET /services/dealer-info[/:inventory_id]
Retrieve all dealer's enrollments information by DI dealer id.
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DealerSiteInfo
Returns content by page for dealer website. Dealer ID (inventory id) is required.
GET /services/dealer/[:inventory_id]/site
Retrieve data and content for all of dealers required pages by DI dealer (inventory) id.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| Coupons | Json list of coupons from OEM API |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
FcaDrivePlus
Create, Retrieve, Update and Delete FCA Drive Plus entries
GET /services/driveplus
Retrieve all Drive Plus dealer entries
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /services/driveplus
Create multiple FCA Drive Plus entries
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
{
"name": "Bob's Fiat",
"provider_id": "12345",
"enrolled": false
}
{
"name": "Tom's CDJR",
"provider_id": "12346",
"enrolled": true
}
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /services/driveplus[/:provider_id]
Get 1 FCA Drive plus entry by provider_id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"name": "Bob's Toyota C7r",
"provider_id": "12345",
"enrolled": false
}
PATCH /services/driveplus[/:provider_id]
Url requires provider id of record that is being patched
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Bob's Toyota C7r",
"provider_id": "12345",
"enrolled": false
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /services/driveplus[/:provider_id]
Create new FCA Drive Plus entity
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Bob's Toyota 7",
"provider_id": 123457,
"enrolled": true
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /services/driveplus[/:provider_id]
Delete FCA Drive Plus record by provider_id
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /services/driveplus[/:provider_id]
Create new FCA Drive plus entry
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Dealer name. This is included so human users can verify they are looking at the correct dealer |
YES |
| provider_id | string | Id assigned to dealer by Shift. |
YES |
| enrolled | boolean | True if the dealer is enrolled in FCA DrivePlus. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"name": "Bob's Toyota 7",
"provider_id": 123457,
"enrolled": true
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GMDealerCSS
GET /services/GM/dealerCSS[/:provider_id]/[:domain]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GMDealerStatus
GET /services/GM/dealerStatus[/:provider_id][/:domain]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GMDisableAccessories
POST /services/GM/accessories/disable[/:provider_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GMEnableAccessories
POST /services/GM/accessories/enable[/:provider_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.enrollment.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GMReputationDotComUpdate
GET /update-gm-reputation-dot-com
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GmCertifiedServiceOffers
GET /services/gm/cso/import
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| date | string | Date of the file to import. |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GmGtmAssetDealerBatchUpdate
GET /services/gm/gtm-images/update-asset-dealers
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GmGtmImageUploadFinish
GET /services/gm/gtm-images/finish-upload
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GmGtmImageUpload
GET /services/gm/gtm-images/fetch-data
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GmGtmStoreAssets
GET /services/gm/gtm-images/store-assets
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GmGtmStoreDealers
GET /services/gm/gtm-images/store-dealers
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruCharities
GET /services/subaru/charities/[:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruEvents
GET /services/subaru/events/[:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruGetAccolades
GET /services/subaru/get-accolades[/:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruGetAmenities
GET /services/subaru/get-amenities/[:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruGetCompetitivePricing
GET /services/subaru/get-competitive-pricing/[:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruGetDealer
GET /services/subaru/dealer/[:inventory_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruGetStories
GET /services/subaru/dealer/[:inventory_id]/stories
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruMaintenanceModel
GET
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruMaintenanceTrim
GET /services/subaru/maintenance/year/[:year]/model/[:model_id]/trim
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruMaintenanceVehicle
GET /services/subaru/maintenance/vehicle/year/[:year]/model/[:model_id]/trim/[:trim_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruMaintenanceYear
GET
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
SubaruVehicleData
GET /services/subaru/maintenance/vehicle/data
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.enrollment.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.enrollment.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |