Cinema Cards

Server

Cinema loyalty/gift cards.

List cinema cards

GET

https://api.cineamo.com

/cinema-cards

Returns a list of CinemaCard objects.

List cinema cards › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaId

integer

creatorId

integer

types

string[]

activeDatetime

string

List cinema cards › Responses

CinemaCard list

CinemaCard

id

integer · readOnly

url

string | null · readOnly

name

string | null · readOnly

position

integer | null

type

string | null · readOnly

showCardTitle

boolean | null · readOnly

text

string | null · readOnly

buttonText

string | null · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly

GET/cinema-cards

curl https://api.cineamo.com/cinema-cards

Example Responses

{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}

json

application/json

Create a cinema card

POST

https://api.cineamo.com

/cinema-cards

Creates a CinemaCard. It returns the CinemaCard object.

Create a cinema card › Request Body

CinemaCard

id

integer · readOnly

url

string | null · readOnly

name

string | null · readOnly

position

integer | null

type

string | null · readOnly

showCardTitle

boolean | null · readOnly

text

string | null · readOnly

buttonText

string | null · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly

Create a cinema card › Responses

CinemaCard was created

CinemaCard

id

integer · readOnly

url

string | null · readOnly

name

string | null · readOnly

position

integer | null

type

string | null · readOnly

showCardTitle

boolean | null · readOnly

text

string | null · readOnly

buttonText

string | null · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly

POST/cinema-cards

curl https://api.cineamo.com/cinema-cards \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}'

Example Request Body

{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}

json

Example Responses

{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}

json

application/json

Get a cinema card

GET

https://api.cineamo.com

/cinema-cards/{cinemaCardId}

Returns a CinemaCard object by its Id.

Get a cinema card › path Parameters

cinemaCardId

integer · required

Get a cinema card › Responses

CinemaCard details

CinemaCard

id

integer · readOnly

url

string | null · readOnly

name

string | null · readOnly

position

integer | null

type

string | null · readOnly

showCardTitle

boolean | null · readOnly

text

string | null · readOnly

buttonText

string | null · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly

GET/cinema-cards/{cinemaCardId}

curl https://api.cineamo.com/cinema-cards/:cinemaCardId

Example Responses

{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}

json

application/json

Delete a cinema card

DELETE

https://api.cineamo.com

/cinema-cards/{cinemaCardId}

Deletes a CinemaCard. It returns an empty response.

Delete a cinema card › path Parameters

cinemaCardId

string · required

Delete a cinema card › Responses

CinemaCard was deleted

No data returned

Update a cinema card

PATCH

https://api.cineamo.com

/cinema-cards/{cinemaCardId}

Updates a CinemaCard. It returns the updated CinemaCard object.

Update a cinema card › path Parameters

cinemaCardId

integer · required

Update a cinema card › Request Body

CinemaCard

id

integer · readOnly

url

string | null · readOnly

name

string | null · readOnly

position

integer | null

type

string | null · readOnly

showCardTitle

boolean | null · readOnly

text

string | null · readOnly

buttonText

string | null · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly

Update a cinema card › Responses

CinemaCard was updated

CinemaCard

id

integer · readOnly

url

string | null · readOnly

name

string | null · readOnly

position

integer | null

type

string | null · readOnly

showCardTitle

boolean | null · readOnly

text

string | null · readOnly

buttonText

string | null · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly

PATCH/cinema-cards/{cinemaCardId}

curl https://api.cineamo.com/cinema-cards/:cinemaCardId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}'

Example Request Body

{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}

json

Example Responses

{
  "id": 1,
  "url": "https://",
  "name": "Partner card 1",
  "position": 1,
  "type": "web",
  "showCardTitle": "true",
  "text": "Partner card 1",
  "buttonText": "Partner card 1",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-card",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  }
}

json

application/json

Cinema Blogs Cinema Chains