API Reference

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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.

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.

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.

string
enum

Direction of sorting the response list.

Allowed:
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:
string

ID of an external order created in POS system.

string

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

string

Name of the resort where is an entrance charged.

string

Name of the customer category.

string

ID of a card used for charging entrance.

string

The unique ID of the customer.

integer
enum

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

Allowed:
integer
enum

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

Allowed:
string

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

boolean
enum

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

Allowed:
boolean
enum

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

Allowed:
string

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

string

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

string

ID of the product.

string

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

string

ID of an item from e-shop order.

Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

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.

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago