Cinema Promotions

Server

Cinema promotions.

List cinema promotions

GET

https://api.cineamo.com

/cinema-promotions

Returns a list of CinemaPromotion objects.

List cinema promotions › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

activeDatetime

string

List cinema promotions › Responses

CinemaPromotion list

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Create a cinema promotion

POST

https://api.cineamo.com

/cinema-promotions

Creates a CinemaPromotion.

Create a cinema promotion › Request Body

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Create a cinema promotion › Responses

CinemaPromotion was created

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

POST/cinema-promotions

curl https://api.cineamo.com/cinema-promotions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}'

Example Request Body

{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}

json

Example Responses

{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}

json

application/json

Get a cinema promotion

GET

https://api.cineamo.com

/cinema-promotions/{cinemaPromotionId}

Returns a CinemaPromotion object by its Id.

Get a cinema promotion › path Parameters

cinemaPromotionId

integer · required

Get a cinema promotion › Responses

CinemaPromotion details

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

GET/cinema-promotions/{cinemaPromotionId}

curl https://api.cineamo.com/cinema-promotions/:cinemaPromotionId

Example Responses

{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}

json

application/json

Delete a cinema promotion

DELETE

https://api.cineamo.com

/cinema-promotions/{cinemaPromotionId}

Deletes a CinemaPromotion. It returns an empty response.

Delete a cinema promotion › path Parameters

cinemaPromotionId

integer · required

Delete a cinema promotion › Responses

CinemaPromotion was deleted

No data returned

Update a cinema promotion

PATCH

https://api.cineamo.com

/cinema-promotions/{cinemaPromotionId}

Updates a CinemaPromotion.

Update a cinema promotion › path Parameters

cinemaPromotionId

integer · required

Update a cinema promotion › Request Body

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Update a cinema promotion › Responses

200

CinemaPromotion was updated

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

PATCH/cinema-promotions/{cinemaPromotionId}

curl https://api.cineamo.com/cinema-promotions/:cinemaPromotionId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}'

Example Request Body

{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}

json

Example Responses

{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}

json

application/json

Cinema Products Cinema Rooms

List cinema promotions

GET

https://api.cineamo.com

/cinema-promotions

Returns a list of CinemaPromotion objects.

List cinema promotions › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

activeDatetime

string

List cinema promotions › Responses

CinemaPromotion list

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Create a cinema promotion

POST

https://api.cineamo.com

/cinema-promotions

Creates a CinemaPromotion.

Create a cinema promotion › Request Body

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Create a cinema promotion › Responses

CinemaPromotion was created

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Get a cinema promotion

GET

https://api.cineamo.com

/cinema-promotions/{cinemaPromotionId}

Returns a CinemaPromotion object by its Id.

Get a cinema promotion › path Parameters

cinemaPromotionId

integer · required

Get a cinema promotion › Responses

CinemaPromotion details

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Update a cinema promotion

PATCH

https://api.cineamo.com

/cinema-promotions/{cinemaPromotionId}

Updates a CinemaPromotion.

Update a cinema promotion › path Parameters

cinemaPromotionId

integer · required

Update a cinema promotion › Request Body

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

Update a cinema promotion › Responses

200

CinemaPromotion was updated

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly