Cinema Companies

Server

Operating companies behind cinemas.

List cinema companies

GET

https://api.cineamo.com

/cinema-companies

Returns a list of CinemaCompany objects.

List cinema companies › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

isPayoutConfigured

boolean

isAdsPayoutConfigured

boolean

List cinema companies › Responses

200

CinemaCompany list

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Create a cinema company

POST

https://api.cineamo.com

/cinema-companies

Creates a CinemaCompany. It returns the CinemaCompany object.

Create a cinema company › Request Body

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Create a cinema company › Responses

CinemaCompany was created

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

POST/cinema-companies

curl https://api.cineamo.com/cinema-companies \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "legalName": "Some Legal Name GmbH.",
  "displayName": "Some Display Name",
  "registrationNumber": "123-abc",
  "contactEmail": "some-contact-email@example.com",
  "invoiceEmail": "some-invoice-email@example.com",
  "phoneNumber": "+49301234567",
  "taxId": "12345678901",
  "status": "active",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "Address": {
    "street": "Some Street",
    "postalCode": "12345",
    "city": "DieStadt",
    "state": "Some state",
    "stateCode": "AB",
    "country": "Germany",
    "countryCode": "DE"
  },
  "hasPayoutConfig": true,
  "hasAdsPayoutConfig": true
}'

Example Request Body

{
  "id": 1,
  "legalName": "Some Legal Name GmbH.",
  "displayName": "Some Display Name",
  "registrationNumber": "123-abc",
  "contactEmail": "some-contact-email@example.com",
  "invoiceEmail": "some-invoice-email@example.com",
  "phoneNumber": "+49301234567",
  "taxId": "12345678901",
  "status": "active",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "Address": {
    "street": "Some Street",
    "postalCode": "12345",
    "city": "DieStadt",
    "state": "Some state",
    "stateCode": "AB",
    "country": "Germany",
    "countryCode": "DE"
  },
  "hasPayoutConfig": true,
  "hasAdsPayoutConfig": true
}

json

Example Responses

{
  "id": 1,
  "legalName": "Some Legal Name GmbH.",
  "displayName": "Some Display Name",
  "registrationNumber": "123-abc",
  "contactEmail": "some-contact-email@example.com",
  "invoiceEmail": "some-invoice-email@example.com",
  "phoneNumber": "+49301234567",
  "taxId": "12345678901",
  "status": "active",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "Address": {
    "street": "Some Street",
    "postalCode": "12345",
    "city": "DieStadt",
    "state": "Some state",
    "stateCode": "AB",
    "country": "Germany",
    "countryCode": "DE"
  },
  "hasPayoutConfig": true,
  "hasAdsPayoutConfig": true
}

json

application/json

Get a cinema company

GET

https://api.cineamo.com

/cinema-companies/{cinemaCompanyId}

Returns a CinemaCompany object by its Id.

Get a cinema company › path Parameters

cinemaCompanyId

integer · required

Get a cinema company › Responses

CinemaCompany details

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

GET/cinema-companies/{cinemaCompanyId}

curl https://api.cineamo.com/cinema-companies/:cinemaCompanyId

Example Responses

{
  "id": 1,
  "legalName": "Some Legal Name GmbH.",
  "displayName": "Some Display Name",
  "registrationNumber": "123-abc",
  "contactEmail": "some-contact-email@example.com",
  "invoiceEmail": "some-invoice-email@example.com",
  "phoneNumber": "+49301234567",
  "taxId": "12345678901",
  "status": "active",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "Address": {
    "street": "Some Street",
    "postalCode": "12345",
    "city": "DieStadt",
    "state": "Some state",
    "stateCode": "AB",
    "country": "Germany",
    "countryCode": "DE"
  },
  "hasPayoutConfig": true,
  "hasAdsPayoutConfig": true
}

json

application/json

Delete a cinema company

DELETE

https://api.cineamo.com

/cinema-companies/{cinemaCompanyId}

Deletes a CinemaCompany. It returns an empty response.

Delete a cinema company › path Parameters

cinemaCompanyId

string · required

Delete a cinema company › Responses

CinemaCompany was deleted

No data returned

Update a cinema company

PATCH

