Equipments

Server

Room equipment.

List equipments

GET

https://api.cineamo.com

/equipments

Returns a list of Equipment objects.

List equipments › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaId

integer

List equipments › Responses

Equipment list

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Create an equipment

POST

https://api.cineamo.com

/equipments

Creates an Equipment. It returns the Equipment object.

Create an equipment › Request Body

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Create an equipment › Responses

Equipment was created

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

POST/equipments

curl https://api.cineamo.com/equipments \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}'

Example Request Body

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

Example Responses

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

application/json

Get an equipment

GET

https://api.cineamo.com

/equipments/{equipmentId}

Returns an Equipment object by its Id.

Get an equipment › path Parameters

equipmentId

integer · required

Get an equipment › Responses

Equipment details

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Delete an equipment

DELETE

https://api.cineamo.com

/equipments/{equipmentId}

Deletes an Equipment. It returns an empty response.

Delete an equipment › path Parameters

equipmentId

integer · required

Delete an equipment › Responses

Equipment was deleted

No data returned

Update an equipment

PATCH

https://api.cineamo.com

/equipments/{equipmentId}

Updates an Equipment. It returns the updated Equipment object.

Update an equipment › path Parameters

equipmentId

integer · required

Update an equipment › Request Body

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Update an equipment › Responses

Equipment was updated

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

PATCH/equipments/{equipmentId}

curl https://api.cineamo.com/equipments/:equipmentId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}'

Example Request Body

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

Example Responses

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

application/json

Distinctions Featured Content

Cineamo API

Equipments

Server

Room equipment.

List equipments

GET

https://api.cineamo.com

/equipments

Returns a list of Equipment objects.

List equipments › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaId

integer

List equipments › Responses

Equipment list

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Create an equipment

POST

https://api.cineamo.com

/equipments

Creates an Equipment. It returns the Equipment object.

Create an equipment › Request Body

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Create an equipment › Responses

Equipment was created

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

POST/equipments

curl https://api.cineamo.com/equipments \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}'

Example Request Body

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

Example Responses

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

application/json

Get an equipment

GET

https://api.cineamo.com

/equipments/{equipmentId}

Returns an Equipment object by its Id.

Get an equipment › path Parameters

equipmentId

integer · required

Get an equipment › Responses

Equipment details

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Delete an equipment

DELETE

https://api.cineamo.com

/equipments/{equipmentId}

Deletes an Equipment. It returns an empty response.

Delete an equipment › path Parameters

equipmentId

integer · required

Delete an equipment › Responses

Equipment was deleted

No data returned

Update an equipment

PATCH

https://api.cineamo.com

/equipments/{equipmentId}

Updates an Equipment. It returns the updated Equipment object.

Update an equipment › path Parameters

equipmentId

integer · required

Update an equipment › Request Body

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

Update an equipment › Responses

Equipment was updated

Equipment

name

string · readOnly · required

count

integer · readOnly · required

countAvailable

integer · readOnly · required

isCountEnabled

boolean · readOnly · required

readOnly · required

id

integer | null · readOnly

PATCH/equipments/{equipmentId}

curl https://api.cineamo.com/equipments/:equipmentId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}'

Example Request Body

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

Example Responses

{
  "id": 1,
  "name": "default-name",
  "count": 1,
  "countAvailable": 1,
  "isCountEnabled": false,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  }
}

json

application/json

Distinctions Featured Content