API docs by Redocly

Visitor APIs (1.0.0)

Download OpenAPI specification:Download

Visitor API is the service that handle all data related to Westfield visitors.

Services

Endpoint related to Services

Retrieve list of services

Retrieve a list of services

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string

PC Code

endDateSince
string <date-time>

endDateSince

endDateUntil
string <date-time>

endDateUntil

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Create a service

Create a Service

Authorizations:
None
Request Body schema: application/json
required

Create a service

pcCode
required
string (PcCode)
name
required
string
category
required
string
useRate
required
string
daysOfUse
required
Array of integers
colorCode
required
string
isPremium
boolean
undeletable
boolean
startDate
string or null <date-time>
endDate
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "name": "La Bonne Excuse",
  • "category": "La Bonne Excuse",
  • "useRate": "La Bonne Excuse",
  • "daysOfUse": [
    ],
  • "colorCode": "#FFFFFF",
  • "isPremium": true,
  • "undeletable": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a Service

Retrieve a Service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update a Service

Update a Service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

Request Body schema: application/json
required

Update a Service

pcCode
string (PcCode)
name
string
category
string
useRate
string
daysOfUse
Array of integers
colorCode
string
isPremium
boolean
undeletable
boolean
startDate
string or null <date-time>
endDate
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "name": "La Bonne Excuse",
  • "category": "La Bonne Excuse",
  • "useRate": "La Bonne Excuse",
  • "daysOfUse": [
    ],
  • "colorCode": "#FFFFFF",
  • "isPremium": true,
  • "undeletable": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete Service

Delete Service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve a list of stores for a Service

Retrieve a list of stores for a Service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Add a store to a service

Add a store to a service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

Request Body schema: application/json
required

Add a store to a service

storeId
required
integer
storeName
required
string

Responses

Request samples

