28/09/2016 Swagger Editor

Europcar Customer API

Possible view for Customers are:<ul><li><b><u>full:</u></b> all available fragments</li><li><b><u>basic:</u></b>fragments identity + status</li><li><b>
<u>contact:</u></b> fragments identity+ status + addresses + phones + emails</li><li><b><u>cards:</u></b> fragments identity + status + cards</li></li>
Version 1.0

Paths
/customers/

http://editor.swagger.io/#/?tags=Customer 1/27
28/09/2016 Swagger Editor

Code Located Description Schema

Name Description Required Schema
GET /customers/
in

Customer

Summary
Search a list of customers given a list of criteria

Description
Search a list of customers given a list of criteria. The permitted combinations of parameters are: (firstName,lastName,soundex), (email), (phone), (extId).

Parameters
Located
Name Description Required Schema
in

firstName query First Name of the customer No ⇄ string

lastName query Last Name of the customer No ⇄ string

phone query Phone Number of the customer No ⇄ string

email query E­Mail of the customer No ⇄ string

Cross reference details.<br/>Parameter format is <code><ApplicationOwner>:

extId query <ApplicationCode>:<ObjectType>:<ObjectId></code><br/>Example: No ⇄ string
<code>EC:GWY:DVR:123456</code>

Wether or not the search should be done phonetically (with soundex algorithm). Default is
soundex query No ⇄ boolean
false.

view query Many views of customer are avaialble. No ⇄ string

