The Filmchief REST API documentation
Getting started
Audience
This documentation is designed for people familiar with REST API programming and object-oriented programming concepts. You should also be familiar with Filmchief from a user's point of view. There are many REST API tutorials available on the Web.
In Filmchief, we recommend acquiring a Web developer role (ask your Administrator about this) and enable Show API column names on your My account page. This way, you will be able to navigate through the festival database to get a sense of its contents, and see the internal column names which you will be using in your API calls.
Prerequisites
Before you start, make sure that you have everything you need.
- A Light, Standard or Premium Filmchief license is required.
- The Filmchief API must be enabled.
- The Primary API user must be defined.
- The master API key
- An HTML editor
- A web server
About the Primary API user
The Primary API user is probably you: the person responsible for the API requests that are sent to our servers. If an API request fails, you will receive an error report that informs you about the details of what went wrong.
The Primary API user also serves as our primary contact for important notifications concerning the Filmchief API.
You can set the Primary API user at System About Filmchief.
Getting the master API key
To use the Filmchief REST API, you need the master API key. If your festival has a premium license, you will it at System About Filmchief
Connecting with the API
Before you can make any API calls, you need to connect with the API to obtain a token. To do this, include the following code in your project:
<?php
$filmchiefApiConnection = json_decode(
file_get_contents('https://«FESTIVAL IDENTIFIER».filmchief.com/api/php?key=' . password_hash('«MASTER API KEY»', PASSWORD_DEFAULT)),
true
);
?>
This code requires PHP 5.5 or higher to work, because of the password_hash function. If you have version 5.4 or less, you can download a PHP library here.
import bcrypt
import json
connectUrl = 'https://«FESTIVAL IDENTIFIER».filmchief.com/api/php?key=' + bcrypt.hashpw('«MASTER API KEY»', bcrypt.gensalt())
with open(connectUrl, 'r') as openFile:
content = openFile.read()
fileApiConnection = json.loads(content)
Note: Replace FESTIVAL IDENTIFIER with your festival’s subdomain name (the part before .filmchief.com) and MASTER API KEY with the key obtained from Filmchief.
Authentication
The filmchiefApiConnection object contains a token that you need to use in subsequent API calls. The token is valid for 5 minutes.
Reader module
A service for reading data from Filmchief.
| Endpoint | |
|---|---|
|
To use any of the methods in the
Reader module, call the following URL:https://«FESTIVAL IDENTIFIER».filmchief.com/api/php/Reader
|
|
token |
In each API call, you must specify the
token obtained in the authorization call described above. |
proc |
The requested method.
|
| + method parameters |
Include the parameters of the requested method in your API call.
|
| Methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
checkEmailAvailability |
Call this method to verify if an email address can be used to create a new account.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
checkSignIn |
Call this method to verify if the specified username (or email address) and password combination is valid and can be used to sign in.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getAccreditations |
Requests all accreditations in a specified event, optionally filtered by accreditation status.
Request
Response
Example:The following example retrieves information about all granted or pre-approved accreditations of the event with <?php
$params = array(
'token' => $filmchiefApiConnection['token'],
'proc' => 'getAccreditations',
'eventID' => 1,
'accreditationStatus' => 'granted,preapproved'
);
$url = 'https://«FESTIVAL IDENTIFIER».filmchief.com/api/php/Reader?' . http_build_query($params);
$data = json_decode(file_get_contents($url), true);
?>
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getAuthenticatedUrl |
Converts a URL (within the festival's filmchief.com subdomain) to a personalized link (also known as a "magic link"). When following a personalized link, the associated user is immediately signed in. If the user record is not yet associated with an account, the account will be immediately activated and the user will be asked to set a password, then taken to the targeted page.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getCreditDetails |
Requests all details of a credit identified by
creditID.Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getData |
This is the most universal method to request data from any specific table. The result set can be restricted to certain columns or rows (using filters), and it can be sorted.
Request
Response
Example:The following example retrieves event ID, name, publication level, start and end date of all main events, sorted by descending start date: <?php
$params = array(
'token' => $filmchiefApiConnection['token'],
'proc' => 'getData',
'table' => 'event',
'columns' => 'eventID,name,publicationLevel,startDate,endDate',
'filters' => 'abbreviation -column event.eventType ["main"]',
'orderBy' => 'startDate-'
);
$url = 'https://«FESTIVAL IDENTIFIER».filmchief.com/api/php/Reader?' . http_build_query($params);
$data = json_decode(file_get_contents($url), true);
?>
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getEvents |
Requests basic information about all events or a selection of events, based on the specified criteria.
Request
Response
Example:The following example requests information about all main events that took place in 2025: <?php
$params = array(
'token' => $filmchiefApiConnection['token'],
'proc' => 'getEvents',
'year' => 2025,
'eventType' => 'main'
);
$url = 'https://«FESTIVAL IDENTIFIER».filmchief.com/api/php/Reader?' . http_build_query($params);
$data = json_decode(file_get_contents($url), true);
?>
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getEventFullContent |
Requests all relevant programming content for one or more events. This method is especially useful for website integrations, because it avoids the need to make separate API calls for events, program lines, programs, viewings, films, locations, ticketing details and related entities.
The response is returned as a single normalized JSON object. Its structure follows the programming structure of an event: events contain program lines, program lines contain programs, programs contain viewings, and viewings contain films and viewing items. Relations between objects are expressed using ID values, so records do not need to be duplicated throughout the response.
Request
Response
Example:
The following example requests full content for the event with <?php
$params = array(
'token' => $filmchiefApiConnection['token'],
'proc' => 'getEventFullContent',
'eventIDmulti' => '1',
'localeCode' => 'en',
'inclusionMode' => 'cinema,hybrid'
);
$url = 'https://«FESTIVAL IDENTIFIER».filmchief.com/api/php/Reader?' . http_build_query($params);
$data = json_decode(file_get_contents($url), true);
?>
Example response structure:{
"accepted": true,
"data": {
"events": {
"1": {
"eventID": 1,
"name": "Example Film Festival 2026",
"hubName": "Example Film Festival Online",
"hubExternalSubsite": "hub",
"shopShowViewingIfNoTicketing": 1,
"shopShowViewingIfSaleNotStarted": 0,
"hubClosesEffective": "2026-07-05T21:59:00Z"
}
},
"programLines": {
"24": {
"programLineID": 24,
"title": "Documentary Competition",
"subtitle": "New international documentary films",
"code": "DOC",
"description": "A selection of urgent, cinematic documentaries from around the world.",
"color": "#E91E63",
"sortKey": 1,
"programs": [83],
"parentID": null,
"isMain": 1,
"eventID": 1,
"publicationTags": null
}
},
"programs": {
"83": {
"programID": 83,
"title": "Opening Program",
"subtitle": "Stories of home and belonging",
"code": "DOC 01",
"description": "Two short documentaries followed by a feature presentation.",
"longDescription": "This opening program explores memory, migration and the meaning of home across generations.",
"programLineID": 24,
"eventID": 1,
"color": "#E91E63",
"type": [
{
"value": "Documentary",
"abbr": "doc",
"color": ""
}
],
"programTags": [
"Opening Night",
"Q&A"
],
"presenceTimes": "fixed",
"publicationTags": null,
"mainFilmID": 209,
"viewings": [162]
}
},
"viewings": {
"162": {
"viewingID": 162,
"locationID": 10,
"programID": 83,
"programLineID": 24,
"eventID": 1,
"altTitle": null,
"additionalDescription": "Followed by a conversation with the director.",
"startDateTime": "2026-06-25T18:00:00Z",
"endDateTime": "2026-06-25T20:05:00Z",
"duration": 125,
"programDuration": 118,
"viewingDurationCalculated": 125,
"hubContentAvailabilityExpires": "2026-07-05T21:59:00Z",
"inclusionMode": "hybrid",
"status": "confirmed",
"canceled": 0,
"accessibilityProvisions": [
"Closed captions"
],
"languageVersion": [
"English subtitles"
],
"ticketPriceCategory": [
"Regular"
],
"audienceType": [
"Public"
],
"ticketsUrl": "https://example-festival.test/tickets/162",
"qas": [
{
"value": "Director Q&A",
"id": 501
}
],
"films": [209, 217],
"viewingItems": [642, 643, 644],
"availabilityTimes": [
{
"starts": "2026-06-25T18:00:00Z",
"ends": "2026-07-05T21:59:00Z"
}
]
}
},
"films": {
"209": {
"filmID": 209,
"created": "2026-01-12T09:30:00Z",
"originalTitle": "The River Remembers",
"englishTitle": "The River Remembers",
"useTitleFull": {
"sortValue": "River Remembers",
"value": "The River Remembers",
"html": "The River Remembers"
},
"trailerUrl": "https://example.com/trailers/the-river-remembers",
"vodUrl": "https://video.example.com/the-river-remembers",
"productionYear": 2026,
"director": [
{
"value": "Maya Verbeek",
"id": 301
}
],
"producer": [
{
"value": "Jonas Meier",
"id": 302
}
],
"synopsis": "A filmmaker returns to the river village where her family once lived and finds a community reshaping its future after decades of change.",
"durationMinutes": 94,
"viewings": [162],
"programs": [83],
"programLines": [24],
"events": [1],
"themeTags": [
"Memory",
"Migration"
],
"stillPrimary": [
{
"value": "river-remembers-still.jpg",
"name": "/files/river-remembers-still.jpg",
"nameRoot": "river-remembers-still",
"id": 9001
}
],
"productionCountry": [
"Netherlands",
"Germany"
],
"productionCountryAbbr": [
"NL",
"DE"
],
"dialogueLanguages": [
"Dutch",
"German"
],
"subtitleLanguage": [
"English"
],
"productionType": [
{
"value": "Documentary",
"abbr": "doc",
"color": null
}
]
},
"217": {
"filmID": 217,
"englishTitle": "Before the Lights",
"useTitleFull": {
"sortValue": "Before the Lights",
"value": "Before the Lights",
"html": "Before the Lights"
},
"productionYear": 2025,
"director": [
{
"value": "Samira Haddad",
"id": 319
}
],
"synopsis": "A short portrait of cinema volunteers preparing an old theatre for opening night.",
"durationMinutes": 18,
"viewings": [162],
"programs": [83],
"programLines": [24],
"events": [1],
"productionCountry": [
"Belgium"
],
"dialogueLanguages": [
"French"
],
"subtitleLanguage": [
"English"
]
}
},
"viewingItems": {
"642": {
"id": 642,
"viewingID": 162,
"filmID": 217,
"filmCopyID": null,
"onlineResourceID": null
},
"643": {
"id": 643,
"viewingID": 162,
"filmID": 209,
"filmCopyID": 88,
"onlineResourceID": 701
},
"644": {
"id": 644,
"viewingID": 162,
"filmID": null,
"filmCopyID": null,
"onlineResourceID": null
}
},
"locations": {
"10": {
"locationID": 10,
"venue": "Main Cinema",
"room": "Screen 1",
"abbreviation": "MC1",
"addressLine1": "Festivalplein 1",
"city": "Amsterdam",
"displayName": "Main Cinema | Screen 1",
"inclusionMode": "cinema",
"accessibilityProvisions": [
"Wheelchair accessible"
]
}
},
"sections": {
"51": {
"sectionID": 51,
"name": "Opening Night",
"sectionTypeID": 7,
"eventID": 1
}
},
"sectionTypes": {
"7": {
"sectionTypeID": 7,
"name": "Special programs"
}
},
"awards": {
"12": {
"awardID": 12,
"name": "Audience Award",
"eventID": 1
}
},
"products": {
"3": {
"productID": 3,
"name": "Regular ticket",
"description": "Access to one cinema screening.",
"eventID": 1,
"passID": null,
"startDateTime": "2026-05-01T08:00:00Z",
"endDateTime": null
},
"9": {
"productID": 9,
"name": "Online Festival Pass",
"description": "Access to selected online screenings during the festival.",
"eventID": 1,
"passID": 41,
"startDateTime": "2026-05-01T08:00:00Z",
"endDateTime": "2026-07-05T21:59:00Z"
}
},
"viewingTickets": {
"162": {
"viewingID": 162,
"saleStarted": true,
"soldOut": false,
"products": [3],
"ticketsUrl": "https://example-festival.test/tickets/162"
}
},
"organizations": {
"33": {
"organizationID": 33,
"name": "Example Film Institute"
}
},
"onlineResources": {
"701": {
"onlineResourceID": 701,
"templateID": 285,
"name": "Online screener",
"url": "https://video.example.com/the-river-remembers"
}
},
"templates": {
"285": {
"templateID": 285,
"systemName": "online-resource-templates/video"
}
},
"filmCopies": {
"88": {
"filmCopyID": 88,
"filmID": 209,
"format": "DCP",
"subtitles": "English"
}
},
"credits": {
"1001": {
"creditID": 1001,
"filmID": 209,
"name": "Maya Verbeek",
"function": "Director"
}
},
"passes": {
"41": {
"passID": 41,
"name": "Online Festival Pass",
"hubAccessGranted": 1,
"hubAllowFilmsOnDemand": 1,
"hubWatchPermissionGrantedNonTicketed": 1,
"hubWatchPermissionGranted": 1,
"hubAccessFrom": "2026-06-25T18:00:00Z",
"hubAccessUntil": "2026-07-05T21:59:00Z"
}
}
}
}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getEventDetails |
Requests all details of an event identified by
eventID or name. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getEventViewingSchedule |
Requests detailed information about an event identified by
eventID, which can be used to build a time schedule.Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getFilmCopyCPLs |
Requests the CPLs of all film copies used in one or more events, optionally filtered by
eventID or onlyUpdatedCPLsSince. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getFilmCopyDetails |
Requests all details of a film copy identified by
filmCopyID. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getFilmCredits |
Requests all details of credits of the specified film, identified by
filmID or idNr. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getFilmDetails |
Requests all details of a film identified by
filmID or idNr. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getFilmsShownInEvent |
Requests specified columns of films shown in the specified event (identified by
eventID). Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getImage deprecated |
Returns a URL to an image, optionally scaled to meet specified constraints.
Note: this method is deprecated: please see File access for a more powerful and easier to use solution. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getListData |
Requests data from any existing list. You may select all records from a list, or a paginated subset.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getMeetings |
Requests all meetings in the specified event.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getOnlineResources |
Requests all online resources in the specified event, or all online resources used in the specified viewing.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getOrderDetails |
Requests all details of a order identified by
orderID. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getOrganizationDetails |
Requests all details of an organization identified by
organizationID. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getProgramDetails |
Requests all details of a program identified by
programID. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getProgramItems |
Requests all items of a program identified by
programID. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getProgramLineDetails |
Requests all details of a program line identified by
programLineID. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getProgramLines |
Requests program lines in the specified event. Either all program lines, or only the main program lines are returned.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getPrograms |
Requests all programs in the specified event or program line.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getTicketingDetails |
Requests information relevant for ticketing of one or more viewings. Note: if Request
Response
Example:The following example retrieves online ticketing information of all viewings in a particular program (with Note how the value for <?php
// By default, assume no user is currently signed in:
$currentUserID = null;
// Check if session information from Filmchief is available:
if (isset($_SESSION['«FESTIVAL IDENTIFIER».filmchief.com'])
&& isset($_SESSION['«FESTIVAL IDENTIFIER».filmchief.com']['userID'])) {
// Get the ID of the currently signed in user (at the Filmchief Portal):
$currentUserID = $_SESSION['«FESTIVAL IDENTIFIER».filmchief.com']['userID'];
}
// Define API call parameters:
$params = array(
'token' => $filmchiefApiConnection['token'],
'proc' => 'getTicketingDetails',
'programID' => 598,
'currentUserID' => $currentUserID,
'pointOfSaleTypes' => 'online',
'onSaleNow' => 1
);
// Contruct the API call URL:
$url = 'https://«FESTIVAL IDENTIFIER».filmchief.com/api/php/Reader?' . http_build_query($params);
// Retrieve and decode the API call results:
$data = json_decode(file_get_contents($url), true);
?>
Example response:{
"data": [
{
"viewingID": 698,
"startDateTime": "2019-11-15 12:00:00Z",
"locationLabel": "Ketelhuis 1",
"programTitle": "Dutch Classics I: Musical Encounters",
"programSubtitle": "",
"programShortDescription": null,
"programLongDescription": null,
"onSaleNow": 1,
"saleStartDateTime": "2020-09-03T11:00:00Z",
"saleEndDateTime": "2019-11-15T11:45:00Z",
"currencySymbol": "€",
"ticketingDetails": [
{
"productID": 11,
"saleStartDateTime": "2019-09-02T14:29:00Z",
"productName": "Regular Ticket Test",
"productDescription": "Regular Ticket Test",
"saleEndDateTime": "2019-11-15T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 10,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
},
{
"productID": 12,
"saleStartDateTime": "2019-09-02T14:33:00Z",
"productName": "Student Tickets Test",
"productDescription": "Student Tickets Test",
"saleEndDateTime": "2019-11-15T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 8,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
},
{
"productID": 13,
"saleStartDateTime": "2019-09-02T14:39:00Z",
"productName": "Kid Tickets Test",
"productDescription": "Kid Tickets Test",
"saleEndDateTime": "2019-11-15T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 6.5,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
}
],
"ticketsRemaining": 143
},
{
"viewingID": 699,
"startDateTime": "2019-11-16 12:00:00Z",
"locationLabel": "Ketelhuis 3",
"programTitle": "Dutch Classics I: Musical Encounters",
"programSubtitle": "",
"programShortDescription": null,
"programLongDescription": null,
"onSaleNow": 1,
"saleStartDateTime": "2019-09-02T14:29:00Z",
"saleEndDateTime": "2019-11-16T11:45:00Z",
"currencySymbol": "€",
"ticketingDetails": [
{
"productID": 11,
"saleStartDateTime": "2019-09-02T14:29:00Z",
"productName": "Regular Ticket Test",
"productDescription": "Regular Ticket Test",
"saleEndDateTime": "2019-11-16T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 10,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
},
{
"productID": 12,
"saleStartDateTime": "2019-09-02T14:33:00Z",
"productName": "Student Tickets Test",
"productDescription": "Student Tickets Test",
"saleEndDateTime": "2019-11-16T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 8,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
},
{
"productID": 13,
"saleStartDateTime": "2019-09-02T14:39:00Z",
"productName": "Kid Tickets Test",
"productDescription": "Kid Tickets Test",
"saleEndDateTime": "2019-11-16T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 6.5,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
}
],
"ticketsRemaining": 50
},
{
"viewingID": 700,
"startDateTime": "2019-11-17 12:00:00Z",
"locationLabel": "Machinegebouw Grote zaal (4)",
"programTitle": "Dutch Classics I: Musical Encounters",
"programSubtitle": "",
"programShortDescription": null,
"programLongDescription": null,
"onSaleNow": 1,
"saleStartDateTime": "2019-09-02T14:29:00Z",
"saleEndDateTime": "2019-11-17T11:45:00Z",
"currencySymbol": "€",
"ticketingDetails": [
{
"productID": 11,
"saleStartDateTime": "2019-09-02T14:29:00Z",
"productName": "Regular Ticket Test",
"productDescription": "Regular Ticket Test",
"saleEndDateTime": "2019-11-17T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 10,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
},
{
"productID": 12,
"saleStartDateTime": "2019-09-02T14:33:00Z",
"productName": "Student Tickets Test",
"productDescription": "Student Tickets Test",
"saleEndDateTime": "2019-11-17T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 8,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
},
{
"productID": 13,
"saleStartDateTime": "2019-09-02T14:39:00Z",
"productName": "Kid Tickets Test",
"productDescription": "Kid Tickets Test",
"saleEndDateTime": "2019-11-17T11:45:00Z",
"promotionID": null,
"promotionName": null,
"promotionDescription": null,
"priceAmount": 6.5,
"priceNote": null,
"promotionAccreditationListID": null,
"promotionCodeSets": null
}
],
"ticketsRemaining": 180
}
],
"accepted": true
}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getUserDetails |
Requests all or specified details of a person identified by
userID. Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getViewings |
Requests all viewings in the specified event, or all viewings of the specified program.
Request
Response
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Writer module
A service for modifying data on Filmchief.
| Endpoint | |
|---|---|
|
To use any of the methods in the
Writer module, call the following URL:https://«FESTIVAL IDENTIFIER».filmchief.com/api/php/Writer
|
|
token |
In each API call, you must specify the
token obtained in the authorization call described above. |
proc |
The requested method.
|
| + method parameters |
Include the parameters of the requested method in your API call.
|
| Methods | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
inAppPurchaseComplete |
Call this method to register the in-app purchase of a single product by the app user. Based on the specified user and product, an order is created, validated, completed, and processed. Depending on the sold product type, Filmchief may generate a ticket, assign a pass. It will generate a receipt PDF and send a payment confirmation email. Note: order processing may take up to a minute to complete. Request
Response
|
||||||||||||||||||||||||||||
inAppRequestedOrderComplete |
Call this method to mark the order of an in-app payment request as complete, and to start processing the order. When an order is processed, depending on which products are sold, Filmchief may generate tickets, assign passes, generate a receipt PDF, and send a payment confirmation email. Request
Response
|
||||||||||||||||||||||||||||
update |
Call this method to directly update a cell in a record, or to add an update statement to an operation.
Request
Response
|
||||||||||||||||||||||||||||
userCreate |
Call this method to create a new user account. An account activation email will be sent to the specified email address.
Request
Response
|
||||||||||||||||||||||||||||
userDeactivate |
Call this method to deactivate a user account. From the user's perspective, the account is deleted, but the actual user details are preserved, because the festival may still need it. For instance, the user may be the director of a film; deleting the user record would result in loss of important information. After deactivation, the user's Status will be marked as "Deactivated account", and the user will no longer be able to sign in using this account. Request
Response
|
||||||||||||||||||||||||||||
userReset |
Call this method to let a user set a new password for their account. The user will receive an email with further instructions.
Request
Response
|
||||||||||||||||||||||||||||