Get an entrance

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/entrances/{entrance_id}

Get information about a specific entrance resource.

Responses

Response body

object

data

object

Entrance structure.

entrance_id

string

required

The unique ID of the entrance.

pos_id

integer

required

ID of POS system for tickets. Required with path parameter entrance ID. Possible values are: EPOS - 3 / skidata - 6 / axess - 9 / base - 11

3 6 9 11

name

string

Name of the entrance.

customer_id

string

The unique ID of the customer.

resort_name

string

Name of the resort where is an entrance charged.

customer_category_name

string

Name of the customer category.

external_order_id

string

ID of an external order creaded in POS system.

external_entrance_id

string

External ID of the entrance. Structure can be different depends of the POS system, that created the entrance.

external_turnstile_permission_id

string

External ID of the permission to open a turnstile. Structure can be different depends of the POS system, that created the permission.

entrance_type_id

integer

Type of the entrance Possible values are: season ticket - 0/ one day ticket -1/ multiple day ticket - 2

1 2

order_item_id

string

Order ID item represents relation between entrance and order item from carecloud e-shop.

card_id

string

required

ID of card used for charge entrance.

created_at

string

Date and time when entrance was created in CareCloud. (YYYY-MM-DD HH:MM:SS)

cancelled_at

string

Date and time when entrance was cancelled in CareCloud. (YYYY-MM-DD HH:MM:SS)

charged_price

float

Price charged to POS system.

product_ids

string

The unique ID of the product.

charge_date

string

Date and time when entrance will be/was charged to the POS system. (YYYY-MM-DD HH:MM:SS)

valid_from

string

Date of the first day when customer can use entrance. (YYYY-MM-DD)

valid_to

string

Date of the last day when customer can use entrance. (YYYY-MM-DD)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

required

State of the event type. Possible values are: 0 - cancelled / 1- active

1

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/entrances/entrance_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
25
 
1
{
2
  "data": {
3
    "entrance_id": "80a7be2e78aabc1454ca817265",
4
    "pos_id": 3,
5
    "name": "1 Dňový Skipas - Akcia 7.1. - 22.1.2015",
6
    "customer_id": null,
7
    "resort_name": null,
8
    "customer_category_name": null,
9
    "external_order_id": "d03df0e0-959a-11e4-a6ce-0050569b002b",
10
    "external_entrance_id": "1-1760-61-107788",
11
    "external_turnstile_permission_id": "1-1760-61-107788",
12
    "entrance_type_id": 1,
13
    "order_item_id": "84947e1aa1ad6982cc8188d15c",
14
    "card_id": "8c9fd120242ef646f477a5ed80",
15
    "created_at": "2015-01-06 12:54:46",
16
    "cancelled_at": "2015-01-09 22:38:48.088",
17
    "charged_price": null,
18
    "product_ids": null,
19
    "charge_date": "2015-01-10 00:00:00",
20
    "valid_from": null,
21
    "valid_to": null,
22
    "last_change": "2019-08-29 13:04:45",
23
    "state": 1
24
  }
25
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.