Cineamo API
integer · requiredintegerintegerstringstringstringstringstringstringbooleanintegerintegerintegerstringinteger | nullinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | nullstring | nullinteger | nullboolean | null · readOnlyboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean · readOnlyCineamo\AssetUrl | nullinteger | null · readOnlyinteger | null · readOnlybooleanstring | null · readOnly · deprecated
integerstringinteger | nullinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | nullstring | nullinteger | nullboolean | null · readOnlyboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean · readOnlyCineamo\AssetUrl | nullinteger | null · readOnlyinteger | null · readOnlybooleanstring | null · readOnly · deprecatedintegerstringinteger | nullinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | nullstring | nullinteger | nullboolean | null · readOnlyboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean · readOnlyCineamo\AssetUrl | nullinteger | null · readOnlyinteger | null · readOnlybooleanstring | null · readOnly · deprecated
integer · required
integer · requiredstring · requiredstring · requiredintegerstringinteger | nullinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | nullstring | nullinteger | nullboolean | null · readOnlyboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean · readOnlyCineamo\AssetUrl | nullinteger | null · readOnlyinteger | null · readOnlybooleanstring | null · readOnly · deprecated
integer · readOnlystring · readOnlystring | null · readOnlystring | null · readOnlyintegerstring | null · readOnlyinteger · readOnlystring · readOnlystring | null · readOnlystring | null · readOnlyintegerstring | null · readOnly
integer · requiredintegerstringinteger | nullinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | nullstring | nullinteger | nullboolean | null · readOnlyboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean · readOnlyCineamo\AssetUrl | nullinteger | null · readOnlyinteger | null · readOnlybooleanstring | null · readOnly · deprecated
integer · requiredintegerstringinteger | nullinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | nullstring | nullinteger | nullboolean | null · readOnlyboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean · readOnlyCineamo\AssetUrl | nullinteger | null · readOnlyinteger | null · readOnlybooleanstring | null · readOnly · deprecatedintegerstringinteger | nullinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | nullstring | nullinteger | nullboolean | null · readOnlyboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | nullboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean | null · readOnlyboolean · readOnlyCineamo\AssetUrl | nullinteger | null · readOnlyinteger | null · readOnlybooleanstring | null · readOnly · deprecated
string · requiredinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyboolean | null · readOnlyboolean | null · readOnlystring | null · readOnlyinteger · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyboolean | null · readOnlyboolean | null · readOnlystring | null · readOnlyinteger · readOnly
string · requiredinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger · readOnly
string · requiredinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger · readOnly
string · requiredinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyboolean | null · readOnlyboolean | null · readOnlystring | null · readOnlyinteger · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyboolean | null · readOnlyboolean | null · readOnlystring | null · readOnlyinteger · readOnly
string · requiredinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyboolean | null · readOnlyboolean | null · readOnlystring | null · readOnlyinteger · readOnlyinteger | null · readOnlyinteger | null · readOnlyinteger | null · readOnlyboolean | null · readOnlyboolean | null · readOnlystring | null · readOnlyinteger · readOnly
Auditoriums, room shapes and screens.
List cinema rooms
GET
https://api.cineamo.com
/cinema-rooms
Returns a list of CinemaRoom objects of one cinema. cinemaId is required.
query Parameters
cinemaIdpageperPagesortorderqueryavailableDatetimeStartavailableDatetimeEndembedhasScreenscreenSizeStartscreenSizeEndList cinema rooms › Responses
A list of CinemaRoom objects
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefCreate a cinema room
POST
https://api.cineamo.com
/cinema-rooms
Creates a cinema room. Returns the created cinema room.
Create a cinema room › Request Body
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefCreate a cinema room › Responses
Cinema room was created
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefDelete a cinema room
DELETE
https://api.cineamo.com
/cinema-room/{cinemaRoomId}
Soft-deletes a cinema room: the room is flagged as deleted and disappears from all read endpoints, while its seating layout, showings and sold tickets are preserved. Showtime synchronisation for the room is switched off at the same time, so the next import will not recreate it. Returns an empty response.
path Parameters
cinemaRoomIdDelete a cinema room › Responses
Cinema room was deleted
No data returned
Get a cinema room price
GET
https://api.cineamo.com
/cinema-rooms/{cinemaRoomId}/price
Calculates and returns the CinemaRoom price for the given period.
path Parameters
cinemaRoomIdquery Parameters
startDatetimeendDatetimeGet a cinema room price › Responses
CinemaRoom price for the given period
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefSet cinema room images
PUT
https://api.cineamo.com
/cinema-rooms/{cinemaRoomId}/images
Sets a list of Image objects (CinemaRoom images).
Set cinema room images › Request Body
idpathimageRefimageUrlpositionimageDescriptionSet cinema room images › Responses
200
A list of CinemaRoom Image objects were set
idpathimageRefimageUrlpositionimageDescriptionGet a cinema room
GET
https://api.cineamo.com
/cinema-rooms/{cinemaRoomId}
Returns the requested cinema room.
path Parameters
cinemaRoomIdGet a cinema room › Responses
Cinema room details
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefUpdate a cinema room
PATCH
https://api.cineamo.com
/cinema-rooms/{cinemaRoomId}
Updates a cinema room. Returns the updated cinema room.
path Parameters
cinemaRoomIdUpdate a cinema room › Request Body
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefUpdate a cinema room › Responses
Cinema Room was updated
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeId
seatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefUpdate a cinema room screen
PUT
https://api.cineamo.com
/cinema-rooms/{cinemaRoomId}/screen
Updates a CinemaRoom Screen. It returns the updated CinemaRoom Screen object.
path Parameters
cinemaRoomIdUpdate a cinema room screen › Request Body
widthheightsizeis3DReadyisImaxresolutionidUpdate a cinema room screen › Responses
CinemaRoom screen has been updated
widthheightsizeis3DReadyisImaxresolutionidGet a cinema room shape
GET
https://api.cineamo.com
/cinema-room-shapes/{cinemaRoomShapeId}
Reads a CinemaRoom Shape. It returns CinemaRoom Shape object.
path Parameters
cinemaRoomIdGet a cinema room shape › Request Body
widthdepthheightidGet a cinema room shape › Responses
200
CinemaRoom shape details
widthdepthheightidUpdate a cinema room shape
PUT
https://api.cineamo.com
/cinema-rooms/{cinemaRoomId}/shape
Updates a CinemaRoom Shape. It returns the updated CinemaRoom Shape object.
path Parameters
cinemaRoomIdUpdate a cinema room shape › Request Body
widthdepthheightidUpdate a cinema room shape › Responses
CinemaRoom shape has been updated
widthdepthheightidGet a screen
GET
https://api.cineamo.com
/screens/{screenId}
Reads a Screen. It returns Screen object.
path Parameters
screenIdGet a screen › Request Body
widthheightsizeis3DReadyisImaxresolutionidGet a screen › Responses
200
Screen details
widthheightsizeis3DReadyisImaxresolutionidGet a screen by cinema room
GET
https://api.cineamo.com
/cinema-rooms/{cinemaRoomId:\d+}/screen
Reads a Screen by CinemaRoom. It returns Screen object.
path Parameters
cinemaRoomIdGet a screen by cinema room › Request Body
widthheightsizeis3DReadyisImaxresolutionidGet a screen by cinema room › Responses
200
Screen details
widthheightsizeis3DReadyisImaxresolutionid