Elements and attributes
| persons | |||
|---|---|---|---|
| XML Element | Type | Required | Description |
| person | [PersonType]
|
Required | <dl><dt>id</dt><dd>Unique identifier of the person</dd><dt>dateOfBirth</dt><dd>Date of birth of the person in 'YYYY-MM-DD' format</dd><dt>type</dt><dd>The type of person, restricted to cast or persona</dd></dl> |
| PersonType / names | [NamesType]
|
Optional | Defines the locale specific name of the person<dl><dt>locale</dt><dd>Language-country code in which the name is written.It must be conformed to ISO-639 and ISO 3166-1.</dd></dl> |
| NamesType / name | string
|
Optional | locale specific name of the person |
| PersonType / details | [DetailsType]
|
Optional | Defines the locale specific bio data of the person<dl><dt>locale</dt><dd>Language-country code in which the bio data is written.It must be conformed to ISO-639 and ISO 3166-1.</dd></dl> |
| DetailsType / bio | string
|
Optional | locale specific bio data of the person |
| PersonType / roles | string
|
Optional | One more roles played by the person for this program, semi colon separated. For example writer, director, actor |
| PersonType / images | [ImageSetType]
|
Optional | |
| ImageSetType / image | [ImageType]
|
Required | <dl><dt>id</dt><dd>unique identifier of the image</dd><dt>uri</dt><dd>Uri of the image for download</dd><dt>status</dt><dd>The Status of the image, could be either active or inactive</dd><dt>locale</dt><dd>Language-country code in which the name is written.It must be conformed to ISO-639 and ISO 3166-1.</dd></dl> |
| ImageType / height | integer
|
Optional | image height |
| ImageType / width | integer
|
Optional | image width |
| ImageType / orientation | string
|
Optional | image orientation, for example, landscape or portrait |
| ImageType / aspect | string
|
Optional | Aspect ratio of the Image, for example, 16x9 |
| ImageType / category | string
|
Optional | Category of the Image |
| ImageType / text | [ImageTextEnumType]
|
Optional | Indicates if the filter for image types is with or without text. It is a fixed value, could be either yes or no |
| ImageType / primary | boolean
|
Optional | Indicates if the image is primary or not |
| ImageType / preferred | boolean
|
Optional | Indicates if the image is preferred or not |
| ImageType / captions | [CaptionsType]
|
Optional | Set of locale specific image titles<dl><dt>locale</dt><dd>Language-country code in which the caption title is written. It must conform to ISO-639 and ISO 3166-1.</dd></dl> |
| CaptionsType / title | string
|
Optional | Locale specific name of the image |
| ImageType / externalId | [ExternalIdType]
|
Optional | Source information of the image |
| ExternalIdType / externalSource | [ExternalSourceType]
|
Required | <dl><dt>sourceName</dt><dd>Name of the external source, for example, gracenote, imdb etc., </dd><dt>resourceId</dt><dd>Identifier of the resource(person or image) in the external source</dd></dl> |
| ImageType / locale | string
|
Optional | Language-country code in which the name is written.It must be conformed to ISO-639 and ISO 3166-1. |
| PersonType / externalIds | [ExternalIdsType]
|
Optional | Source information of the person |
| ExternalIdsType / externalSource | [ExternalSourceType]
|
Required | <dl><dt>sourceName</dt><dd>Name of the external source, for example, gracenote, imdb etc., </dd><dt>resourceId</dt><dd>Identifier of the resource(person or image) in the external source</dd></dl> |