CDK Drive Customer

Status: Preview

Tier: Premium

Version: 1.0

Name

Summary

queryCustomers ([Optional]string name, [Optional]string email, [Optional]string phone, string subscription_id, string client_id, string client_secret, [Optional]string Request-Id)

Query customers

createCustomer (string client_id, string client_secret, string subscription_id, [Optional]string Request-Id, [Optional]CreateCustomer createCustomer)

Create a customer

queryCustomerById (string customerId, string subscription_id, string client_id, string client_secret, [Optional]string Request-Id)

Query a customer

updateCustomer (string customerId, string subscription_id, string client_id, string client_secret, [Optional]string Request-Id, string If-Match, [Optional]CreateCustomer createCustomer)

Update a customer

Name

Summary

Name

Summary

ContactMethods

CreateCustomer

CreateUpdateName

Customer

CustomerCollection

CustomerLinks

LinkDescriptionObject

Name

PostalAddress

Name

Type

Summary

Required

Related Action

name

string

(Name)

Filters customers by name

False

email

string

(Email)

Filters customers by email address

False

phone

string

(Phone)

Filters customers by phone number

False

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

False

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

False

createCustomer

CreateCustomer

False

Name

Type

Summary

Required

Related Action

customerId

string

(Customer Id)

The customer identifier

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

False

Name

Type

Summary

Required

Related Action

customerId

string

(Customer Id)

The customer identifier

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

False

If-Match

string

(eTag)

Makes the resource update request conditional.  The checksum value  presented with If-Match must match the current ETag value of the  resource.

True

createCustomer

CreateCustomer

False

Name

Type

Summary

primaryPhone

string

The primary phone number of the customer

homePhone

string

The home phone number of the customer

mobilePhone

string

The mobile phone number of the customer

pager

string

The pager number of the customer

pagerAccessCode

string

The pager access code of the customer

homeFax

string

The home fax number of the customer

workFax

string

The work fax number of the customer

email1

string

Email address 1 of the customer. You can enter NA for Non-Applicable or CD for Customer Declined if no other email address is present

emailDesc1

string

Email address 1 description. Will contain NA or CD if entered on email1.  Values: [HOME, WORK, OTHER]

email2

string

Email address 2 of the customer

emailDesc2

string

Email address 2 description  Values: [HOME, WORK, OTHER]

email3

string

Email address 3 of the customer

emailDesc3

string

Email address 3 description  Values: [HOME, WORK, OTHER]

email4

string

Email address 4 of the customer

emailDesc4

string

Email address 4 description  Values: [HOME, WORK, OTHER]

email5

string

Email address 5 of the customer

emailDesc5

string

Email address 5 description  Values: [HOME, WORK, OTHER]

email6

string

Email address 6 of the customer

emailDesc6

string

Email address 6 description  Values: [HOME, WORK, OTHER]

preferredMethod

string

The preferred method of contact for the customer  Values: [PRIMARYPHONE, PAGER, HOMEFAX, WORKFAX, PRIMARYEMAIL]

blockPhoneFlag

boolean

Indicates whether or not to phone telephone advertising

blockEmailFlag

boolean

Indicates whether or not to block e-mail advertising

blockMailFlag

boolean

Indicates whether or not to block mail advertising

Name

Type

Summary

name

CreateUpdateName

contactMethods

ContactMethods

postalAddress

PostalAddress

Name

Type

Summary

first

string

The first name of the customer

middle

string

The middle name of the customer

last

string

The last name of the customer

prefix

string

The prefix of the customer

suffix

string

The suffix of the customer

Name

Type

Summary

customerId

string

The identifier of the customer record

name

Name

contactMethods

ContactMethods

postalAddress

PostalAddress

preferredContact

string

The preferred contact method  Values: [ANY, WORKFAX, PRIMARYEMAIL, HOMEFAX, MAIL, PAGER, PRIMARYPHONE, DONOTCONTACT]

links

CustomerLinks

Name

Type

Summary

items

array of (Customer)

Name

Type

Summary

self

LinkDescriptionObject

Name

Type

Summary

href

string

The target URI

method

string

The HTTP verb that MUST be used to make a request to the target of the link

title

string

The title property provides a title for the link and is a helpful documentation tool to facilitate understanding by end clients

Name

Type

Summary

first

string

The first name of the customer

middle

string

The middle name of the customer

last

string

The last name of the customer

prefix

string

The prefix of the customer

suffix

string

The suffix of the customer

companyName

string

If the customer represents a company, then company name will be considered

Name

Type

Summary

street

string

Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.

city

string

Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.

county

string

Handles administrative districts such as U.S. or U.K. counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.

state

string

A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.

postalCode

string

Postal code. Usually country-wide, but sometimes specific to the city (e.g. '2' in 'Dublin 2, Ireland' addresses).

country

string

The ISO country code of the country