Content type
application/json
{
  • "storeId": 0,
  • "storeName": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete Service Store

Delete Service Store

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

storeId
required
integer

store_id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve a list of segments for a Service

Retrieve a list of segments for a Service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Add a segment to a service

Add a segment to a service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

Request Body schema: application/json
required

Add a segment to a service

segmentId
required
integer
segmentName
required
string

Responses

Request samples

Content type
application/json
{
  • "segmentId": 0,
  • "segmentName": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete Service Segment

Delete Service Segment

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

segmentId
required
integer

segment_id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve a list of a Service's themes

Retrieve a list of a Service's themes

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Add a theme to a service

Add a theme to a service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

Request Body schema: application/json
required

Add a theme to a service

serviceThemeId
required
integer

Responses

Request samples

Content type
application/json
{
  • "serviceThemeId": 117
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update a Service Theme

Update a Service Theme

Authorizations:
None
path Parameters
serviceThemeId
required
integer

service_theme_id

Request Body schema: application/json
required

Update a Service Theme

value
string
category
string (ThemeCategory)
Enum: "event" "service"
deprecated
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "La Bonne Excuse",
  • "category": "event",
  • "deprecated": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete Service Theme

Delete Service Theme

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

serviceThemeId
required
integer

service_theme_id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve a list of a Service's targets

Retrieve a list of a Service's targets

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Add a target to a service

Add a target to a service

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

Request Body schema: application/json
required

Add a target to a service

serviceTargetId
required
integer

Responses

Request samples

Content type
application/json
{
  • "serviceTargetId": 117
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update a Service Target

Update a Service Target

Authorizations:
None
path Parameters
serviceTargetId
required
integer

service_target_id

Request Body schema: application/json
required

Update a Service Target

value
string

Responses

Request samples

Content type
application/json
{
  • "value": "La Bonne Excuse"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete Service Target

Delete Service Target

Authorizations:
None
path Parameters
serviceId
required
integer

serviceId

serviceTargetId
required
integer

service_target_id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Add a theme to a service

Add a theme to a service

Authorizations:
None
Request Body schema: application/json
required

Add a theme to a service

value
required
string
category
required
string (ThemeCategory)
Enum: "event" "service"
deprecated
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "La Bonne Excuse",
  • "category": "event",
  • "deprecated": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a list of all Service Themes

Retrieve a list of all Service Themes

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Add a target to a service

Add a target to a service

Authorizations:
None
Request Body schema: application/json
required

Add a target to a service

value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "La Bonne Excuse"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a list of all Service Targets

Retrieve a list of all Service Targets

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Visitors

Endpoint related to Visitors

Add a new visitor

Add a new visitor

Authorizations:
None
Request Body schema: application/json
required

Create a new visitor

lastVisitDate
string <date-time>
addressCity
string or null
addressStreet
string or null
addressState
string or null
lastName
required
string
firstName
required
string
email
required
string <email>
gender
required
string
Enum: "m" "f" "u"
phone
string or null
mobileLocale
string or null
addressZipCode
string or null
timezone
string or null
billingAddress
string or null
billingAddress2
string or null
billingZipCode
string or null
billingCity
string or null
billingCountryCode
string (CountryCodeEnumNullable)
Enum: null "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
acquisitionPcCode
required
string (PcCode)
emailVerified
boolean
emailInvalid
boolean
phoneVerified
boolean
phoneInvalid
boolean
countryCode
required
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
birthDay
integer [ 1 .. 31 ]
birthMonth
integer [ 1 .. 12 ]
birthYear
integer
required
Array of objects (OptinPostRequestBody)

Responses

Request samples

Content type
application/json
{
  • "lastVisitDate": "2017-07-24T17:32:28.000Z",
  • "addressCity": "Paris",
  • "addressStreet": "3 rue de Paris",
  • "addressState": "Texas",
  • "lastName": "Smith",
  • "firstName": "John",
  • "email": "tom@jerry.com",
  • "gender": "m",
  • "phone": "33631573042",
  • "mobileLocale": "FR",
  • "addressZipCode": "75000",
  • "timezone": "Europe/Paris",
  • "billingAddress": "123 Billing St",
  • "billingAddress2": "Apt 4B",
  • "billingZipCode": "12345",
  • "billingCity": "Billing City",
  • "billingCountryCode": "FR",
  • "acquisitionPcCode": "FR-SC-123",
  • "emailVerified": true,
  • "emailInvalid": true,
  • "phoneVerified": true,
  • "phoneInvalid": true,
  • "countryCode": "FR",
  • "birthDay": 31,
  • "birthMonth": 8,
  • "birthYear": 1998,
  • "optins": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

List visitors

List visitors

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

countryCode
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
Example: countryCode=FR

Country code

barcode
string
Example: barcode=123456789123
email
string <email>
acquisitionPcCode
string (PcCode)
Example: acquisitionPcCode=FR-SC-123
accountType
string
Enum: "full" "partial"
originType
string
Example: originType=connect
isSmartparker
boolean
updatedSince
string <date-time>
createdSince
string <date-time>
query
string
queryBy
string
Enum: "email" "firstName" "lastName" "licensePlate" "externalId" "fullname"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update batch of visitors

Update the emailInvalid, phoneInvalide for batch of visitors

Authorizations:
None
Request Body schema: application/json
required
Array
visitorId
required
string
emailInvalid
boolean
phoneInvalid
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{}

Add a new partial visitor

Add a new partial visitor

Authorizations:
None
Request Body schema: application/json
required

Create a new partial visitor

lastName
string or null
firstName
required
string
email
required
string <email>
gender
string or null
Enum: "m" "f" "u"
phone
string or null
mobileLocale
string or null
timezone
string or null
countryCode
required
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
preferredCenter
required
string
required
Array of objects (OptinPostRequestBody)

Responses

Request samples

Content type
application/json
{
  • "lastName": "Smith",
  • "firstName": "John",
  • "email": "tom@jerry.com",
  • "gender": "m",
  • "phone": "33631573042",
  • "mobileLocale": "FR",
  • "timezone": "Europe/Paris",
  • "countryCode": "FR",
  • "preferredCenter": "string",
  • "optins": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Read visitors details

Read visitors details

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

visitorId
string <uuid>

Id of visitor

creationDateGte
string <date-time>

creationDateGte

creationDateLt
string <date-time>

creationDateLt

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Count visitors

Count visitors

Authorizations:
None
query Parameters
registeredSince
string <date-time>

registeredSince

registeredUntil
string <date-time>

registeredUntil

acquisitionPcCode
string

acquisitionPcCode

accountType
string
Enum: "full" "partial"

accountType

originType
string

originType

Responses

Response samples

Content type
application/json
{}

Update a visitor

Update a visitor

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Update a visitor

lastVisitDate
string <date-time>
addressCity
string or null
addressStreet
string or null
addressState
string or null
lastName
string
firstName
string
email
string <email>
gender
string
Enum: "m" "f" "u"
phone
string or null
mobileLocale
string or null
addressZipCode
string or null
timezone
string or null
billingAddress
string or null
billingAddress2
string or null
billingZipCode
string or null
billingCity
string or null
billingCountryCode
string (CountryCodeEnumNullable)
Enum: null "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
birthDay
integer or null [ 1 .. 31 ]
birthMonth
integer or null [ 1 .. 12 ]
birthYear
integer or null

Responses

Request samples

Content type
application/json
{
  • "lastVisitDate": "2017-07-24T17:32:28.000Z",
  • "addressCity": "Paris",
  • "addressStreet": "3 rue de Paris",
  • "addressState": "Texas",
  • "lastName": "Smith",
  • "firstName": "John",
  • "email": "tom@jerry.com",
  • "gender": "m",
  • "phone": "33631573042",
  • "mobileLocale": "FR",
  • "addressZipCode": "75000",
  • "timezone": "Europe/Paris",
  • "billingAddress": "123 Billing St",
  • "billingAddress2": "Apt 4B",
  • "billingZipCode": "12345",
  • "billingCity": "Billing City",
  • "billingCountryCode": "FR",
  • "birthDay": 31,
  • "birthMonth": 8,
  • "birthYear": 1998
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Read a visitor

Read a visitor

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete a visitor

Delete a visitor

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Monitor visitors

Monitor visitors

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "partialCommercial": 1,
  • "fullCommercialLoyalty": 1,
  • "fullCommercialNotLoyalty": 1,
  • "fullNotCommercialLoyalty": 1,
  • "fullNotCommercialNotLoyalty": 1
}

Bookmarks

Every route related to bookmarks

Create a bookmark

Create a bookmark

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create a bookmark

pcCode
required
string (PcCode)
externalId
required
string
label
required
string
bookmarkType
required
string (BookmarkType)
Enum: "store" "restaurant" "deal" "event" "news"
source
required
string (BookmarkSource)
Enum: "visitor" "lbe"

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "externalId": 647392,
  • "label": "adidas",
  • "bookmarkType": "store",
  • "source": "visitor"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve visitor’s bookmarks

Retrieve visitor’s bookmarks

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

bookmarkType
string
Enum: "store" "restaurant" "deal" "event" "news"

Type of bookmark

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve a bookmark

Retrieve a bookmark

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

bookmarkId
required
integer <int64>

ID of bookmark

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete a bookmark

Delete a bookmark

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

bookmarkId
required
integer <int64>

ID of bookmark

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

ExternalIds

Every route related to externalIds

Retrieve a batch of analyticsId by visitorId and externalType

Retrieve a batch of analyticsId by visitorId and externalType

Authorizations:
None
query Parameters
visitorId
required
string
Example: visitorId=foo,bar

List of visitorIds

externalType
string
Example: externalType=foo,bar

List of externalTypes

pcCode
string
Example: pcCode=FR-SC-123

Pc code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve Visitor Id by externalType and externalId

Retrieve Visitor Id by externalType and externalId

Authorizations:
None
path Parameters
externalType
required
string (ExternalType)
Enum: "designa" "facebook" "google" "cognito" "pas" "pas_barcode" "fid" "fid_barcode" "partner" "crm_id" "analytics" "wifi_device_id"

External type

externalId
required
string
Example: 2e90fe3b088c7b27a6d08

External ID

query Parameters
pcCode
string
Example: pcCode=FR-SC-123

Pc code

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Create external id for visitor

Create external id for visitor

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create a new externalId

externalId
required
string
pcCode
string or null
externalType
required
any
Enum: "designa" "facebook" "google" "cognito" "partner" "crm_id" "pas" "fid" "wifi_device_id"

Responses

Request samples

Content type
application/json
{
  • "externalId": "randomId",
  • "pcCode": "FR-SC-123",
  • "externalType": "designa"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve visitor’s external ids

Retrieve visitor’s external ids

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string
Example: pcCode=FR-SC-123

Pc code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve external id of a Visitor

Retrieve external id of a Visitor

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

externalType
required
string (ExternalType)
Enum: "designa" "facebook" "google" "cognito" "pas" "pas_barcode" "fid" "fid_barcode" "partner" "crm_id" "analytics" "wifi_device_id"

External type

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string
Example: pcCode=FR-SC-123

Pc code

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete visitor’s external id

Delete visitor’s external id

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

externalType
required
string
Enum: "designa" "facebook" "google" "cognito" "partner" "crm_id" "wifi_device_id"

External type

query Parameters
pcCode
string
Example: pcCode=FR-SC-123

Pc code

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete visitors by external ids

Delete visitors by external ids

Authorizations:
None
Request Body schema: application/json
required

Create a new externalId

Array ([ 1 .. 100 ] items)
analyticsId
required
string
pcCode
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{}

VisitorCenters

Every route related to visitorCenters

Create a visitor center

Create a new visitor center

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create a new visitor center

pcCode
required
string (PcCode)
isTlp
boolean
isFavorite
required
boolean
isSmartparker
boolean
centerCompanyId
integer or null <int64>

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "isTlp": true,
  • "isFavorite": true,
  • "isSmartparker": true,
  • "centerCompanyId": 123
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve visitor’s centers list

Retrieve visitor’s centers list

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update or create a visitor center

Update or create a visitor center

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Update or create a visitor center

pcCode
required
string (PcCode)
isTlp
boolean
isFavorite
boolean
isSmartparker
boolean
centerCompanyId
integer or null <int64>

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "isTlp": true,
  • "isFavorite": true,
  • "isSmartparker": true,
  • "centerCompanyId": 123
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a visitor center

Retrieve a visitor center

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

pcCode
required
string

pcCode

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update a visitor center

Update a visitor center

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

pcCode
required
string

pcCode

Request Body schema: application/json
required

Update a visitor center

isTlp
boolean
isFavorite
boolean
isSmartparker
boolean
centerCompanyId
integer or null <int64>

Responses

Request samples

Content type
application/json
{
  • "isTlp": true,
  • "isFavorite": true,
  • "isSmartparker": true,
  • "centerCompanyId": 123
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Devices

Endpoint related to devices

Register or Update visitor's device

Register or Update visitor's device

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create a new device

maker
string
model
string
osVersion
string
token
required
string
locale
string
platform
required
string
Enum: "ios" "android"
timezone
string
mobileCarrier
string
notificationToken
required
string
urwAppId
required
string (UrwAppId)
Enum: "aeroville" "alma" "amstelveen" "aupark" "bonaire" "cernymost" "confluence" "equinoccio" "fisketorvet" "garbera" "gropius" "hoefambruehl" "koln" "metropole" "minto" "nackaforum" "one" "parquesur" "pasing" "paunsdorf" "polygone" "riem" "ruhrpark" "soouest" "spandau" "splau" "toisondor" "ulis2" "wilenska" "wroclavia"

Responses

Request samples

Content type
application/json
{
  • "maker": "apple",
  • "model": "iPhone 13",
  • "osVersion": 16,
  • "token": "Token",
  • "locale": "string",
  • "platform": "ios",
  • "timezone": "string",
  • "mobileCarrier": "string",
  • "notificationToken": "string",
  • "urwAppId": "aeroville"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve visitor’s devices and apps

Retrieve visitor’s devices and apps

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve visitor’s device and app

Retrieve visitor’s device and app

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

deviceId
required
integer

deviceId

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete a device and app

Delete a device and app

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

deviceId
required
integer

deviceId

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve visitor’s apps

Retrieve visitor’s apps

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

deviceId
required
integer

deviceId

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Events

Endpoint related to events

Get an event token for the visitor

Get an event token for the visitor

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
companyId
required
string
Example: companyId=37042

Company ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Centers

Endpoint related to Centers

Add a new center

Add a new center

Authorizations:
None
Request Body schema: application/json
required

Create a new center

label
required
string
country
required
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
isWestfield
required
boolean
centerId
string
centerCode
integer
hasWorker
boolean
Default: false
hasMultiStep
boolean
Default: false
isActive
boolean
Default: false
hasEmailValidation
boolean
Default: true
loyaltyStartDate
string or null <date-time>
hasBasicLoyalty
boolean
Default: false
parkingPartner
string (ParkingPartner)
Enum: "smartparking_us" "smartparking_uk" "ilogs" "designa" "thales" "smartparking_v2"
walletContextId
integer or null
urwAppId
string or null
Enum: "aeroville" "alma" "amstelveen" "aupark" "bonaire" "cernymost" "confluence" "equinoccio" "fisketorvet" "garbera" "gropius" "hoefambruehl" "koln" "metropole" "minto" "nackaforum" "one" "parquesur" "pasing" "paunsdorf" "polygone" "riem" "ruhrpark" "soouest" "spandau" "splau" "toisondor" "ulis2" "wilenska" "wroclavia"
hasRegistration
boolean
Default: true
hasLoyalty
boolean
pcCode
required
string (PcCode)

Responses

Request samples

Content type
application/json
{
  • "label": "Les 4 Temps",
  • "country": "FR",
  • "isWestfield": true,
  • "centerId": "les4temps",
  • "centerCode": 3051,
  • "hasWorker": false,
  • "hasMultiStep": false,
  • "isActive": false,
  • "hasEmailValidation": true,
  • "loyaltyStartDate": "2019-08-24T14:15:22Z",
  • "hasBasicLoyalty": false,
  • "parkingPartner": "smartparking_us",
  • "walletContextId": 4321,
  • "urwAppId": "aeroville",
  • "hasRegistration": true,
  • "hasLoyalty": true,
  • "pcCode": "FR-SC-123"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

List centers

List centers

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

isActive
boolean

Center is active or not

country
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
Example: country=FR

Filter by country

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update a center

Update a center

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

Request Body schema: application/json
required

Update a center

label
string
country
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
isWestfield
boolean
centerId
string
centerCode
integer
hasWorker
boolean
Default: false
hasMultiStep
boolean
Default: false
isActive
boolean
Default: false
hasEmailValidation
boolean
Default: true
loyaltyStartDate
string or null <date-time>
hasBasicLoyalty
boolean
Default: false
parkingPartner
string (ParkingPartner)
Enum: "smartparking_us" "smartparking_uk" "ilogs" "designa" "thales" "smartparking_v2"
walletContextId
integer or null
urwAppId
string or null
Enum: "aeroville" "alma" "amstelveen" "aupark" "bonaire" "cernymost" "confluence" "equinoccio" "fisketorvet" "garbera" "gropius" "hoefambruehl" "koln" "metropole" "minto" "nackaforum" "one" "parquesur" "pasing" "paunsdorf" "polygone" "riem" "ruhrpark" "soouest" "spandau" "splau" "toisondor" "ulis2" "wilenska" "wroclavia"
hasRegistration
boolean
Default: true
hasLoyalty
boolean

Responses

Request samples

Content type
application/json
{
  • "label": "Les 4 Temps",
  • "country": "FR",
  • "isWestfield": true,
  • "centerId": "les4temps",
  • "centerCode": 3051,
  • "hasWorker": false,
  • "hasMultiStep": false,
  • "isActive": false,
  • "hasEmailValidation": true,
  • "loyaltyStartDate": "2019-08-24T14:15:22Z",
  • "hasBasicLoyalty": false,
  • "parkingPartner": "smartparking_us",
  • "walletContextId": 4321,
  • "urwAppId": "aeroville",
  • "hasRegistration": true,
  • "hasLoyalty": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Read a center

Read a center

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

CenterOperations

Endpoint related to Center Operations

Create a center operation session

Create a center operation session

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create a center operation session

pcCode
required
string (PcCode)
guid
required
string
gameId
required
string
gameName
required
string
optin
boolean
isContest
boolean
isWelcomeJourney
boolean
isWelcomeOffer
boolean
isWifit
boolean
isSynchronized
boolean

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "guid": "2e90f356-e66f-4332-b108-08c7b27a6d08",
  • "gameId": "2e90f356-e66f-4332-b108-08c7b27a6d08",
  • "gameName": "La Bonne Excuse",
  • "optin": true,
  • "isContest": true,
  • "isWelcomeJourney": true,
  • "isWelcomeOffer": true,
  • "isWifit": true,
  • "isSynchronized": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Get a list of center operation sessions

Get a list of center operation sessions

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string

PC Code

creationDateUntil
string <date-time>

creationDateUntil

creationDateSince
string <date-time>

creationDateSince

gameId
string

gameId

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {},
  • "required": null
}

Add a segment to center operation session

Add a segment to center operation session

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

guid
required
string

guid

Request Body schema: application/json
required

Create New Visitor CenterOperationSegments

Array ([ 1 .. 100 ] items)
id
required
string
name
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Add a store to center operation session

Add a store to center operation session

Authorizations:
None
path Parameters
visitorId
required
string

visitorId

guid
required
string

guid

Request Body schema: application/json
required

Create New Visitor CenterOperationStores

Array ([ 1 .. 100 ] items)
id
required
string
name
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Credit Cards

Endpoint related to Credit Cards

Create credit card

Create credit card

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
firstName
required
string
lastName
required
string
postalCode
string
serviceTypes
Array of strings (ServiceTypes)
Items Value: "parking"
year
required
integer
month
required
integer
fingerprint
required
string
cardType
required
string (CardType)
Enum: "american_express" "jcb" "visa" "master" "maestro" "discover"
firstSixDigits
required
string^\d{6}$
lastFourDigits
required
string^\d{4}$
paymentMethodToken
required
string

Responses

Request samples

Content type
application/json
{
  • "firstName": "Mark",
  • "lastName": "Smith",
  • "postalCode": 75000,
  • "serviceTypes": [
    ],
  • "year": 2025,
  • "month": 11,
  • "fingerprint": "string",
  • "cardType": "american_express",
  • "firstSixDigits": "string",
  • "lastFourDigits": "string",
  • "paymentMethodToken": "2kk1wXpfeVrzHJI6LfoOomX1yr1"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Get list of credit cards

Get list of credit cards

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

includeDeleted
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Get credit card

Get credit card

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

cardId
required
integer <Int64>

Id of credit card

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update credit card

Update credit card

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

cardId
required
integer <Int64>

Id of credit card

Request Body schema: application/json
required
firstName
string
lastName
string
postalCode
string
serviceTypes
Array of strings (ServiceTypes)
Items Value: "parking"
year
integer
month
integer

Responses

Request samples

Content type
application/json
{
  • "firstName": "Mark",
  • "lastName": "Smith",
  • "postalCode": 75000,
  • "serviceTypes": [
    ],
  • "year": 2025,
  • "month": 11
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete credit card

Delete credit card

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

cardId
required
integer <Int64>

Id of credit card

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Vehicles

Endpoint related to Vehicles

Create new vehicle

Create new vehicle

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
name
string or null
maker
string
color
string
model
string
licensePlate
required
string
licensePlateCountry
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
yearOfManufacture
integer [ 1800 .. 2500 ]
lastParkingSession
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "maker": "string",
  • "color": "string",
  • "model": "string",
  • "licensePlate": "string",
  • "licensePlateCountry": "FR",
  • "yearOfManufacture": 1800,
  • "lastParkingSession": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve list of vehicles

Retrieve list of vehicles

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

includeDeleted
boolean
licensePlate
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update visitor's vehicle

Update visitor's vehicle

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

vehicleId
required
integer

Id of vehicle

Request Body schema: application/json
required
name
string or null
maker
string
color
string
model
string
licensePlate
string
licensePlateCountry
string (CountryCodeEnum)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
yearOfManufacture
integer [ 1800 .. 2500 ]
lastParkingSession
string <date-time>
vehicleId
integer
deletionDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "maker": "string",
  • "color": "string",
  • "model": "string",
  • "licensePlate": "string",
  • "licensePlateCountry": "FR",
  • "yearOfManufacture": 1800,
  • "lastParkingSession": "2019-08-24T14:15:22Z",
  • "vehicleId": 0,
  • "deletionDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete visitor's vehicle

Delete visitor's vehicle

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

vehicleId
required
integer

Id of vehicle

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve visitor's vehicle

Retrieve visitor's vehicle

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

vehicleId
required
integer

Id of vehicle

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Vehicle Partners

Endpoint related to Vehicle Partners

Locales

Endpoint related to Locales

Retrive list of locale values

Retrive list of locales values

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{}

VisitorLocales

Endpoint related to VisitorLocales

Create new visitor locale

Create new visitor locale

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
localeCode
required
string

Responses

Request samples

Content type
application/json
{
  • "localeCode": "en_us"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrive list of visitor's locales

Retrive list of visitor's locales

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve visitor's locale

Retrieve visitor's locale

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

localeCode
required
string

Locale code

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete visitor's locale

Delete visitor's locale

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

localeCode
required
string

Locale code

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Checkins

Endpoint related to Checkins

Create new checkin

Create new checkin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
pcCode
required
string (PcCode)
serviceId
required
integer
origin
required
string
Enum: "partner" "dashboard"

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "serviceId": 0,
  • "origin": "partner"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrive list of visitor's checkins

Retrive list of visitor's checkins

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string

PC Code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve checkins by Center or Service

Retrieve checkins by Center or Service

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string

PC Code

serviceId
integer <int64>
checkedInSince
string <date-time>
checkedInUntil
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Create new checkin

Create new checkin

Authorizations:
None
Request Body schema: application/json
required
barcode
required
string <uuid>
pcCode
required
string (PcCode)
serviceId
required
integer
origin
required
string
Enum: "partner" "dashboard"

Responses

Request samples

Content type
application/json
{
  • "barcode": "258003c3-6699-4084-86b8-3204cc43d9c6",
  • "pcCode": "FR-SC-123",
  • "serviceId": 0,
  • "origin": "partner"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrive visitor's checkin

Retrive visitor's checkin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

checkinId
required
integer <Int64>
query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete visitor's checkin

Delete visitor's checkin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

checkinId
required
integer <Int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Parkings

Endpoint related to Parking

Register a parking

Register a parking

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create new parking

parkingPartner
required
string
Enum: "smartparking_us" "smartparking_uk" "ilogs" "designa" "thales" "smartparking_v2"

Responses

Request samples

Content type
application/json
{
  • "parkingPartner": "smartparking_us"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a visitor parkings

Retrieve a visitor parkings

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

parkingPartner
string
Enum: "smartparking_us" "smartparking_uk" "ilogs" "designa" "thales" "smartparking_v2"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve a parking information

Retrieve a parking information

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

parkingId
required
integer <uuid>
Example: 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000

Parking ID

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete a visitor parking

Delete a visitor parking

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

parkingId
required
integer
Example: 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000

Parking ID

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

ParkingHistories

Endpoint related to ParkingHistory

Create a new parking history

Create a new parking history

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create new parking history

parkingSessionStart
string <date-time>
parkingSessionEnd
string <date-time>
parkingSessionId
integer or null <int64>
amount
integer <Int64>
currency
required
string
Enum: "AUD" "EUR" "GBP" "NZD" "USD"
accessDevice
required
string
exitAccessDevice
string or null
formattedTotalTime
string
paidAt
string <date-time>
paidAtKiosk
boolean or null
refundedAmount
number or null
paymentStatus
string
Enum: "failed" "partial_refunded" "pending" "refunded" "succeeded"
totalTime
integer
transactionFullAmount
number or null
transactionId
string or null
transactionPretaxAmount
number or null
transactionTaxAmount
number or null
validationAmount
number or null
vendorId
string
parkingId
required
integer
cardId
required
integer
pcCode
required
string

Responses

Request samples

Content type
application/json
{
  • "parkingSessionStart": "2019-08-24T14:15:22Z",
  • "parkingSessionEnd": "2019-08-24T14:15:22Z",
  • "parkingSessionId": 0,
  • "amount": 12,
  • "currency": "AUD",
  • "accessDevice": "string",
  • "exitAccessDevice": "string",
  • "formattedTotalTime": "string",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "paidAtKiosk": true,
  • "refundedAmount": 31.4,
  • "paymentStatus": "failed",
  • "totalTime": 0,
  • "transactionFullAmount": 35,
  • "transactionId": "string",
  • "transactionPretaxAmount": 30.5,
  • "transactionTaxAmount": 31.4,
  • "validationAmount": 31.4,
  • "vendorId": "string",
  • "parkingId": 0,
  • "cardId": 0,
  • "pcCode": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a visitor parking history

Retrieve a visitor parking history

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

accessDevice
string

filter by license plate or barcode (accessDevice or exitAccessDevice)

parkingId
integer

parking ID

startDate
string <date-time>

startDate

endDate
string <date-time>

endDate

parkingSessionId
integer or null <int64>

filter by parkingSessionId

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update a visitor parkingHistory

Update a visitor parkingHistory

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

parkingHistoryId
required
integer <Int64>

ParkingHistoryId

Request Body schema: application/json
required

Update parking

parkingSessionStart
string <date-time>
parkingSessionEnd
string <date-time>
parkingSessionId
integer or null <int64>
amount
integer <Int64>
currency
string
Enum: "AUD" "EUR" "GBP" "NZD" "USD"
accessDevice
string
exitAccessDevice
string or null
formattedTotalTime
string
paidAt
string <date-time>
paidAtKiosk
boolean or null
refundedAmount
number or null
paymentStatus
string
Enum: "failed" "partial_refunded" "pending" "refunded" "succeeded"
totalTime
integer
transactionFullAmount
number or null
transactionId
string or null
transactionPretaxAmount
number or null
transactionTaxAmount
number or null
validationAmount
number or null
vendorId
string

Responses

Request samples

Content type
application/json
{
  • "parkingSessionStart": "2019-08-24T14:15:22Z",
  • "parkingSessionEnd": "2019-08-24T14:15:22Z",
  • "parkingSessionId": 42,
  • "amount": 12,
  • "currency": "AUD",
  • "accessDevice": "string",
  • "exitAccessDevice": "string",
  • "formattedTotalTime": "string",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "paidAtKiosk": true,
  • "refundedAmount": 31.4,
  • "paymentStatus": "failed",
  • "totalTime": 0,
  • "transactionFullAmount": 35,
  • "transactionId": "string",
  • "transactionPretaxAmount": 30.5,
  • "transactionTaxAmount": 31.4,
  • "validationAmount": 31.4,
  • "vendorId": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve a parking history

Retrieve a parking history

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

parkingHistoryId
required
integer <Int64>

ParkingHistoryId

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete a visitor parking history

Delete a visitor parking history

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

parkingHistoryId
required
integer <Int64>

ParkingHistoryId

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve a visitor parking history summary

Retrieve a visitor parking history summary

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

timezone
required
string
Example: timezone=Europe/Paris

timezone

parkingId
integer <Int64>

Parking ID

accessDevice
string

License Plate or barcode

pcCode
string

pcCode

Responses

Response samples

Content type
application/json
{}

Rewards

Endpoint related to Rewards

Add a reward for a visitor

Add a reward for a visitor

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

Create a new reward

pcCode
required
string (PcCode)
startDate
required
string <date-time>
endDate
string or null <date-time>
balance
required
number
isScan
boolean
isBank
boolean
isRestaurant
boolean
outsideOptin
required
boolean
threshold
required
integer
lastPurchaseDate
string or null <date-time>
externalId
string <uuid>
upgradedFrom
string
Enum: "android" "ios" "web" "partner" "other"

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "balance": 31.4,
  • "isScan": true,
  • "isBank": true,
  • "isRestaurant": true,
  • "outsideOptin": true,
  • "threshold": 2,
  • "lastPurchaseDate": "2019-08-24T14:15:22Z",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "upgradedFrom": "android"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a visitor rewards

Retrieve a visitor rewards

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string

PC Code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update a visitor reward

Update a visitor reward

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

rewardId
required
integer <uuid>
Example: 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000

rewardId

Request Body schema: application/json
required

Update a reward

startDate
string <date-time>
endDate
string or null <date-time>
balance
number
isScan
boolean
isBank
boolean
isRestaurant
boolean
threshold
integer
outsideOptin
required
boolean
lastPurchaseDate
string or null <date-time>
externalId
string <uuid>
upgradedFrom
string
Enum: "android" "ios" "web" "partner" "other"

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "balance": 31.4,
  • "isScan": true,
  • "isBank": true,
  • "isRestaurant": true,
  • "threshold": 2,
  • "outsideOptin": true,
  • "lastPurchaseDate": "2019-08-24T14:15:22Z",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "upgradedFrom": "android"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve visitor reward

Retrieve visitor reward

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

rewardId
required
integer <int64>

reward ID

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

CenterCompanies

Endpoint related to CenterCompany

Create center company

Create center company

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

Request Body schema: application/json
required

Create a new centerCompany

companyName
required
string

Responses

Request samples

Content type
application/json
{
  • "companyName": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve center companies

Retrieve center companies

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve center company

Retrieve center company

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

centerCompanyId
required
integer <int64>

centerCompanyId

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update center company

Update center company

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

centerCompanyId
required
integer <int64>

centerCompanyId

Request Body schema: application/json
required

Update a new centerCompany

companyName
required
string

Responses

Request samples

Content type
application/json
{
  • "companyName": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete a center company

Delete a center company

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

centerCompanyId
required
integer <int64>

centerCompanyId

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Interests

Endpoint related to Interests

Create interest list

Create interest list

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
externalId
required
string
label
required
string

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a list of interests

Retrieve a list of interests

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Batch update interests

Batch update interests

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
Array
externalId
required
string
label
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve a interest information

Retrieve a interest information

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

interestId
required
integer

Interest ID

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete visitor interest

Delete visitor interest

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

interestId
required
integer

interest id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Legal Texts

Endpoint related to Legal Texts

Retrieve a visitor's required consents for legal texts

Retrieve a visitor's required consents for legal texts

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
newCenter
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Create legal text

Create legal text

Authorizations:
None
Request Body schema: application/json
required
type
required
string (LegalType)
Enum: "terms" "commercial_email" "commercial_sms" "commercial_push" "privacy" "loyalty" "privacy_eu" "privacy_us" "smartparking_us" "sms_us" "wifi_privacy" "wifi_terms"
releaseDate
required
string <date-time>
requireConsent
boolean

Responses

Request samples

Content type
application/json
{
  • "type": "terms",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "requireConsent": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve list of legal texts

Retrieve list of legal texts

Authorizations:
None
query Parameters
legalType
string (LegalType)
Enum: "terms" "commercial_email" "commercial_sms" "commercial_push" "privacy" "loyalty" "privacy_eu" "privacy_us" "smartparking_us" "sms_us" "wifi_privacy" "wifi_terms"
version
integer
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

latest
boolean
locale
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve legal text

Retrieve legal text

Authorizations:
None
path Parameters
legalTextId
required
integer <Int64>
query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update legal text

Update legal text

Authorizations:
None
path Parameters
legalTextId
required
integer <Int64>
Request Body schema: application/json
required
releaseDate
string <date-time>
requireConsent
boolean

Responses

Request samples

Content type
application/json
{
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "requireConsent": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Add new locale to the Legal Text

Add new locale to the Legal Text

Authorizations:
None
path Parameters
legalTextId
required
integer <Int64>
localeCode
required
string

Locale code

Request Body schema: application/json
required
optinDisplayText
required
string or null
optinHeaderText
required
string or null
documentText
required
string or null

Responses

Request samples

Content type
application/json
{
  • "optinDisplayText": "string",
  • "optinHeaderText": "string",
  • "documentText": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a locale of the Legal Text

Retrieve a locale of the Legal Text

Authorizations:
None
path Parameters
legalTextId
required
integer <Int64>
localeCode
required
string

Locale code

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update legal text locales

Update legal text locale

Authorizations:
None
path Parameters
legalTextId
required
integer <Int64>
localeCode
required
string

Locale code

Request Body schema: application/json
required
optinDisplayText
string or null
optinHeaderText
string or null
documentText
string or null

Responses

Request samples

Content type
application/json
{
  • "optinDisplayText": "string",
  • "optinHeaderText": "string",
  • "documentText": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve locales of a legal text

Retrieve locales of a legal text

Authorizations:
None
path Parameters
legalTextId
required
integer <Int64>
query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Optins

Endpoint related to Optins

Retrieve list of visitor's optins

Retrieve list of visitor's optins

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

isActive
boolean
contextId
integer
latest
boolean
optinType
string (OptinType)
Enum: "commercial" "loyalty" "center" "privacy" "wallet" "terms" "smartparking_us" "sms_us"
optinChannel
string (OptinChannel)
Enum: "sms" "push" "email" "none"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Create visitor's optin

Create visitor's optin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
clientId
string
sendId
string
optinChannel
required
string (OptinChannel)
Enum: "sms" "push" "email" "none"
optinType
required
string (OptinType)
Enum: "commercial" "loyalty" "center" "privacy" "wallet" "terms" "smartparking_us" "sms_us"
legalTextId
integer or null
isActive
required
boolean
lastOpenedDate
string <date-time>
contextId
integer

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "sendId": "string",
  • "optinChannel": "sms",
  • "optinType": "commercial",
  • "legalTextId": 0,
  • "isActive": true,
  • "lastOpenedDate": "2019-08-24T14:15:22Z",
  • "contextId": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

delete visitor's optin

delete visitor's optin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
optinType
required
string (OptinType)
Enum: "commercial" "loyalty" "center" "privacy" "wallet" "terms" "smartparking_us" "sms_us"
optinChannel
required
string (OptinChannel)
Enum: "sms" "push" "email" "none"

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve visitor's optin

Retrieve visitor's optin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

optinId
required
integer <Int64>

Id of optin

query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update optin

Update optin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

optinId
required
integer <Int64>

Id of optin

Request Body schema: application/json
required
clientId
string
sendId
string

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "sendId": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Disable optin

Disable optin

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

optinId
required
integer <Int64>

Id of optin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Challenges

Endpoint related to Challenges

Add a new challenge

Add a new challenge

Authorizations:
None
Request Body schema: application/json
required

Create a new challenge

pcCode
required
string (PcCode)
genericName
required
string
type
required
string (ChallengeType)
Value: "step_counter"
startDate
required
string <date-time>
endDate
required
string <date-time>
timezone
string
imageUrl
string or null
winnerNumber
required
integer
rewardExpirationSeconds
integer or null
status
required
string
Enum: "draft" "active" "ended" "archived" "ready"
required
Array of objects (TranslationPostAttributes)
required
Array of objects (TranslationPostAttributes)
required
Array of objects (TranslationPostAttributes)

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "genericName": "challenge Les 4 Temps",
  • "type": "step_counter",
  • "startDate": "2020-01-01T00:00:00.000Z",
  • "endDate": "2020-01-01T00:00:00.000Z",
  • "timezone": "Europe/Paris",
  • "imageUrl": "https://www.example.com/image.png",
  • "winnerNumber": 1,
  • "rewardExpirationSeconds": 86400,
  • "status": "draft",
  • "displayName": [
    ],
  • "description": [
    ],
  • "rewardDetail": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Get all challenges

Get all challenges

Authorizations:
None
query Parameters
pcCode
string
Example: pcCode=FR-SC-150

PcCode of the challenge

type
string
Value: "step_counter"
Example: type=step_counter

Type of the challenge

startDate
string <date-time>
Example: startDate=2020-01-01T00:00:00.000Z

Start date of the challenge

endDate
string <date-time>
Example: endDate=2020-01-01T00:00:00.000Z

End date of the challenge

status
string
Enum: "draft" "active" "ended" "archived" "ready"

Status of the challenge

offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

fields
string
Example: fields=foo,bar

List of fields to return

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update a challenge

Update a challenge

Authorizations:
None
path Parameters
challengeId
required
integer <int64>

ID of challenge

Request Body schema: application/json
required

Update a challenge

pcCode
string (PcCode)
genericName
string
type
string (ChallengeType)
Value: "step_counter"
startDate
string <date-time>
endDate
string <date-time>
timezone
string
imageUrl
string or null
winnerNumber
integer
rewardExpirationSeconds
integer or null
status
string
Enum: "draft" "active" "ended" "archived" "ready"
Array of objects (TranslationPostAttributes)
Array of objects (TranslationPostAttributes)
Array of objects (TranslationPostAttributes)

Responses

Request samples

Content type
application/json
{
  • "pcCode": "FR-SC-123",
  • "genericName": "challenge Les 4 Temps",
  • "type": "step_counter",
  • "startDate": "2020-01-01T00:00:00.000Z",
  • "endDate": "2020-01-01T00:00:00.000Z",
  • "timezone": "Europe/Paris",
  • "imageUrl": "https://www.example.com/image.png",
  • "winnerNumber": 1,
  • "rewardExpirationSeconds": 86400,
  • "status": "draft",
  • "displayName": [
    ],
  • "description": [
    ],
  • "rewardDetail": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a challenge

Get a challenge

Authorizations:
None
path Parameters
challengeId
required
integer <int64>

ID of challenge

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Delete a challenge

Delete a challenge

Authorizations:
None
path Parameters
challengeId
required
integer <int64>

ID of challenge

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get visitor challenges

Get visitor challenges

Authorizations:
None
path Parameters
challengeId
required
integer <int64>

ID of challenge

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

fields
string
Example: fields=foo,bar

List of fields to return

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

rewardUnlocked
boolean
Example: rewardUnlocked=false

Challenge reward unlocked

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Terminate challenge

Terminate challenge

Authorizations:
None
path Parameters
challengeId
required
integer <int64>

ID of challenge

Request Body schema: application/json
ignoreEndDate
required
boolean

Responses

Request samples

Content type
application/json
{
  • "ignoreEndDate": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

VisitorChallengeHistories

Endpoint related to VisitorChallengeHistories

VisitorSmartparking

Endpoint related to VisitorSmartparking

Articles

Add a Article

Add a Article

Authorizations:
None
Request Body schema: application/json
required

create a Article

genericName
required
string
mainImageUrl
required
string
status
required
string
Enum: "draft" "ready" "published" "archived"
publishDate
required
string <date-time>
Array of objects (TranslationPostAttributes)
Array of objects (TranslationPostAttributes)

Responses

Request samples

Content type
application/json
{
  • "genericName": "string",
  • "mainImageUrl": "string",
  • "status": "draft",
  • "publishDate": "2019-08-24T14:15:22Z",
  • "title": [
    ],
  • "content": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a list of Articles

Retrieve a list of Articles

Authorizations:
None
query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

fields
string
Example: fields=foo,bar

List of fields to return

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

status
string
Enum: "draft" "ready" "published" "archived"
Example: status=archived
publishDateSince
string
Example: publishDateSince=2023-09-01
publishDateUntil
string
Example: publishDateUntil=2023-10-01

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Retrieve a Article

Retrieve a Article

Authorizations:
None
path Parameters
articleId
required
number
Example: true
query Parameters
fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Update a Article

Update a Article

Authorizations:
None
path Parameters
articleId
required
number
Example: true
Request Body schema: application/json
required

update a Article

genericName
string
mainImageUrl
string
status
string
Enum: "draft" "ready" "published" "archived"
publishDate
string <date-time>
Array of objects (TranslationPostAttributes)
Array of objects (TranslationPostAttributes)

Responses

Request samples

Content type
application/json
{
  • "genericName": "string",
  • "mainImageUrl": "string",
  • "status": "draft",
  • "publishDate": "2019-08-24T14:15:22Z",
  • "title": [
    ],
  • "content": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete a Article

Delete a Article

Authorizations:
None
path Parameters
articleId
required
number
Example: true

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

VehiclePartners

Create new vehicle partner

create new vehicle partner

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required
visitorId
string <uuid> (VisitorId)
vehicleId
required
integer
partnerId
required
string
parkingPartner
required
string
Enum: "smartparking_us" "smartparking_uk" "ilogs" "designa" "thales" "smartparking_v2"
visitorCenterId
integer
pcCode
string

Responses

Request samples

Content type
application/json
{
  • "visitorId": "e45934e1-5fd4-4651-b7bc-50c977a3b8c5",
  • "vehicleId": 2131,
  • "partnerId": "123-ABC-123",
  • "parkingPartner": "smartparking_us",
  • "visitorCenterId": 1231,
  • "pcCode": "FR-SC-75"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve list of vehicle partners

Retrieve list of vehicle partners

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Delete visitor's vehicle partner

Delete visitor's vehicle partner

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

vehiclePartnerId
required
integer

Id of a vehicle partner

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Scopes

Retrieve authorization scopes

Retrieve authorization scopes

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

VisitorChallenges

Add a VisitorChallenge

Add a VisitorChallenge

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

Request Body schema: application/json
required

create a VisitorChallenge

challengeId
required
integer
registeredAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "challengeId": 0,
  • "registeredAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {}
}

Retrieve a list of VisitorChallenges

Retrieve a list of VisitorChallenges

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

fields
string
Example: fields=foo,bar

List of fields to return

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

pcCode
string

PcCode of center

type
string (ChallengeType)
Value: "step_counter"
Example: type=step_counter

Type of challenge

registerDateSince
string <date-time>
registerDateUntil
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

Update a VisitorChallenge

Update a VisitorChallenge

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

visitorChallengeId
required
integer

Id of Visitor challenge

Request Body schema: application/json
required

update a VisitorChallenge

points
integer
totalEntryCount
integer
bonusEntryCount
integer
lastEntryDate
string or null <date-time>
rewardUnlocked
boolean
rewardReceived
boolean

Responses

Request samples

Content type
application/json
{
  • "points": 0,
  • "totalEntryCount": 0,
  • "bonusEntryCount": 0,
  • "lastEntryDate": "2019-08-24T14:15:22Z",
  • "rewardUnlocked": true,
  • "rewardReceived": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

add points to a VisitorChallenge

add points to a VisitorChallenge

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

visitorChallengeId
required
integer

Id of Visitor challenge

Request Body schema: application/json
required

add points to a VisitorChallenge

points
required
integer

Responses

Request samples

Content type
application/json
{
  • "points": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete a VisitorChallenge

Delete a VisitorChallenge

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

visitorChallengeId
required
integer

Id of Visitor challenge

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

VisitorRankings

Retrieve a list of VisitorRankings

Retrieve a list of VisitorRankings

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

pcCode
string
Example: pcCode=FR-SC-150

The center's pcCode linked to a challenge

type
string (ChallengeType)
Value: "step_counter"
Example: type=step_counter

The challenge's type

registerDateSince
string <date-time>
Example: registerDateSince=2020-01-01T00:00:00.000Z

register date since of the challenge

registerDateUntil
string <date-time>
Example: registerDateUntil=2020-01-01T00:00:00.000Z

register date until of the challenge

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {}
}

ChallengeHistories

Retrieve a list of ChallengeHistories

Retrieve a list of VisitorChallenges

Authorizations:
None
path Parameters
visitorId
required
string <uuid>

Id of visitor

query Parameters
challengeId
integer <int64>

ID of challenge

Responses

Response samples

Content type
application/json
[
  • {
    }
]

smartparking

Post a smartparking entry

If a license plate is given, we will check in the database with a vehicle that 1) matches the license plate, 2) is not deleted and 3) is the latest updated plate.
If a visitorId or a barcode is given we will check with the visitors existing in the database.
If multiple 'ID' fields (barcode, visitorId, licensePlate) are given, we will check, alongside the above rules, that they all match with the same Visitor.

Authorizations:
None
path Parameters
visitType
required
string
Enum: "entry" "exit"

The type of visit, either entry or exit

Request Body schema: application/json

The smartparking payload object

visitorId
string

On of the 3 ID fields. At least one of the 3 is mandatory. If multiple are given we will check that they match the same visitor.

barcode
string

On of the 3 ID fields. At least one of the 3 is mandatory. If multiple are given we will check that they match the same visitor.

licensePlate
string

On of the 3 ID fields. At least one of the 3 is mandatory. If multiple are given we will check that they match the same visitor.

pcCode
required
string

The pcCode (ID) of the center (mall) that makes the request

Responses

Request samples

Content type
application/json
{
  • "visitorId": "string",
  • "barcode": "string",
  • "licensePlate": "string",
  • "pcCode": "string"
}

Response samples

Content type
application/json
{
  • "visitorId": "string",
  • "pcCode": "string",
  • "visitDate": "2019-08-24T14:15:22Z",
  • "visitType": "entry",
  • "licensePlate": "string"
}

Get a visitor's smartparking entries

If a licenseplate is given, we will check in the database with a vehicle that 1) matches the license plate, 2) has a null deleted date and 3) is the latest update date.
If a visitorId or a barcode is given we will check with the visitors existing in the database.
If multiple 'ID' fields (barcode, visitorId, licensePlate) are given, we will check alongside the above rules that they all match with the same Visitor.

Authorizations:
None
path Parameters
pcCode
required
string

pcCode

query Parameters
visitorId
string

On of the 3 ID fields. At least one of the 3 is mandatory. If multiple are given we will check that they match the same visitor.

barcode
string

On of the 3 ID fields. At least one of the 3 is mandatory. If multiple are given we will check that they match the same visitor.

licensePlate
string

On of the 3 ID fields. At least one of the 3 is mandatory. If multiple are given we will check that they match the same visitor.

visitDateSince
string

Filter out the results with visitDate >= visitDateSince

visitDateUntil
string

Filter out the results with visitDate <= visitDateSince

visitType
string
Enum: "entry" "exit"

Filter out the results on the visit type. By default all types are returned.

offset
integer <int64> >= 1

Skip given number of records

limit
integer <int64> [ 1 .. 500 ]
Default: 25

Limit number of records

sort
string
Example: sort=-creationDate,-updateDate

Sort records by

fields
string
Example: fields=foo,bar

List of fields to return

Responses

Response samples

Content type
application/json
[
  • {
    }
]