sorting |
sortBy
|
SortByEnum |
|
|
sorting |
order
|
SortOrderEnum
|
|
|
scope |
scope
|
QueryScopeEnum
|
|
|
pagination |
page
|
Number |
|
|
pagination |
size
|
Number |
|
|
fields projection |
fields
|
List<FieldNameEnum> |
<fields> <field>titles</field> <field>status</field> <field>participants</field> </fields>
|
"fields" : [ "titles", "status", "participants" ]
|
record data |
ISAN
|
IsanType
|
<ISAN root="0000-0005-CFED" episodeOrPart="0006" check1="I" version="0000-0000" check2="K">0000-0005-CFED-0006-I-0000-0000-K</ISAN>
|
"ISAN" : { "root" : "0000-0005-CFED", "episodeOrPart" : "0006", "check1" : "I", "version" : "0000-0000", "check2" : "K", "value" : "0000-0005-CFED-0006-I-0000-0000-K" }
|
record data |
parentIsan
|
IsanType
|
<parentIsan root="0000-0005-CFED" episodeOrPart="F001" check1="A" version="0000-0000" check2="7">0000-0005-CFED-F001-A-0000-0000-7</parentIsan>
|
"parentIsan" : { "root" : "0000-0005-CFED", "episodeOrPart" : "F001", "check1" : "A", "version" : "0000-0000", "check2" : "7", "value" : "0000-0005-CFED-F001-A-0000-0000-7" }
|
record data |
recordId
|
String
|
<recordId>episode-12345</recordId>
|
"recordId" : "episode-12345"
|
record data |
parentRecordId
|
String
|
<parentRecordId>group-12345</parentRecordId>
|
"parentRecordId" : "group-12345"
|
record data |
recordStatuses*
(*)only supported by /myisan
|
List<RecordStatusEnum>
|
<recordStatuses> <recordStatus>project</recordStatus> <recordStatus>active</recordStatus> </recordStatuses>
|
"recordStatuses" : [ "project", "active" ]
|
record data |
recordKinds
|
List<RecordKindEnum>
|
<recordKinds> <recordKind>single</recordKind> <recordKind>series</recordKind> <recordKind>group</recordKind> </recordKinds>
|
"recordKinds" : [ "single", "series", "group" ]
|
record data |
workTypes
|
List<WorkTypeEnum>
|
<workTypes> <workType>tv_entertainment</workType> <workType>feature_film</workType> </workTypes>
|
"workTypes" : [ "tv_entertainment", "feature_film" ]
|
record data |
workKinds
|
List<WorkKindEnum>
|
<workKinds> <workKind>live</workKind> <workKind>animated</workKind> </workKinds>
|
"workKinds" : [ "live", "animated" ]
|
record data |
duration
|
QueryDurationType
|
<duration unit="min" min="45" max="90"/>
|
"duration" : { "unit" : "min", "min" : 45, "max" : 90 },
|
record data |
colorKinds
|
List<ColorKindEnum> colorKinds
|
<colorKinds> <colorKind>color</colorKind> <colorKind>grayscale</colorKind> </colorKinds>
|
"colorKinds" : [ "color", "grayscale" ]
|
record data |
referenceYear
|
QueryReferenceYearType
|
<referenceYear min="2019" max="2021"/>
|
"referenceYear" : { "min" : 2019, "max" : 2021 }
|
record data |
releaseDate
|
QueryReleaseDateType
|
<releaseDate min="2020-07-31" max="2021-07-31"/>
|
"releaseDate" : { "min" : "2020-07-31", "max" : "2021-07-31" }
|
record data |
titles
|
TitlesType
|
<titles> <title kind="working" language="FRE">Titre De Travail En Francais</title> <title kind="original" language="FRE">Titre Original En Francais</title> </titles>
|
"titles" : [ { "kind" : "working", "language" : "FRE", "value" : "Titre De Travail En Francais" }, { "kind" : "original", "language" : "FRE", "value" : "Titre Original En Francais" }]
|
record data |
parentTitles
|
TitlesType
|
<parentTitles> <title kind="working" language="FRE">Titre De Travail En Francais</title> <title kind="original" language="FRE">Titre Original En Francais</title> </parentTitles>
|
"parentTitles" : [ { "kind" : "working", "language" : "FRE", "value" : "Titre De Travail En Francais" }, { "kind" : "original", "language" : "FRE", "value" : "Titre Original En Francais" }]
|
record data |
countries
|
CountriesType
|
<countries> <country kind="production">FR</country> <country kind="distribution">DE</country> </countries>
|
"countries" : [ { "kind" : "production", "value" : "FR" }, { "kind" : "distribution", "value" : "DE" } ]
|
record data |
languages
|
LanguagesType
|
<languages> <language kind="original">FRE</language> <language kind="original">GER</language> </languages>
|
"languages" : [ { "kind" : "original", "value" : "FRE" }, { "kind" : "original", "value" : "GER" } ]
|
record data |
companies
|
CompaniesType
|
<companies> <company kind="production">Mira Films</company> <company kind="production">VRD Gmbh</company> </companies>
|
"companies" : [ { "kind" : "production", "value" : "Mira Films" }, { "kind" : "production", "value" : "VRD Gmbh" } ]
|
record data |
participants
|
ParticipantsType
|
<participants> <participant role="director">John Doe</participant> <participant role="producer">John Doe</participant> </participants>
|
"participants" : [ { "role" : "director", "value" : "John Doe" }, { "role" : "producer", "value" : "John Doe" } ]
|
record data |
linkedIsans
|
LinkedIsansType
|
<linkedIsans> <linkedIsan type="composite" root="0000-0005-CFED" episodeOrPart="0005" check1="K" version="0000-0000" check2="E"/> <linkedIsan type="sequel" root="0000-0005-CFED" episodeOrPart="0004" check1="M" version="0000-0000" check2="8"/> </linkedIsans>
|
"linkedIsans" : [ { "type" : "composite", "root" : "0000-0005-CFED", "episodeOrPart" : "0005", "check1" : "K", "version" : "0000-0000", "check2" : "E" }, { "type" : "sequel", "value" : "ISAN 0000-0005-CFED-0004-M-0000-0000-8" } ]
|
record data |
linkedId
|
LinkedIdType
|
<linkedId type="eidr" domain="eidr.org">10.545/0000-0000-0000-0000-0000-X</linkedId>
|
"linkedId" : { "type" : "eidr", "domain" : "eidr.org", "value" : "10.545/0000-0000-0000-0000-0000-X" }
|
record data |
episodeNumbering
|
EpisodeNumberingType
|
<episodeNumbering groupReference="01" episodeReference="02" context="production" format="incremental"/>
|
"episodeNumbering" : { "groupReference" : "01", "episodeReference" : "02", "context" : "production", "format" : "incremental" }
|
record data |
alternateNumberings
|
AlternateNumberingsType
|
<alternateNumberings> <alternateNumbering groupReference="stafel 02" episodeReference="01" context="zdf.de" format="incremental" groupIsan="0000-0005-CFED-F002-A-0000-0000-X"/> <alternateNumbering groupReference="2020" episodeReference="02" context="distribution" format="incremental" groupIsan="0000-0005-CFED-F003-B-0000-0000-Y"/> </alternateNumberings>
|
"alternateNumberings" : [ { "groupReference" : "stafel 02", "episodeReference" : "01", "context" : "zdf.de", "format" : "incremental", "groupIsan" : "0000-0005-CFED-F002-A-0000-0000-X" }, { "groupReference" : "2020", "episodeReference" : "02", "context" : "distribution", "format" : "incremental", "groupIsan" : "0000-0005-CFED-F003-B-0000-0000-Y" } ]
|
record data |
partReferences
*deprecated - use sequenceNumbers instead
|
List<String>
|
<partReferences> <partReference>1/2</partReference> <partReference>2/2</partReference> </partReferences>
|
"partReferences" : [ "1/2", "2/2" ]
|
record data |
sequenceNumbers
|
List<String>
|
<sequenceNumbers> <sequenceNumber>1/2</sequenceNumber> <sequenceNumber>2/2</sequenceNumber> </sequenceNumbers>
|
"sequenceNumbers" : [ "1/2", "2/2" ]
|
record data |
groupProperties
|
List<GroupPropertyEnum>
|
<groupProperties> <groupProperty>alternate_edit</groupProperty> <groupProperty>alternate_grouping</groupProperty> </groupProperties>
|
"groupProperties" : [ "alternate_edit", "alternate_grouping" ]
|
version record data |
variantProperties
|
VariantPropertiesType
|
<variantProperties> <property>2d</property> <property>extended</property> </variantProperties>
|
"variantProperties" : [ "alt_dialog", "alt_music" ]
|
version record data |
manifestationProperties
|
ManifestationPropertiesType
|
<manifestationProperties> <property>media_fixation</property> <property>dubbing</property> </manifestationProperties>
|
"manifestationProperties" : [ "media_fixation", "dubbing" ]
|
version record data |
mediaKinds
|
List<MediaKindEnum> mediaKinds
|
<mediaKinds> <mediaKind>file</mediaKind> <mediaKind>film_print</mediaKind> </mediaKinds>
|
"mediaKinds" : [ "file", "film_print" ]
|
version record data |
mediaFormats
|
List<MediaFormatEnum>
|
<mediaFormats> <mediaFormat>encoding</mediaFormat> <mediaFormat>uncompressed</mediaFormat> </mediaFormats>
|
"mediaFormats" : [ "encoding", "uncompressed" ]
|
version record data |
imageDefinitions
|
List<ImageDefinitionEnum>
|
<imageDefinitions> <imageDefinition>hd</imageDefinition> <imageDefinition>sd</imageDefinition> </imageDefinitions>
|
"imageDefinitions" : [ "hd", "sd" ]
|
version record data |
aspectRatios
|
List<AspectRatioEnum>
|
<aspectRatios> <aspectRatio>academy</aspectRatio> <aspectRatio>full_container</aspectRatio> </aspectRatios>
|
"aspectRatios" : [ "academy", "full_container" ]
|
version record data |
containers
|
List<ContainerEnum>
|
<containers> <container>mp4</container> <container>mpeg</container> </containers>
|
"containers" : [ "mp4", "mpeg" ]
|
version record data |
contentTypes
|
List<RelatedContentEnum>
|
<contentTypes> <contentType>bonus</contentType> <contentType>multimedia</contentType> </contentTypes>
|
"contentTypes" : [ "bonus", "multimedia" ]
|
version record data |
itemTypes
|
List<RelatedItemEnum>
|
<itemTypes> <itemType>subtitles</itemType> <itemType>closed_captions</itemType> </itemTypes>
|
"itemTypes" : [ "subtitles", "closed_captions" ]
|
version record data |
frameRates
|
List<String>
|
<frameRates> <frameRate>rate 1</frameRate> <frameRate>rate 2</frameRate> </frameRates>
|
"frameRates" : [ "rate 1", "rate 2" ]
|
version record data |
contentAlerts
|
ContentAlertsType
|
<contentAlerts> <contentAlert>alcohol</contentAlert> <contentAlert>drug</contentAlert> </contentAlerts>
|
"contentAlerts" : [ "alcohol", "drug" ]
|
version record data |
intentions
|
DistributionIntentionsType
|
<distributions> <intention>home_video</intention> <intention>broadcasting</intention> </distributions>
|
"distributions" : [ "home_video", "vod" ]
|
project info |
projectInfo.types
|
List<ProjectTypeEnum>
|
<projectInfo.types> <projectInfo.type>production</projectInfo.type> <projectInfo.type>storyboard</projectInfo.type> </projectInfo.types>
|
"projectInfo.types" : [ "production", "storyboard" ]
|
project info |
projectInfo.statuses
|
List<ProjectStatusEnum>
|
<projectInfo.statuses> <projectInfo.status>finished</projectInfo.status> <projectInfo.status>abandoned</projectInfo.status> </projectInfo.statuses>
|
"projectInfo.statuses" : [ "finished", "abandoned" ]
|
project info |
projectInfo.formats
|
List<ProjectAvFormatEnum>
|
<projectInfo.formats> <projectInfo.format>series</projectInfo.format> <projectInfo.format>digital_series</projectInfo.format> </projectInfo.formats>
|
"projectInfo.formats" : [ "series", "digital_series" ]
|
administrative info |
creation
|
QueryDateType
|
<creation min="2021-01-01T00:00:00.000Z" max="2021-01-02T00:00:00.000Z"/>
|
"creation" : { "min" : "2021-01-01T00:00:00.000Z", "max" : "2021-01-02T00:00:00.000Z" }
|
administrative info |
activation
|
QueryDateType
|
<activation min="2021-01-01T00:00:00.000Z" max="2021-01-02T00:00:00.000Z"/>
|
"activation" : { "min" : "2021-01-01T00:00:00.000Z", "max" : "2021-01-02T00:00:00.000Z" }
|
administrative info |
lastupdate
|
QueryDateType
|
<lastupdate min="2021-01-01T00:00:00.000Z" max="2021-01-02T00:00:00.000Z"/>
|
"lastupdate" : { "min" : "2021-01-01T00:00:00.000Z", "max" : "2021-01-02T00:00:00.000Z" }
|
administrative info |
registrant.id
|
String
|
<registrant.id>superprod1234</registrant.id>
|
"registrant.id" : "superprod1234"
|
administrative info |
registrant.agency
|
String
|
<registrant.agency>130087</registrant.agency>
|
"registrant.agency" : "130087"
|