Get all entrances

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

Get a list of entrances in CRM CareCloud.

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

Direction of sorting the response list.

pos_id

integer

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

external_order_id

string

ID of an external order created in POS system.

name

string

Name of the charged entrance (product name is used from resource products).

resort_name

string

Name of the resort where is an entrance charged.

customer_category_name

string

Name of the customer category.

card_id

string

ID of a card used for charging entrance.

customer_id

string

The unique ID of the customer.

entrance_type_id

integer

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

state

integer

State of the entrance. Possible values are: canceled entrance - 0 / valid entrance -1

external_entrance_id

string

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

is_valid

boolean

in validity range - true / before or after validity range - false / no value - all

is_cancelled

boolean

Filter for canceled entrances.
Possible values: true - all cancelled entrances / false - all non cancelled entrances / no value - all entrances

valid_from

string

Date from when is record already valid. (YYYY-MM-DD)

valid_to

string

Date to when is record still valid. (YYYY-MM-DD)

product_id

string

ID of the product.

external_turnstile_permission_id

string

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

order_item_id

string

ID of an item from e-shop order.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

entrances

array of objects

List of available entrances.

entrances

object

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

total_items

integer

The number of all found entrances.

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?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


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

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.