https://api.cineamo.com

/cinema-companies/{cinemaCompanyId}

Updates a CinemaCompany. It returns the updated CinemaCompany object.

Update a cinema company › path Parameters

cinemaCompanyId

integer · required

Update a cinema company › Request Body

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Update a cinema company › Responses

CinemaCompany was updated

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

PATCH/cinema-companies/{cinemaCompanyId}

curl https://api.cineamo.com/cinema-companies/:cinemaCompanyId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "legalName": "Some Legal Name GmbH.",
  "displayName": "Some Display Name",
  "registrationNumber": "123-abc",
  "contactEmail": "some-contact-email@example.com",
  "invoiceEmail": "some-invoice-email@example.com",
  "phoneNumber": "+49301234567",
  "taxId": "12345678901",
  "status": "active",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "Address": {
    "street": "Some Street",
    "postalCode": "12345",
    "city": "DieStadt",
    "state": "Some state",
    "stateCode": "AB",
    "country": "Germany",
    "countryCode": "DE"
  },
  "hasPayoutConfig": true,
  "hasAdsPayoutConfig": true
}'

Example Request Body

{
  "id": 1,
  "legalName": "Some Legal Name GmbH.",
  "displayName": "Some Display Name",
  "registrationNumber": "123-abc",
  "contactEmail": "some-contact-email@example.com",
  "invoiceEmail": "some-invoice-email@example.com",
  "phoneNumber": "+49301234567",
  "taxId": "12345678901",
  "status": "active",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "Address": {
    "street": "Some Street",
    "postalCode": "12345",
    "city": "DieStadt",
    "state": "Some state",
    "stateCode": "AB",
    "country": "Germany",
    "countryCode": "DE"
  },
  "hasPayoutConfig": true,
  "hasAdsPayoutConfig": true
}

json

Example Responses

{
  "id": 1,
  "legalName": "Some Legal Name GmbH.",
  "displayName": "Some Display Name",
  "registrationNumber": "123-abc",
  "contactEmail": "some-contact-email@example.com",
  "invoiceEmail": "some-invoice-email@example.com",
  "phoneNumber": "+49301234567",
  "taxId": "12345678901",
  "status": "active",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "Address": {
    "street": "Some Street",
    "postalCode": "12345",
    "city": "DieStadt",
    "state": "Some state",
    "stateCode": "AB",
    "country": "Germany",
    "countryCode": "DE"
  },
  "hasPayoutConfig": true,
  "hasAdsPayoutConfig": true
}

json

application/json

Cinema Chains Cinema Configurations

List cinema companies

GET

https://api.cineamo.com

/cinema-companies

Returns a list of CinemaCompany objects.

List cinema companies › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

isPayoutConfigured

boolean

isAdsPayoutConfigured

boolean

List cinema companies › Responses

200

CinemaCompany list

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Create a cinema company

POST

https://api.cineamo.com

/cinema-companies

Creates a CinemaCompany. It returns the CinemaCompany object.

Create a cinema company › Request Body

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Create a cinema company › Responses

CinemaCompany was created

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Get a cinema company

GET

https://api.cineamo.com

/cinema-companies/{cinemaCompanyId}

Returns a CinemaCompany object by its Id.

Get a cinema company › path Parameters

cinemaCompanyId

integer · required

Get a cinema company › Responses

CinemaCompany details

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Update a cinema company

PATCH

https://api.cineamo.com

/cinema-companies/{cinemaCompanyId}

Updates a CinemaCompany. It returns the updated CinemaCompany object.

Update a cinema company › path Parameters

cinemaCompanyId

integer · required

Update a cinema company › Request Body

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly

Update a cinema company › Responses

CinemaCompany was updated

CinemaCompany

id

integer · readOnly

legalName

string · readOnly

displayName

string | null · readOnly

registrationNumber

string | null · readOnly

contactEmail

string | null · readOnly

invoiceEmail

string | null · readOnly

phoneNumber

string | null · readOnly

taxId

string | null · readOnly

status

string | null · readOnly

createdDatetime

string | null · readOnly

readOnly

hasPayoutConfig

boolean · readOnly

hasAdsPayoutConfig

boolean · readOnly