Responses
Code Description Schema
▼ [
200 successful operation ⇄ Customer { }
▼

http://editor.swagger.io/#/?tags=Customer 2/27
28/09/2016 Swagger Editor

Code Description Schema

▼ error {
error
id: string
400 Bad Request ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
404 Not Found ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
default Unexpected error ⇄ description: string
messages: []

▼
}

Try this operation

http://editor.swagger.io/#/?tags=Customer 3/27
28/09/2016 Swagger Editor

Located
Name
POST /cust mers/Description Required Schema
ino

Customer

Summary
Create a new Customer

Description
Create a new Customer

Parameters
Located
Name Description Required Schema
in
▼ Customer {
Customer
id: string
identity: ▼ Identity {
Identity
firstName: string *
lastName: string *
dateOfBirth: string
cityOfBirth: string
countryOfBirthCd: string
countryOfBirthLb: string

▼
gender: string *
civility: string
countryOfResidenceCd: string
countryOfResidenceLb: string

▼
languageCd: string
prevLanguageCd: string
fiscalCd: string

▼
}
status: ▼ Status {
Status of the Customer
status: string *
The customer data to be

▼
customer body Yes ⇄ type: string *

▼
created.
driverStatus: string

▼
http://editor.swagger.io/#/?tags=Customer invalidatedAt: string 4/27
28/09/2016 Swagger Editor

Code Located Description Schema invalidatedAt: string

Name Description Required Schema
in indAuthOptin: boolean *
watchListed: string
}
addresses: ▼ [
Address { }

▼
]
phones: ▼ [
Phone { }

▼
]
emails: ▼ [
Email { }

▼
]
cards: ▼ [
Card { }

▼
]
externalIDs: ▼ [
The value will be ignored in the update
operation.
ExternalID { }

▼
]
}

Responses
Code Description Schema
▼ CustomerId {
200 successful operation ⇄ id: string *

▼
}
▼ error {
error
id: string
400 Bad Request ⇄ description: string
messages: []

▼
}

http://editor.swagger.io/#/?tags=Customer 5/27
28/09/2016 Swagger Editor

Code Description Schema

▼ error {
error
id: string
404 Not Found ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
default Unexpected error ⇄ description: string
messages: []

▼
}

Try this operation

/customers/{id}

http://editor.swagger.io/#/?tags=Customer 6/27
28/09/2016 Swagger Editor

Name
Code Located in
Description Description Schema Required Schema
GET /customers/{id}

Customer

Summary
View Customer details

Description
View Customer details

Parameters
Name Located in Description Required Schema

id path Customer unique identifier Yes ⇄ string

view query Many views of customer are avaialble. No ⇄ string

Responses
Code Description Schema
▼ Customer {
Customer
id: string
identity: ▼ Identity {
Identity
firstName: string *
lastName: string *
dateOfBirth: string
cityOfBirth: string
countryOfBirthCd: string
countryOfBirthLb: string

▼
gender: string *
civility: string
countryOfResidenceCd: string
countryOfResidenceLb: string

▼
languageCd: string
prevLanguageCd: string

http://editor.swagger.io/#/?tags=Customer fiscalCd: string 7/27

28/09/2016 Swagger Editor

Code Description Schema fiscalCd: string

▼
}
200 successful operation ⇄ status: ▼ Status {
Status of the Customer
status: string *

▼
type: string *

▼
driverStatus: string

▼
invalidatedAt: string
indAuthOptin: boolean *
watchListed: string
}
addresses: ▼ [
Address { }

▼
]
phones: ▼ [
Phone { }

▼
]
emails: ▼ [
Email { }

▼
]
cards: []

▼
externalIDs: []

▼
}
▼ error {
error
id: string
description: string
400 Bad Request ⇄
messages: ▼[
string
]
}

http://editor.swagger.io/#/?tags=Customer 8/27
28/09/2016 Swagger Editor

Code Description Schema

▼ error {
error
id: string
description: string
404 Not Found ⇄
messages: ▼[
string
]
}
▼ error {
error
id: string
description: string
default Unexpected error ⇄
messages: ▼[
string
]
}

Try this operation

http://editor.swagger.io/#/?tags=Customer 9/27
28/09/2016 Swagger Editor

Located
Name
PUT /custo ers/Description Required Schema
inm {id}
Customer

Summary
Update Customer details

Description
Update Customer details

Parameters
Located
Name Description Required Schema
in

Customer
id path unique Yes ⇄ string
identifier
▼ Customer {
Customer
id: string
identity: ▼ Identity {
Identity
firstName: string *
lastName: string *
dateOfBirth: string
cityOfBirth: string
countryOfBirthCd: string
countryOfBirthLb: ▼ string maxLength:35
The value will be ignored in the write
operations.
gender: string *
civility: string
countryOfResidenceCd: string
countryOfResidenceLb: ▼ string maxLength:35
The value will be ignored in the write
operations.
languageCd: string

http://editor.swagger.io/#/?tags=Customer prevLanguageCd: string 10/27

28/09/2016 Swagger Editor

Located prevLanguageCd: string

Name Description Required Schema
in
fiscalCd: string

▼
}
status: ▼ Status {
Status of the Customer
status: ▼ string * maxLength:1
N= New, O= One Time, R= Repeat, I= Inactive,
C= Cold, H= Hot
Enum:
► Array[6]

type: ▼ string * maxLength:1

C= Customer, P= Prospect
Enum:
► Array[2]

driverStatus: ▼ string maxLength:2

The value will be ignored in the write
operations. Updated only by Greenway
invalidatedAt: string
indAuthOptin: boolean *
watchListed: string
}
addresses: ▼ [
▼ Address {
Address information. Only one address by combination of
values (main,typeCd,approachType) must be defined by
customer.
id: string

▼
lines: []

▼
zipCd: string *
city: string *
countryCd: string *
countryLb: string

▼
stateCityProvDept: string
indAuthOptin: boolean
main: boolean *
typeCd: string *

▼
approachType: string *

▼
status: string
}

http://editor.swagger.io/#/?tags=Customer ] 11/27
28/09/2016 Swagger Editor

Located ]
Name Description Required Schema
in phones: ▼ [
▼ Phone {
Phone information. The combination of values
(main,phoneType,approachType,status) used must match with a
combination of values (main,typeCd,approachType,status) used
by one address of the customer.
id: string
areaCd: string *
number: string *
extension: string
The
typeCd: string *

▼
customer
customer body Yes ⇄ normalizedNumber: string

▼
data to be confidenceRank: integer

▼
updated. indAuthOptin: boolean
main: boolean *
phoneType: string *

▼
approachType: string *

▼
status: string
phoneMain: boolean *
}
]
emails: ▼ [
▼ Email {
Email information. The combination of values
(main,emailType,approachType) used must match with a
combination of values (main,typeCd,approachType) used by one
address of the customer.
id: string
email: string *
normalizedEmail: ▼ string maxLength:260
The value will be ignored in the write
operations.
confidenceRank: ▼ integer maximum:99
The value will be ignored in the write
operations.
indAuthOptin: boolean
main: boolean *
emailType: ▼ string * minLength:1 maxLength:1
H= home, P= Pro
http://editor.swagger.io/#/?tags=Customer Enum: 12/27
28/09/2016 Swagger Editor

Located Enum:
Name Description Required Schema ► Array[2]
in
approachType: ▼ string * minLength:1 maxLength:1
D= default, B= Billing
Enum:
► Array[2]

}
]
cards: ▼ [
▼ Card {
Card
id: string

▼
typeCd: ▼ string * minLength:3 maxLength:3
It's possible to define many cards with the
same typeCd by customer. CID= Id card, PAS=
Passport, DVL= Driving license, ECC=
EuropcarCard, PTN= Partner Card
Enum:
► Array[5]

typeLb: ▼ string
The value will be ignored in the write
operations.
subTypeCd: ▼ string maxLength:3
Each type of card can have a different sub
type domain. Used for exemple to descrybe
type of driving licence
subTypeDesc: string
number: string *
issueCountryCd: string
issueCountryLb: string

▼
issueCity: string
issueAuthority: string
issueDate: string
expirationDate: string
confidenceRank: integer

▼
}
]
externalIDs: ▼ [
The value will be ignored in the update operation.
▼ ExternalID {
External Customer ID.

http://editor.swagger.io/#/?tags=Customer uri: string 13/27

28/09/2016 Swagger Editor

Code Located Description uri:

Schema string

▼
Name Description Required Schema
in
main: boolean
}
]
}

Responses
Code Description Schema

200 successful operation

▼ error {
error
id: string
400 Bad Request ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
description: string
404 Not Found ⇄
messages: ▼[
string
]
}
▼ error {
error
id: string
description: string
default Unexpected error ⇄
messages: ▼[
string
]
}

Try this operation

http://editor.swagger.io/#/?tags=Customer 14/27
28/09/2016 Swagger Editor

Code
Name Located in Description Description Schema Required Schema
DELETE /customers/{id}
Customer

Summary
Delete a Customer

Description
Delete a Customer

Parameters
Name Located in Description Required Schema

id path Customer unique identifier Yes ⇄ string

Responses
Code Description Schema

204 successful operation

▼ error {
error
id: string
400 Bad Request ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
404 Not Found ⇄ description: string
messages: []

▼
}

http://editor.swagger.io/#/?tags=Customer 15/27
28/09/2016 Swagger Editor

Code Description Schema

▼ error {
error
id: string
default Unexpected error ⇄ description: string
messages: []

▼
}

Try this operation

/customers/{id}/cards

http://editor.swagger.io/#/?tags=Customer 16/27
28/09/2016 Swagger Editor

Name
Code Located in Description
Description Required
Schema Schema
POST /customers/{id}/cards
Customer

Summary
Create a new Card for a given customer

Description
Create a new Card for a given customer

Parameters
Name Located in Description Required Schema

id path Customer identifier Yes ⇄ string

▼ Card {
Card
id: string

▼
typeCd: string *

▼
typeLb: string

▼
subTypeCd: string

▼
subTypeDesc: string
number: string *
card body The Card to be created. Yes ⇄
issueCountryCd: string
issueCountryLb: string

▼
issueCity: string
issueAuthority: string
issueDate: string
expirationDate: string
confidenceRank: integer

▼
}

Responses
Code Description Schema

http://editor.swagger.io/#/?tags=Customer 17/27
28/09/2016 Swagger Editor

Code Description Schema

▼ CardId {
⇄ id: string *

▼
}
200 successful operation
▼ error {
error
id: string
400 Bad Request ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
404 Not Found ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
default Unexpected error ⇄ description: string
messages: []

▼
}

Try this operation

/customers/{id}/cards/{cardId}

http://editor.swagger.io/#/?tags=Customer 18/27
28/09/2016 Swagger Editor

Name
Code Located in Description
Description Required
Schema Schema
PUT /customers/{id}/cards/{cardId}

Customer

Summary
Update Card for a given customer

Description
Update Card for a given customer

Parameters
Name Located in Description Required Schema

id path Customer identifier Yes ⇄ string

cardId path Card unique identifier Yes ⇄ string

▼ Card {
Card
id: string

▼
typeCd: string *

▼
typeLb: string

▼
subTypeCd: string

▼
subTypeDesc: string
number: string *
card body The Card to be updated Yes ⇄
issueCountryCd: string
issueCountryLb: string

▼
issueCity: string
issueAuthority: string
issueDate: string
expirationDate: string
confidenceRank: integer

▼
}

Responses
Code Description Schema

http://editor.swagger.io/#/?tags=Customer 19/27
28/09/2016 Swagger Editor

Code Description Schema

200 successful operation

▼ error {
error
id: string
400 Bad Request ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
404 Not Found ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
default Unexpected error ⇄ description: string
messages: []

▼
}

Try this operation

http://editor.swagger.io/#/?tags=Customer 20/27
28/09/2016 Swagger Editor

Code
Name Description
Located in Description Schema Required Schema
DELETE /customers/{id}/cards/{cardId}
Customer

Summary
Delete a Card for a given customer

Description
Delete a Card for a given customer

Parameters
Name Located in Description Required Schema

id path Driver unique identifier Yes ⇄ string

cardId path Card unique identifier Yes ⇄ string

Responses
Code Description Schema

204 successful operation

▼ error {
error
id: string
400 Bad Request ⇄ description: string
messages: []

▼
}
▼ error {
error
id: string
404 Not Found ⇄ description: string
messages: []

▼
}

http://editor.swagger.io/#/?tags=Customer 21/27
28/09/2016 Swagger Editor

Code Description Schema

▼ error {
error
id: string
default Unexpected error ⇄ description: string
messages: []

▼
}

Try this operation

Models
Customer
▼ Customer {
Customer
id: string
identity: Identity { }
▼

status: Status { }
▼

⇄ addresses: []
▼

phones: []
▼

emails: []
▼

cards: []
▼

externalIDs: []
▼

Identity

http://editor.swagger.io/#/?tags=Customer 22/27
28/09/2016 Swagger Editor

▼ Identity {
Identity
firstName: string *
lastName: string *
dateOfBirth: string
cityOfBirth: string
countryOfBirthCd: string
countryOfBirthLb: string

▼
⇄
gender: string *
civility: string
countryOfResidenceCd: string
countryOfResidenceLb: string
▼

languageCd: string
prevLanguageCd: string
fiscalCd: string
▼

Status
▼ Status {
Status of the Customer
status: string *
▼

type: string *
▼

⇄ driverStatus: string
▼

invalidatedAt: string
indAuthOptin: boolean *
watchListed: string
}

Address

http://editor.swagger.io/#/?tags=Customer 23/27
28/09/2016 Swagger Editor

▼ Address {
Address information. Only one address by combination of values (main,typeCd,approachType) must be defined by customer.
id: string

▼
lines: []

▼
zipCd: string *
city: string *
countryCd: string *
⇄ countryLb: string

▼
stateCityProvDept: string
indAuthOptin: boolean
main: boolean *
typeCd: string *
▼

approachType: string *
▼

status: string
}

Phone

http://editor.swagger.io/#/?tags=Customer 24/27
28/09/2016 Swagger Editor

▼ Phone {
Phone information. The combination of values (main,phoneType,approachType,status) used must match with a combination of values
(main,typeCd,approachType,status) used by one address of the customer.
id: string
areaCd: string *
number: string *
extension: string
typeCd: string *

▼
⇄ normalizedNumber: string
▼
confidenceRank: integer
▼

indAuthOptin: boolean
main: boolean *
phoneType: string *
▼

approachType: string *
▼

status: string
phoneMain: boolean *
}

Email
▼ Email {
Email information. The combination of values (main,emailType,approachType) used must match with a combination of values
(main,typeCd,approachType) used by one address of the customer.
id: string
email: string *
normalizedEmail: string
▼

⇄
confidenceRank: integer
▼

indAuthOptin: boolean
main: boolean *
emailType: string *
▼

approachType: string *
▼

Card
http://editor.swagger.io/#/?tags=Customer 25/27
28/09/2016 Swagger Editor

Card
▼ Card {
Card
id: string

▼
typeCd: string *

▼
typeLb: string

▼
subTypeCd: string

▼
subTypeDesc: string
number: string *
⇄
issueCountryCd: string
issueCountryLb: string
▼

issueCity: string
issueAuthority: string
issueDate: string
expirationDate: string
confidenceRank: integer
▼

ExternalID
▼ ExternalID {
External Customer ID.
⇄ uri: string
▼

main: boolean
}

CustomerId
▼ CustomerId {
⇄ id: string *
▼

CardId

http://editor.swagger.io/#/?tags=Customer 26/27
28/09/2016 Swagger Editor

▼ CardId {
⇄ id: string *

▼
}

error
▼ error {
error
id: string
⇄
description: string
messages: []
▼

http://editor.swagger.io/#/?tags=Customer 27/27