Get all entrances

get

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

Get a list of entrances in the CareCloud platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

enum

Direction of sorting the response list.

Allowed:

pos_id

integer

enum

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

Allowed:

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. GET /cards

customer_id

string

The unique ID of the customer. GET /customers

entrance_type_id

integer

enum

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

Allowed:

state

integer

enum

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

Allowed:

external_entrance_id

string

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

is_valid

boolean

enum

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

Allowed:

is_cancelled

boolean

enum

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

Allowed:

valid_from

string

Start of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).

valid_to

string

End of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).

product_id

string

The unique ID of the product. GET /products

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

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.