Cinema Configurations

Server

Per-cinema configuration.

List cinema configurations

GET

https://api.cineamo.com

/cinema-configurations

Returns a list of cinema configurations objects.

List cinema configurations › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaId

integer

isCatering

boolean

hasMarketingAssistantBooked

boolean

isProgramSuggestionEnabled

boolean

isPrivateBookingEnabled

boolean

isActive

boolean

isPrivateBookingPartner

boolean

isOnlineTicketingAvailable

boolean

isOnlineTicketingEnabled

boolean

isKOSCustomer

boolean

isWebsiteCustomer

boolean

List cinema configurations › Responses

200

CinemaConfiguration list

No data returned

Get a cinema configuration

GET

https://api.cineamo.com

/cinema-configurations/{cinemaConfigurationId}

Returns the requested cinema configuration.

Get a cinema configuration › path Parameters

cinemaConfigurationId

string · required

Get a cinema configuration › Responses

CinemaConfiguration details

CinemaConfiguration

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

GET/cinema-configurations/{cinemaConfigurationId}

curl https://api.cineamo.com/cinema-configurations/:cinemaConfigurationId

Example Responses

{
  "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"
}

json

application/json

Update a cinema configuration

PATCH

https://api.cineamo.com

/cinema-configurations/{cinemaConfigurationId}

Partial update of a cinema configuration (RFC 7396 merge-patch for websiteConfiguration)

Update a cinema configuration › path Parameters

cinemaConfigurationId

string · required

Update a cinema configuration › Request Body

CinemaConfiguration

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

Update a cinema configuration › Responses

200

CinemaConfiguration was updated

CinemaConfiguration

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

PATCH/cinema-configurations/{cinemaConfigurationId}

curl https://api.cineamo.com/cinema-configurations/:cinemaConfigurationId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
}'

Example Request Body

{
  "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"
}

json

Example Responses

{
  "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"
}

json

application/json

Cinema Companies Cinema Faqs

List cinema configurations

GET

https://api.cineamo.com

/cinema-configurations

Returns a list of cinema configurations objects.

List cinema configurations › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaId

integer

isCatering

boolean

hasMarketingAssistantBooked

boolean

isProgramSuggestionEnabled

boolean

isPrivateBookingEnabled

boolean

isActive

boolean

isPrivateBookingPartner

boolean

isOnlineTicketingAvailable

boolean

isOnlineTicketingEnabled

boolean

isKOSCustomer

boolean

isWebsiteCustomer

boolean

List cinema configurations › Responses

200

CinemaConfiguration list

No data returned

Get a cinema configuration

GET

https://api.cineamo.com

/cinema-configurations/{cinemaConfigurationId}

Returns the requested cinema configuration.

Get a cinema configuration › path Parameters

cinemaConfigurationId

string · required

Get a cinema configuration › Responses

CinemaConfiguration details

CinemaConfiguration

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

Update a cinema configuration

PATCH

https://api.cineamo.com

/cinema-configurations/{cinemaConfigurationId}

Partial update of a cinema configuration (RFC 7396 merge-patch for websiteConfiguration)

Update a cinema configuration › path Parameters

cinemaConfigurationId

string · required

Update a cinema configuration › Request Body

CinemaConfiguration

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

Update a cinema configuration › Responses

200

CinemaConfiguration was updated

CinemaConfiguration

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly