Movie Customizations

Server

Per-context movie customizations.

List movie customizations

GET

https://api.cineamo.com

/movie-customizations

Returns a list of MovieCustomization objects.

List movie customizations › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

movieIds

integer[]

cinemaIds

integer[]

List movie customizations › Responses

MovieCustomization list

MovieCustomization

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

title

string | null · readOnly

description

string | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

iso6393

string | null · readOnly

ISO 639-3 language code

Example: deu

preferedTrailerUrl

string | null · readOnly

Custom trailer URL

Example: https://example.com/trailer.mp4

isActive

boolean · readOnly

GET/movie-customizations

curl https://api.cineamo.com/movie-customizations

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04: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"
    }
  },
  "movie": {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    }
  },
  "title": "Custom Movie Title",
  "description": "Custom movie description",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-poster",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-backdrop",
  "iso6393": "deu",
  "preferedTrailerUrl": "https://example.com/trailer.mp4",
  "isActive": true
}

json

application/json

Get a movie customization

GET

https://api.cineamo.com

/movie-customizations/{movieCustomization}

Returns a MovieCustomization object by its Id.

Get a movie customization › path Parameters

movieCustomization

integer · required

Get a movie customization › Responses

MovieCustomization details

MovieCustomization

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

title

string | null · readOnly

description

string | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

iso6393

string | null · readOnly

ISO 639-3 language code

Example: deu

preferedTrailerUrl

string | null · readOnly

Custom trailer URL

Example: https://example.com/trailer.mp4

isActive

boolean · readOnly

GET/movie-customizations/{movieCustomization}

curl https://api.cineamo.com/movie-customizations/:movieCustomization

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04: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"
    }
  },
  "movie": {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    }
  },
  "title": "Custom Movie Title",
  "description": "Custom movie description",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-poster",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-backdrop",
  "iso6393": "deu",
  "preferedTrailerUrl": "https://example.com/trailer.mp4",
  "isActive": true
}

json

application/json

Movie Copyrights Movie Ratings

List movie customizations

GET

https://api.cineamo.com

/movie-customizations

Returns a list of MovieCustomization objects.

List movie customizations › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

movieIds

integer[]

cinemaIds

integer[]

List movie customizations › Responses

MovieCustomization list

MovieCustomization

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

title

string | null · readOnly

description

string | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

iso6393

string | null · readOnly

ISO 639-3 language code

Example: deu

preferedTrailerUrl

string | null · readOnly

Custom trailer URL

Example: https://example.com/trailer.mp4

isActive

boolean · readOnly

Get a movie customization

GET

https://api.cineamo.com

/movie-customizations/{movieCustomization}

Returns a MovieCustomization object by its Id.

Get a movie customization › path Parameters

movieCustomization

integer · required

Get a movie customization › Responses

MovieCustomization details

MovieCustomization

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

title

string | null · readOnly

description

string | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

iso6393

string | null · readOnly

ISO 639-3 language code

Example: deu

preferedTrailerUrl

string | null · readOnly

Custom trailer URL

Example: https://example.com/trailer.mp4

isActive

boolean · readOnly