The Sidecar API
Overview
Endpoints
- Production: Use https://api.sonypicturessidecar.com/ for connections on production.
- Staging: Use https://api.qa.sonypicturessidecar.com/ for connections on staging.
Note that you will need to be authenticated for almost all API calls.
Important: The sample requests in this guide are examples only. You should substitute call-specific parameters with your own values.
Request Headers
GET /api/v1/not_a_real_endpoint HTTP/1.1
Host: api.qa.sonypicturessidecar.com
Authorization: Bearer [TOKEN]
Accept: application/json
GET /api/v1/not_a_real_endpoint.json HTTP/1.1
Host: api.qa.sonypicturessidecar.com
Authorization: Bearer [TOKEN]
POST /api/v1/not_a_real_endpoint HTTP/1.1
Host: api.qa.sonypicturessidecar.com
Authorization: Bearer [TOKEN]
Content-Type: application/json
Accept: application/json
AUTHORIZATION
See the Authorization section for details on constructing these headers.
CONTENT-TYPE
All POST and PUT requests must contain a valid JSON body with the Content-Type header set to application/json.
ACCEPT
Unless otherwise noted, all Sidecar APIs are JSON based. Your request must
include an Accept: application/json header or append .json to the endpoint.
Authorization
All API requests must provide authorization. Currently, the system supports Bearer Auth using a jwt token.
Bearer Authorization
The Sidecar API allows clients to authenticate themselves with a user name and password to receive a token.
https://gigya.sonypicturessidecar.com/login - Production
https://gigya.qa.sonypicturessidecar.com/login - QA
POST
https://gigya.qa.sonypicturessidecar.com/loginSample Request
{
"username": "some-name",
"password": "some-password"
}
Sample Response
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIUUcCCCoidx2FuZHld3MiLCJpYXQijE"
}
Create Manifest Data
POST
/create_manifestSample Request
{
"clientId": "2",
"titleIds": ["3983"],
"includeFile": true,
"packageData": {
"locales":[
"en-US",
"de"
],
"languageData": {
"language": "en",
"subtitlesAvailable": "yes",
"type": "audio"
}
}
}
Sample Response
{
"transactionId": "a175a390-5a47-11e9-9f35-43dasdffdsfd",
"downloadFileName": "jumanji:_welcome_to_the_jungle_2017_th_usa.xml",
"location": "https://sidecar-bucket.s3.amazonaws.com/a175a390-5a47-11e9-9f35-43dasdffdsfd/jumanji%3A_welcome_to_the_jungle_2017_th_usa.xml",
"s3Key": "a175a390-5a47-11e9-9f35-43dasdffdsfd/jumanji:_welcome_to_the_jungle_2017_th_usa.xml",
"bucket": "sidecar-bucket",
"file" : ".......XML contents here when includeFile params given"
}
This endpoint will retrieve title data for a given alpha id and apply a set of rules based on client to produce xml data.
Request Endpoint
POST /create_manifest
DBB
Sample Request
{
"clientId": "2",
"titleIds": ["3983"],
"includeFile": true,
"packageData": {
"locales":[
"en-US",
"de"
],
"languageData": {
"language": "en",
"subtitlesAvailable": "yes",
"type": "audio"
}
}
}
| Key | Type | Description |
|---|---|---|
| clientId | Number | Client Id [2 for DBB]. |
| titleIds | Array | Array containg gpmsId or Alpha ID |
| includeFile | Boolean | True/False. If true, XML file contents will be included on the response. |
| packageData | Object | Object containing client specific data for producing outputs* |
| packageData.locales | Array | Territory Locale - i.e [“en-US”] |
| packageData.languageData | Object | |
| packageData.languageData.language | string | language code “en” |
| packageData.languageData.subtitlesAvailable | string | yes or no |
| packageData.languageData.type | string | audio, dubbed, subtitled |
DBBBulk
Sample Request
{
"clientId": "7",
"titleIds": [
"1142972"
],
"packageData": {
"locales": [
"en-US"
],
"kitData": {
"isKitted": "yes",
"kitId": "123456785"
},
"video": [
{
"file": {
"filename": "video1.mov"
},
"sourceTapeBarcode": "111111111111111",
"profile": {
"scanningFormat": "Progressive",
"horizontalResolution": "1920",
"type3d": "N/A",
"videoFormat": "ProRes",
"chromaSubsampling": "4:2:2",
"verticalResolution": "1080",
"type": "Textless",
"videoStandard": "1080_29.97p",
"videoColorSpace": "YUV",
"screenAspectRatio": "16x9",
"frameRate": "29.97",
"colorPrimaries": "BT.709",
"encodingProfile": "Textless ProRes HD 29.97p"
},
"textedLanguage": "English",
"burnedInSubtitle": "English",
"activePictureAspectRatio": "2.00",
"activeTopLeftX": "0",
"activeTopLeftY": "60",
"activeBottomRightX": "1920",
"activeBottomRightY": "1020",
"activePictureFormat": "Letterboxed",
"forcedSubtitle": "Present",
"isMlfCore": "No",
"runtime": "00:00:00:00",
"dynamicRangeValues": {
"maxCll": "",
"gx": "",
"gy": "",
"lMin": "",
"lMax": "",
"maxFall": "",
"bx": "",
"rx": "",
"by": "",
"ry": "",
"type": "SDR",
"transferFunction": ""
},
"dubcardPresent": "Yes",
"dubcardLanguage": "English"
}
],
"audio": [
{
"file": {
"filename": "audio1.wav"
},
"vendorName": "abc",
"encodingSoftware": "something",
"profileData": [
{
"profileName": "Composite, English, 5.1 MXF",
"channels": {
"channel3": "Front Center",
"channel4": "LFE",
"channel5": "Rear Left",
"channel6": "Rear Right",
"channel1": "Left",
"channel2": "Right"
},
"encodingProfile": "5.1 MXF",
"audioContent": "Composite",
"audioLanguage": "English",
"audioConfiguration": "5.1"
},
{
"profileName": "Voiceover, English, IMF Component Audio 5.1",
"channels": {
"channel3": "Left",
"channel4": "Right",
"channel5": "Front Center",
"channel6": "LFE",
"channel7": "Rear Left",
"channel8": "Rear Right"
},
"audioConfiguration": "5.1",
"encodingProfile": "IMF Component Audio 5.1",
"audioContent": "Voiceover",
"audioLanguage": "English"
}
]
},
{
"file": {
"filename": "audio2.wav"
},
"vendorName": "efg",
"encodingSoftware": "somethingelse",
"profileData": [
{
"profileName": "Composite, English, 7.1 WAV",
"channels": {
"channel7": "Side Left",
"channel8": "Side Right",
"channel3": "Front Center",
"channel4": "LFE",
"channel5": "Rear Left",
"channel6": "Rear Right",
"channel1": "Left",
"channel2": "Right"
},
"encodingProfile": "7.1 WAV",
"audioContent": "Composite",
"audioLanguage": "English",
"audioConfiguration": "7.1"
}
]
}
],
"subtitle": [
{
"imageFormat": ".TFF",
"horizontalResolution": "1920",
"verticalResolution": "1080",
"format": "BDN PNG+XML",
"ccStandard": "EIA-608",
"activePictureAspectRatio": "1.40",
"subtitleLanguage": "English",
"timingFormat": ".XML",
"fileLayout": "Discrete",
"frameRate": "29.97",
"screenAspectRatio": "16x9",
"file": {
"filename": "subtitle1.itt"
},
"activePictureFormat": "Letterboxed",
"encodingProfile": "Discrete Subtitle File - ITT",
"contentType": "Full w/Forced Removed",
"textEncodingType": "ANSI"
},
{
"imageFormat": ".PNG",
"horizontalResolution": "1920",
"verticalResolution": "1080",
"format": "DFXP",
"ccStandard": "EIA-608",
"activePictureAspectRatio": "1.37",
"subtitleLanguage": "English",
"timingFormat": "N/A",
"fileLayout": "Discrete",
"frameRate": "29.97",
"screenAspectRatio": "16x9",
"file": {
"filename": "subtitle2.itt"
},
"activePictureFormat": "Letterboxed",
"encodingProfile": "BDN PNG+XML",
"contentType": "Full",
"textEncodingType": "ANSI"
},
{
"file": {
"filename": "subtitle3.itt"
},
"encodingProfile": "BDN PNG+XML",
"format": "BDN PNG+XML",
"contentType": "Full",
"fileLayout": "TextArchive",
"subtitleLanguage": "English",
"imageFormat": ".PNG",
"timingFormat": ".XML",
"textEncodingType": "ANSI",
"horizontalResolution": "1920",
"verticalResolution": "1080",
"activePictureFormat": "Full Frame",
"ccStandard": "EIA-608",
"frameRate": "29.97",
"activePictureAspectRatio": "1.85",
"screenAspectRatio": "16x9"
}
],
"timecode": [
{ "black": {"in": "00:00:00:00", "out": "00:00:00:01" } },
{ "barsAndTones": {"in": "00:00:00:00", "out": "00:00:00:01" } },
{ "programSlate": {"in": "00:00:00:00", "out": "00:00:00:01" } },
{ "black": {"in": "00:00:00:00", "out": "00:00:00:01" } },
{ "programStart": {"in": "00:00:00:00", "out": "00:00:00:01" } },
{ "programEnd": {"in": "00:00:00:00", "out": "00:00:00:01" } },
{ "black": {"in": "00:00:00:00", "out": "00:00:00:01" } },
{ "additionalElements": {"in": "00:00:00:00", "out": "00:00:00:01" } }
]
}
}
| Key | Type | Description |
|---|---|---|
| clientId | Number | Client Id [7 for DBB]. |
| titleIds | Array | Array containg gpmsId or Alpha ID |
| includeFile | Boolean | True/False. If true, XML file contents will be included on the response. |
| packageData | Object | Object containing client specific data for producing outputs* |
| packageData.locales | Array | Territory Locale - i.e [“en-US”] |
| packageData.kitData | Object | |
| packageData.kitData.isKitted | String | “yes/no” |
| packageData.kitData.kitId | String | |
| packageData.video | Array | Array containing video objects |
| packageData.audio | Array | Array containing audio objects |
| packageData.subtitle | Array | Array containing subtitle objects |
| packageData.timecode | Array | Array containing timecode entries |
Distribution Metadata
Sample Request
{
"clientId": "13",
"packageData": {
"taskIds": "234232, 1345678"
}
}
| Key | Type | Description |
|---|---|---|
| clientId | Number | Client Id [13 for Distribution Metadata]. |
| packageData | Object | Object containing client specific data for producing outputs* |
| packageData.taskIds | String | String of Comma separated task ids |
Exhibtion Metadata
Sample Request
{
"clientId": "14",
"titleIds": [
"2488757"
],
"packageData": {
"selectedTerritories": [
{
"territoryDescription": "U.S.A.[excluding Territories & Possessions]",
"territoryId": "13",
"territoryName": "U.S.A.[excl t's & p's]"
},
{
"territoryId": "173",
"territoryName": "Belgium",
"territoryDescription": "Belgium"
}
]
}
}
| Key | Type | Description |
|---|---|---|
| clientId | Number | Client Id [14 for Exhibition Metadata]. |
| titleIds | Array | Array containg gpmsId or Alpha ID |
| packageData | Object | Object containing client specific data for producing outputs* |
| packageData.selectedTerritories | Object | Object containing territory items* |
| *territory item | Object | see here |
Movielabs Title Metadata
Sample Request
{
"clientId": "3",
"titleIds": [
"2529390"
],
"packageData": {
"locales": [
"en-US",
"ar-AE",
"bg-BG",
"id-ID",
"hr-HR",
"cs-CZ",
"da-DK",
"en-GB",
"fi-FL",
"fr-FR",
"de-DE",
]
}
}
| Key | Type | Description |
|---|---|---|
| clientId | Number | Client Id [3 for Movielabs Title Metadata]. |
| titleIds | Array | Array containg gpmsId or Alpha ID |
| packageData | Object | Object containing client specific data for producing outputs* |
| packageData.locales | Array | Territory Locale - i.e [“en-US”] |
ROKU TV
Sample Roku Request
{
"clientId": "5",
"titleIds": ["2249256"],
"packageData": {
"license": {
"licensingStartDate": "2019-05-24T18:05:00.000Z",
"licensingEndDate": "2019-05-31T18:05:00.000Z"
},
"fileAssets": {
"sourceFile": "Spiderman3_2007_ITR5CL_HD_PRS_FRE.mov",
"captionFile": "SPRMN3_ITR5_HD_PRS_GER.mov"
},
"tags": [
"jump",
"getting dinner"
]
}
}
| Key | Type | Description |
|---|---|---|
| clientId | Number | Client Id [5 for Roku]. |
| titleIds | Array | Array containg gpmsId or Alpha ID |
| includeFile | Boolean | True/False. If true, XML file contents will be included on the response. |
| packageData | Object | Object containing client specific data for producing outputs* |
| packageData.license | Object | Object containing licensing start and end dates |
| packageData.license.licensingStartDate | String | ISO 8601 Date (i.e 2019-05-24T18:05:00.000Z) |
| packageData.license.licensingEndDate | String | ISO 8601 Date (i.e 2019-05-24T18:05:00.000Z) |
| packageData.fileAssets | Object | Object containing filename information |
| packageData.fileAssets.sourceFile | String | Name of source file |
| packageData.fileAssets.captionFile | String | Name of caption file |
| packageData.tags | Array | Array of strings (i.e [‘tag1’, ‘tag 2’, ‘and another tag’]) |
iTunes Schema / New Release Features
Sample iTunes Schema / New Release Features Request
{
"clientId": "10",
"titleIds": [
"1149220",
"11062508"
],
"packageData": {
"locales": [
"en-US",
"ja-JP"
],
"synopsisLengths": {
"synopsisCharLength": 350,
"tvSynopsisLengths": {
"shortSynopsisLength": 250,
"longSynopsisLength": 500,
"seasonSynopsisLength": 500,
"seriesSynopsisLength": 500
}
}
}
}
| Key | Type | Description |
|---|---|---|
| clientId | Number | Client Id [10 for iTunes Schema / 11 New Release Features]. |
| titleIds | Array | Array containg gpmsId or Alpha ID |
| packageData | Object | Object containing client specific data for producing outputs* |
| packageData.locales | Array | Array containing ISO language codes |
| packageData.synopsisLengths | Object | Object containing length parameters for synopsis* |
| packageData.synopsisLengths.synopsisCharLength | Number | Synopsis character length for a feature |
| packageData.synopsisLengths.tvSynopsisLengths | Object | Synopsis character length for TV |
| packageData.synopsisLengths.tvSynopsisLengths.shortSynopsisLength | Number | Synopsis character length for short synopsis field on episode level |
| packageData.synopsisLengths.tvSynopsisLengths.longSynopsisLength | Number | Synopsis character length for long synopsis field on episode level |
| packageData.synopsisLengths.tvSynopsisLengths.seasonSynopsisLength | Number | Synopsis character length for season synopsis. |
| packageData.synopsisLengths.tvSynopsisLengths.seriesSynopsisLength | Number | Synopsis character length for series synopsis. |
Ebucore Parser
This endpoint is used to quickly parse through ebucore files and return relevant ebucore data as json
POST
/filesSample Request
{
"files":[
{ "name":"SPIDERMAN__dub_card_958401_624480.xml", "fileData":"BASE64 String of ebucore file contents" }
]
}
Sample Response
{
"files":[
{
"aspectRatio":"16:9",
"audioCodec":"PCM",
"audioChannels":12,
"codec":"ProRes422HQ",
"filename":"SPIDERMAN__dub_card_958401_624480.mov",
"fileSize":"78488496",
"height":"1080",
"width":"1920",
"md5":null,
"subtitleFormat":null,
"containerEncoding":"MPEG-4",
"colourPrimaries":"BT709",
"transferCharacteristics":"BT709"
}
]
}
| Key | Type | Description |
|---|---|---|
| files | Array | array of file objects |
File Object
| Key | Type | Description |
|---|---|---|
| name | String | Name of the file |
| fileData | String | Base64 String of file contents |
Jobs - Create
This endpoint is used to create/update package data for a job
POST
/postjobSample Request
{
"transactionId": "some-unique-guid",
"clientId": 7,
"titleId": "1928393",
"packageData": {
"filename": "sssss"
}
}
- Providing a transaction id will keep data saved under that transaction id. If no “transactionId” is provided on the body, the posted data will be saved under a new transaction Id.
Sample Response
{
"id": "7d1af650-c926-11e9-b4be-8d898fcc6551"
}
| Key | Type | Description |
|---|---|---|
| transactionId* | string | optional. |
| clientId | string | id for client xml |
| titleId | string | id for retrieving title data |
| packageData* | object | contains data that will be saved/applied in package data step in Sidecar App. Specific to the client xml being requested. |
Territories Data
These objects are used in the create_manifest call for Exhibition Metadata.
Full Data
[
{
"territoryId": "108",
"territoryName": "Afghanistan",
"territoryDescription": "Afghanistan"
},
{
"territoryId": "3",
"territoryName": "Africa",
"territoryDescription": "Africa"
},
{
"territoryId": "78",
"territoryName": "Albania",
"territoryDescription": "Albania"
},
{
"territoryId": "14",
"territoryName": "Algeria",
"territoryDescription": "Algeria"
},
{
"territoryId": "10201081",
"territoryName": "American Samoa",
"territoryDescription": "American Samoa"
},
{
"territoryId": "177",
"territoryName": "Andorra",
"territoryDescription": "Andorra"
},
{
"territoryId": "15",
"territoryName": "Angola",
"territoryDescription": "Angola"
},
{
"territoryId": "226",
"territoryName": "Anguilla",
"territoryDescription": "Anguilla"
},
{
"territoryId": "227",
"territoryName": "Antigua & Barbuda",
"territoryDescription": "Antigua & Barbuda"
},
{
"territoryId": "213",
"territoryName": "Argentina",
"territoryDescription": "Argentina"
},
{
"territoryId": "310",
"territoryName": "Armenia",
"territoryDescription": "Armenia"
},
{
"territoryId": "330",
"territoryName": "Aruba",
"territoryDescription": "Aruba"
},
{
"territoryId": "350",
"territoryName": "Asian CIS Republics",
"territoryDescription": "Asian CIS Republics"
},
{
"territoryId": "4",
"territoryName": "Australia",
"territoryDescription": "Australia [including adjacent islands]"
},
{
"territoryId": "71",
"territoryName": "Australia [excl islands]",
"territoryDescription": "Australia [excluding adjacent islands]"
},
{
"territoryId": "10200610",
"territoryName": "Australia Adj Islands",
"territoryDescription": "Australia Adjacent Islands"
},
{
"territoryId": "93",
"territoryName": "Austria",
"territoryDescription": "Austria"
},
{
"territoryId": "311",
"territoryName": "Azerbaijan",
"territoryDescription": "Azerbaijan"
},
{
"territoryId": "228",
"territoryName": "Bahamas",
"territoryDescription": "Bahamas"
},
{
"territoryId": "138",
"territoryName": "Bahrain",
"territoryDescription": "Bahrain"
},
{
"territoryId": "109",
"territoryName": "Bangladesh",
"territoryDescription": "Bangladesh"
},
{
"territoryId": "229",
"territoryName": "Barbados",
"territoryDescription": "Barbados"
},
{
"territoryId": "312",
"territoryName": "Belarus",
"territoryDescription": "Belarus"
},
{
"territoryId": "173",
"territoryName": "Belgium",
"territoryDescription": "Belgium"
},
{
"territoryId": "206",
"territoryName": "Belize",
"territoryDescription": "Belize"
},
{
"territoryId": "94",
"territoryName": "Benelux",
"territoryDescription": "Benelux"
},
{
"territoryId": "16",
"territoryName": "Benin",
"territoryDescription": "Benin"
},
{
"territoryId": "230",
"territoryName": "Bermuda",
"territoryDescription": "Bermuda"
},
{
"territoryId": "110",
"territoryName": "Bhutan",
"territoryDescription": "Bhutan"
},
{
"territoryId": "214",
"territoryName": "Bolivia",
"territoryDescription": "Bolivia"
},
{
"territoryId": "331",
"territoryName": "Bonaire",
"territoryDescription": "Bonaire"
},
{
"territoryId": "79",
"territoryName": "Bosnia/Herzegovina",
"territoryDescription": "Bosnia/Herzegovina"
},
{
"territoryId": "17",
"territoryName": "Botswana",
"territoryDescription": "Botswana"
},
{
"territoryId": "215",
"territoryName": "Brazil",
"territoryDescription": "Brazil"
},
{
"territoryId": "246",
"territoryName": "British Virgin Islands",
"territoryDescription": "Virgin Islands, British"
},
{
"territoryId": "111",
"territoryName": "Brunei",
"territoryDescription": "Brunei"
},
{
"territoryId": "80",
"territoryName": "Bulgaria",
"territoryDescription": "Bulgaria"
},
{
"territoryId": "18",
"territoryName": "Burkina Faso",
"territoryDescription": "Burkina Faso"
},
{
"territoryId": "19",
"territoryName": "Burundi",
"territoryDescription": "Burundi"
},
{
"territoryId": "169",
"territoryName": "C.I.S.",
"territoryDescription": "C.I.S."
},
{
"territoryId": "112",
"territoryName": "Cambodia",
"territoryDescription": "Cambodia"
},
{
"territoryId": "20",
"territoryName": "Cameroon",
"territoryDescription": "Cameroon"
},
{
"territoryId": "5",
"territoryName": "Canada",
"territoryDescription": "Canada"
},
{
"territoryId": "192",
"territoryName": "Canary Islands",
"territoryDescription": "Canary Islands"
},
{
"territoryId": "21",
"territoryName": "Cape Verde",
"territoryDescription": "Cape Verde"
},
{
"territoryId": "137",
"territoryName": "Caribbean Islands",
"territoryDescription": "Caribbean Islands"
},
{
"territoryId": "231",
"territoryName": "Cayman Islands",
"territoryDescription": "Cayman Islands"
},
{
"territoryId": "22",
"territoryName": "Central African Republic",
"territoryDescription": "Central African Republic"
},
{
"territoryId": "135",
"territoryName": "Central America",
"territoryDescription": "Central America"
},
{
"territoryId": "23",
"territoryName": "Chad",
"territoryDescription": "Chad"
},
{
"territoryId": "216",
"territoryName": "Chile",
"territoryDescription": "Chile"
},
{
"territoryId": "113",
"territoryName": "China",
"territoryDescription": "China"
},
{
"territoryId": "217",
"territoryName": "Colombia",
"territoryDescription": "Colombia"
},
{
"territoryId": "24",
"territoryName": "Comoros",
"territoryDescription": "Comoros"
},
{
"territoryId": "25",
"territoryName": "Congo - Republic of",
"territoryDescription": "Congo, Republic of"
},
{
"territoryId": "68",
"territoryName": "Congo -Dem Rep of (Zaire)",
"territoryDescription": "Congo, Democratic Republic of (Zaire)"
},
{
"territoryId": "10201083",
"territoryName": "Cook Islands",
"territoryDescription": "Cook Islands"
},
{
"territoryId": "207",
"territoryName": "Costa Rica",
"territoryDescription": "Costa Rica"
},
{
"territoryId": "82",
"territoryName": "Croatia",
"territoryDescription": "Croatia"
},
{
"territoryId": "232",
"territoryName": "Cuba",
"territoryDescription": "Cuba"
},
{
"territoryId": "332",
"territoryName": "Curacao",
"territoryDescription": "Curacao"
},
{
"territoryId": "95",
"territoryName": "Cyprus",
"territoryDescription": "Cyprus"
},
{
"territoryId": "83",
"territoryName": "Czech Republic",
"territoryDescription": "Czech Republic"
},
{
"territoryId": "5000343",
"territoryName": "Czechoslovakia (Former)",
"territoryDescription": "Czechoslovakia (Former)"
},
{
"territoryId": "186",
"territoryName": "Denmark",
"territoryDescription": "Denmark [including Greenland]"
},
{
"territoryId": "326",
"territoryName": "Denmark [excl Greenland]",
"territoryDescription": "Denmark [excluding Greenland]"
},
{
"territoryId": "26",
"territoryName": "Djibouti",
"territoryDescription": "Djibouti"
},
{
"territoryId": "233",
"territoryName": "Dominica",
"territoryDescription": "Dominica"
},
{
"territoryId": "234",
"territoryName": "Dominican Republic",
"territoryDescription": "Dominican Republic"
},
{
"territoryId": "10300962",
"territoryName": "East Timor",
"territoryDescription": "East Timor"
},
{
"territoryId": "6",
"territoryName": "Eastern Europe",
"territoryDescription": "Europe, Eastern"
},
{
"territoryId": "218",
"territoryName": "Ecuador",
"territoryDescription": "Ecuador"
},
{
"territoryId": "27",
"territoryName": "Egypt",
"territoryDescription": "Egypt"
},
{
"territoryId": "208",
"territoryName": "El Salvador",
"territoryDescription": "El Salvador"
},
{
"territoryId": "28",
"territoryName": "Equatorial Guinea",
"territoryDescription": "Equatorial Guinea"
},
{
"territoryId": "29",
"territoryName": "Eritrea",
"territoryDescription": "Eritrea"
},
{
"territoryId": "170",
"territoryName": "Estonia",
"territoryDescription": "Estonia"
},
{
"territoryId": "30",
"territoryName": "Ethiopia",
"territoryDescription": "Ethiopia"
},
{
"territoryId": "8",
"territoryName": "Far East",
"territoryDescription": "Far East"
},
{
"territoryId": "151",
"territoryName": "Fiji",
"territoryDescription": "Fiji"
},
{
"territoryId": "187",
"territoryName": "Finland",
"territoryDescription": "Finland"
},
{
"territoryId": "96",
"territoryName": "France",
"territoryDescription": "France [including territories, possessions & principalities]"
},
{
"territoryId": "176",
"territoryName": "France [Metropolitan]",
"territoryDescription": "France [Metropolitan]"
},
{
"territoryId": "235",
"territoryName": "French Antilles",
"territoryDescription": "French Antilles"
},
{
"territoryId": "178",
"territoryName": "French DOM-TOM",
"territoryDescription": "French DOM-TOM"
},
{
"territoryId": "219",
"territoryName": "French Guiana",
"territoryDescription": "French Guiana"
},
{
"territoryId": "322",
"territoryName": "French Polynesia",
"territoryDescription": "French Polynesia"
},
{
"territoryId": "31",
"territoryName": "Gabon",
"territoryDescription": "Gabon"
},
{
"territoryId": "32",
"territoryName": "Gambia",
"territoryDescription": "Gambia"
},
{
"territoryId": "313",
"territoryName": "Georgia",
"territoryDescription": "Georgia"
},
{
"territoryId": "97",
"territoryName": "Germany",
"territoryDescription": "Germany"
},
{
"territoryId": "33",
"territoryName": "Ghana",
"territoryDescription": "Ghana"
},
{
"territoryId": "196",
"territoryName": "Gibraltar",
"territoryDescription": "Gibraltar"
},
{
"territoryId": "98",
"territoryName": "Greece",
"territoryDescription": "Greece [including Crete]"
},
{
"territoryId": "327",
"territoryName": "Greenland",
"territoryDescription": "Greenland"
},
{
"territoryId": "236",
"territoryName": "Grenada",
"territoryDescription": "Grenada"
},
{
"territoryId": "328",
"territoryName": "Guadeloupe",
"territoryDescription": "Guadeloupe"
},
{
"territoryId": "342",
"territoryName": "Guam",
"territoryDescription": "Guam"
},
{
"territoryId": "209",
"territoryName": "Guatemala",
"territoryDescription": "Guatemala"
},
{
"territoryId": "34",
"territoryName": "Guinea",
"territoryDescription": "Guinea"
},
{
"territoryId": "35",
"territoryName": "Guinea-Bissau",
"territoryDescription": "Guinea-Bissau"
},
{
"territoryId": "220",
"territoryName": "Guyana",
"territoryDescription": "Guyana"
},
{
"territoryId": "237",
"territoryName": "Haiti",
"territoryDescription": "Haiti"
},
{
"territoryId": "210",
"territoryName": "Honduras",
"territoryDescription": "Honduras"
},
{
"territoryId": "114",
"territoryName": "Hong Kong",
"territoryDescription": "Hong Kong"
},
{
"territoryId": "85",
"territoryName": "Hungary",
"territoryDescription": "Hungary"
},
{
"territoryId": "188",
"territoryName": "Iceland",
"territoryDescription": "Iceland"
},
{
"territoryId": "115",
"territoryName": "India",
"territoryDescription": "India"
},
{
"territoryId": "116",
"territoryName": "Indonesia",
"territoryDescription": "Indonesia"
},
{
"territoryId": "139",
"territoryName": "Iran",
"territoryDescription": "Iran"
},
{
"territoryId": "140",
"territoryName": "Iraq",
"territoryDescription": "Iraq"
},
{
"territoryId": "99",
"territoryName": "Ireland",
"territoryDescription": "Ireland"
},
{
"territoryId": "9",
"territoryName": "Israel",
"territoryDescription": "Israel"
},
{
"territoryId": "100",
"territoryName": "Italy",
"territoryDescription": "Italy"
},
{
"territoryId": "36",
"territoryName": "Ivory Coast",
"territoryDescription": "Ivory Coast"
},
{
"territoryId": "238",
"territoryName": "Jamaica",
"territoryDescription": "Jamaica"
},
{
"territoryId": "117",
"territoryName": "Japan",
"territoryDescription": "Japan"
},
{
"territoryId": "141",
"territoryName": "Jordan",
"territoryDescription": "Jordan"
},
{
"territoryId": "314",
"territoryName": "Kazakhstan",
"territoryDescription": "Kazakhstan"
},
{
"territoryId": "37",
"territoryName": "Kenya",
"territoryDescription": "Kenya"
},
{
"territoryId": "152",
"territoryName": "Kiribati",
"territoryDescription": "Kiribati"
},
{
"territoryId": "10302836",
"territoryName": "Kosovo",
"territoryDescription": "Kosovo"
},
{
"territoryId": "142",
"territoryName": "Kuwait",
"territoryDescription": "Kuwait"
},
{
"territoryId": "315",
"territoryName": "Kyrgyzstan",
"territoryDescription": "Kyrgyzstan"
},
{
"territoryId": "120",
"territoryName": "Laos",
"territoryDescription": "Laos"
},
{
"territoryId": "10",
"territoryName": "Latin America",
"territoryDescription": "Latin America"
},
{
"territoryId": "171",
"territoryName": "Latvia",
"territoryDescription": "Latvia"
},
{
"territoryId": "143",
"territoryName": "Lebanon",
"territoryDescription": "Lebanon"
},
{
"territoryId": "38",
"territoryName": "Lesotho",
"territoryDescription": "Lesotho"
},
{
"territoryId": "39",
"territoryName": "Liberia",
"territoryDescription": "Liberia"
},
{
"territoryId": "40",
"territoryName": "Libya",
"territoryDescription": "Libya"
},
{
"territoryId": "101",
"territoryName": "Liechtenstein",
"territoryDescription": "Liechtenstein"
},
{
"territoryId": "172",
"territoryName": "Lithuania",
"territoryDescription": "Lithuania"
},
{
"territoryId": "174",
"territoryName": "Luxembourg",
"territoryDescription": "Luxembourg"
},
{
"territoryId": "121",
"territoryName": "Macau",
"territoryDescription": "Macau"
},
{
"territoryId": "86",
"territoryName": "Macedonia",
"territoryDescription": "Macedonia"
},
{
"territoryId": "41",
"territoryName": "Madagascar",
"territoryDescription": "Madagascar"
},
{
"territoryId": "185",
"territoryName": "Madeira",
"territoryDescription": "Madeira"
},
{
"territoryId": "42",
"territoryName": "Malawi",
"territoryDescription": "Malawi"
},
{
"territoryId": "122",
"territoryName": "Malaysia",
"territoryDescription": "Malaysia"
},
{
"territoryId": "123",
"territoryName": "Maldives",
"territoryDescription": "Maldives"
},
{
"territoryId": "43",
"territoryName": "Mali",
"territoryDescription": "Mali"
},
{
"territoryId": "198",
"territoryName": "Malta",
"territoryDescription": "Malta"
},
{
"territoryId": "10300986",
"territoryName": "Marshall Islands",
"territoryDescription": "Marshall Islands"
},
{
"territoryId": "329",
"territoryName": "Martinique",
"territoryDescription": "Martinique"
},
{
"territoryId": "44",
"territoryName": "Mauritania",
"territoryDescription": "Mauritania"
},
{
"territoryId": "45",
"territoryName": "Mauritius",
"territoryDescription": "Mauritius"
},
{
"territoryId": "46",
"territoryName": "Mayotte",
"territoryDescription": "Mayotte"
},
{
"territoryId": "134",
"territoryName": "Mexico",
"territoryDescription": "Mexico"
},
{
"territoryId": "10300987",
"territoryName": "Micronesia",
"territoryDescription": "Micronesia, Federated States Of"
},
{
"territoryId": "11",
"territoryName": "Middle East",
"territoryDescription": "Middle East"
},
{
"territoryId": "316",
"territoryName": "Moldova",
"territoryDescription": "Moldova"
},
{
"territoryId": "179",
"territoryName": "Monaco",
"territoryDescription": "Monaco"
},
{
"territoryId": "124",
"territoryName": "Mongolia",
"territoryDescription": "Mongolia"
},
{
"territoryId": "87",
"territoryName": "Montenegro",
"territoryDescription": "Montenegro"
},
{
"territoryId": "239",
"territoryName": "Montserrat",
"territoryDescription": "Montserrat"
},
{
"territoryId": "47",
"territoryName": "Morocco",
"territoryDescription": "Morocco"
},
{
"territoryId": "48",
"territoryName": "Mozambique",
"territoryDescription": "Mozambique"
},
{
"territoryId": "125",
"territoryName": "Myanmar",
"territoryDescription": "Myanmar"
},
{
"territoryId": "49",
"territoryName": "Namibia",
"territoryDescription": "Namibia"
},
{
"territoryId": "72",
"territoryName": "Nauru",
"territoryDescription": "Nauru"
},
{
"territoryId": "126",
"territoryName": "Nepal",
"territoryDescription": "Nepal"
},
{
"territoryId": "175",
"territoryName": "Netherlands",
"territoryDescription": "Netherlands"
},
{
"territoryId": "240",
"territoryName": "Netherlands Antilles",
"territoryDescription": "Netherlands Antilles"
},
{
"territoryId": "323",
"territoryName": "New Caledonia",
"territoryDescription": "New Caledonia"
},
{
"territoryId": "12",
"territoryName": "New Zealand",
"territoryDescription": "New Zealand [including adjacent islands]"
},
{
"territoryId": "150",
"territoryName": "New Zealand [excl islnds]",
"territoryDescription": "New Zealand [excluding adjacent islands]"
},
{
"territoryId": "10200611",
"territoryName": "New Zealand Adj Islands",
"territoryDescription": "New Zealand Adjacent Islands"
},
{
"territoryId": "211",
"territoryName": "Nicaragua",
"territoryDescription": "Nicaragua"
},
{
"territoryId": "50",
"territoryName": "Niger",
"territoryDescription": "Niger"
},
{
"territoryId": "51",
"territoryName": "Nigeria",
"territoryDescription": "Nigeria"
},
{
"territoryId": "10201082",
"territoryName": "Niue Island",
"territoryDescription": "Niue Island"
},
{
"territoryId": "118",
"territoryName": "North Korea",
"territoryDescription": "Korea, North"
},
{
"territoryId": "10300988",
"territoryName": "Northern Mariana Islands",
"territoryDescription": "Northern Mariana Islands"
},
{
"territoryId": "189",
"territoryName": "Norway",
"territoryDescription": "Norway"
},
{
"territoryId": "144",
"territoryName": "Oman",
"territoryDescription": "Oman"
},
{
"territoryId": "127",
"territoryName": "Pakistan",
"territoryDescription": "Pakistan"
},
{
"territoryId": "10300989",
"territoryName": "Palau",
"territoryDescription": "Palau"
},
{
"territoryId": "212",
"territoryName": "Panama",
"territoryDescription": "Panama"
},
{
"territoryId": "73",
"territoryName": "Papua New Guinea",
"territoryDescription": "Papua New Guinea"
},
{
"territoryId": "221",
"territoryName": "Paraguay",
"territoryDescription": "Paraguay"
},
{
"territoryId": "222",
"territoryName": "Peru",
"territoryDescription": "Peru"
},
{
"territoryId": "128",
"territoryName": "Philippines",
"territoryDescription": "Philippines"
},
{
"territoryId": "88",
"territoryName": "Poland",
"territoryDescription": "Poland"
},
{
"territoryId": "102",
"territoryName": "Portugal",
"territoryDescription": "Portugal"
},
{
"territoryId": "343",
"territoryName": "Puerto Rico",
"territoryDescription": "Puerto Rico"
},
{
"territoryId": "145",
"territoryName": "Qatar",
"territoryDescription": "Qatar"
},
{
"territoryId": "77",
"territoryName": "Quebec",
"territoryDescription": "Canada-Quebec Province"
},
{
"territoryId": "149",
"territoryName": "Republic of Yemen",
"territoryDescription": "Yemen, Republic of (Unified)"
},
{
"territoryId": "52",
"territoryName": "Reunion",
"territoryDescription": "Reunion"
},
{
"territoryId": "89",
"territoryName": "Romania",
"territoryDescription": "Romania"
},
{
"territoryId": "317",
"territoryName": "Russia",
"territoryDescription": "Russia"
},
{
"territoryId": "53",
"territoryName": "Rwanda",
"territoryDescription": "Rwanda"
},
{
"territoryId": "10200609",
"territoryName": "Saba",
"territoryDescription": "Saba"
},
{
"territoryId": "54",
"territoryName": "Sao Tome & Principe",
"territoryDescription": "Sao Tome & Principe"
},
{
"territoryId": "146",
"territoryName": "Saudi Arabia",
"territoryDescription": "Saudi Arabia"
},
{
"territoryId": "103",
"territoryName": "Scandinavia",
"territoryDescription": "Scandinavia"
},
{
"territoryId": "55",
"territoryName": "Senegal",
"territoryDescription": "Senegal"
},
{
"territoryId": "90",
"territoryName": "Serbia",
"territoryDescription": "Serbia"
},
{
"territoryId": "5000345",
"territoryName": "Serbia & Montenegro",
"territoryDescription": "Serbia & Montenegro"
},
{
"territoryId": "56",
"territoryName": "Seychelles",
"territoryDescription": "Seychelles"
},
{
"territoryId": "57",
"territoryName": "Sierra Leone",
"territoryDescription": "Sierra Leone"
},
{
"territoryId": "129",
"territoryName": "Singapore",
"territoryDescription": "Singapore"
},
{
"territoryId": "91",
"territoryName": "Slovakia",
"territoryDescription": "Slovakia"
},
{
"territoryId": "92",
"territoryName": "Slovenia",
"territoryDescription": "Slovenia"
},
{
"territoryId": "74",
"territoryName": "Solomon Islands",
"territoryDescription": "Solomon Islands"
},
{
"territoryId": "58",
"territoryName": "Somalia",
"territoryDescription": "Somalia"
},
{
"territoryId": "59",
"territoryName": "South Africa",
"territoryDescription": "South Africa, Republic of"
},
{
"territoryId": "136",
"territoryName": "South America",
"territoryDescription": "South America"
},
{
"territoryId": "119",
"territoryName": "South Korea",
"territoryDescription": "Korea, South"
},
{
"territoryId": "104",
"territoryName": "Spain",
"territoryDescription": "Spain [including Canary Islands, Andorra]"
},
{
"territoryId": "191",
"territoryName": "Spain [excl Canary/Andor]",
"territoryDescription": "Spain [excluding Canary Islands, Andorra]"
},
{
"territoryId": "130",
"territoryName": "Sri Lanka",
"territoryDescription": "Sri Lanka"
},
{
"territoryId": "10100606",
"territoryName": "St. Eustatius",
"territoryDescription": "St. Eustatius"
},
{
"territoryId": "60",
"territoryName": "St. Helena",
"territoryDescription": "St. Helena"
},
{
"territoryId": "241",
"territoryName": "St. Kitts-Nevis",
"territoryDescription": "St. Kitts-Nevis"
},
{
"territoryId": "242",
"territoryName": "St. Lucia",
"territoryDescription": "St. Lucia"
},
{
"territoryId": "333",
"territoryName": "St. Maarten",
"territoryDescription": "St. Maarten"
},
{
"territoryId": "10100604",
"territoryName": "St. Martin",
"territoryDescription": "St. Martin"
},
{
"territoryId": "324",
"territoryName": "St. Pierre & Miquelon",
"territoryDescription": "St. Pierre & Miquelon"
},
{
"territoryId": "243",
"territoryName": "St. Vincent & Grenadines",
"territoryDescription": "St. Vincent & Grenadines"
},
{
"territoryId": "61",
"territoryName": "Sudan",
"territoryDescription": "Sudan"
},
{
"territoryId": "223",
"territoryName": "Surinam",
"territoryDescription": "Surinam"
},
{
"territoryId": "62",
"territoryName": "Swaziland",
"territoryDescription": "Swaziland"
},
{
"territoryId": "190",
"territoryName": "Sweden",
"territoryDescription": "Sweden"
},
{
"territoryId": "105",
"territoryName": "Switzerland",
"territoryDescription": "Switzerland"
},
{
"territoryId": "147",
"territoryName": "Syria",
"territoryDescription": "Syria"
},
{
"territoryId": "339",
"territoryName": "Tahiti",
"territoryDescription": "Tahiti"
},
{
"territoryId": "131",
"territoryName": "Taiwan",
"territoryDescription": "Taiwan"
},
{
"territoryId": "318",
"territoryName": "Tajikistan",
"territoryDescription": "Tajikistan"
},
{
"territoryId": "63",
"territoryName": "Tanzania",
"territoryDescription": "Tanzania"
},
{
"territoryId": "132",
"territoryName": "Thailand",
"territoryDescription": "Thailand"
},
{
"territoryId": "64",
"territoryName": "Togo",
"territoryDescription": "Togo"
},
{
"territoryId": "153",
"territoryName": "Tonga",
"territoryDescription": "Tonga"
},
{
"territoryId": "244",
"territoryName": "Trinidad & Tobago",
"territoryDescription": "Trinidad & Tobago"
},
{
"territoryId": "65",
"territoryName": "Tunisia",
"territoryDescription": "Tunisia"
},
{
"territoryId": "106",
"territoryName": "Turkey",
"territoryDescription": "Turkey"
},
{
"territoryId": "319",
"territoryName": "Turkmenistan",
"territoryDescription": "Turkmenistan"
},
{
"territoryId": "245",
"territoryName": "Turks & Caicos",
"territoryDescription": "Turks & Caicos"
},
{
"territoryId": "154",
"territoryName": "Tuvalu",
"territoryDescription": "Tuvalu"
},
{
"territoryId": "157",
"territoryName": "U.S. t's & p's",
"territoryDescription": "U.S. Territories & Possessions"
},
{
"territoryId": "344",
"territoryName": "U.S. Virgin Islands",
"territoryDescription": "Virgin Islands, U.S."
},
{
"territoryId": "156",
"territoryName": "U.S.A.",
"territoryDescription": "U.S.A.[including territories & possessions]"
},
{
"territoryId": "13",
"territoryName": "U.S.A.[excl t's & p's]",
"territoryDescription": "U.S.A.[excluding Territories & Possessions]"
},
{
"territoryId": "81",
"territoryName": "U.S.S.R. (Former)",
"territoryDescription": "U.S.S.R. (Former)"
},
{
"territoryId": "66",
"territoryName": "Uganda",
"territoryDescription": "Uganda"
},
{
"territoryId": "320",
"territoryName": "Ukraine",
"territoryDescription": "Ukraine"
},
{
"territoryId": "148",
"territoryName": "United Arab Emirates",
"territoryDescription": "United Arab Emirates"
},
{
"territoryId": "107",
"territoryName": "United Kingdom",
"territoryDescription": "United Kingdom"
},
{
"territoryId": "1",
"territoryName": "Universe",
"territoryDescription": "Universe"
},
{
"territoryId": "224",
"territoryName": "Uruguay",
"territoryDescription": "Uruguay"
},
{
"territoryId": "321",
"territoryName": "Uzbekistan",
"territoryDescription": "Uzbekistan"
},
{
"territoryId": "75",
"territoryName": "Vanuatu",
"territoryDescription": "Vanuatu"
},
{
"territoryId": "225",
"territoryName": "Venezuela",
"territoryDescription": "Venezuela"
},
{
"territoryId": "133",
"territoryName": "Vietnam",
"territoryDescription": "Vietnam"
},
{
"territoryId": "325",
"territoryName": "Wallis & Futuna",
"territoryDescription": "Wallis & Futuna"
},
{
"territoryId": "180",
"territoryName": "West Germany",
"territoryDescription": "Germany, West (Former)"
},
{
"territoryId": "10201080",
"territoryName": "West Indies (Fmr British)",
"territoryDescription": "West Indies (Former British)"
},
{
"territoryId": "7",
"territoryName": "Western Europe",
"territoryDescription": "Europe, Western"
},
{
"territoryId": "67",
"territoryName": "Western Sahara",
"territoryDescription": "Western Sahara"
},
{
"territoryId": "155",
"territoryName": "Western Samoa",
"territoryDescription": "Western Samoa"
},
{
"territoryId": "2",
"territoryName": "World",
"territoryDescription": "World"
},
{
"territoryId": "250",
"territoryName": "Yemen Arab Republic",
"territoryDescription": "Yemen Arab Republic (Former)"
},
{
"territoryId": "251",
"territoryName": "Yemen People's Republic",
"territoryDescription": "Yemen People's Republic (Former)"
},
{
"territoryId": "5000344",
"territoryName": "Yugoslavia (Former)",
"territoryDescription": "Yugoslavia (Former)"
},
{
"territoryId": "69",
"territoryName": "Zambia",
"territoryDescription": "Zambia"
},
{
"territoryId": "70",
"territoryName": "Zimbabwe",
"territoryDescription": "Zimbabwe"
}
]
- Copy the territory object(s) into the selectedTerritories array in packageData.
Errors
The Sidecar API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized – Missing or invalid authenication |
| 403 | Forbidden – Invalid permissions |
| 404 | Not Found – The record does not exist |
| 422 | API Error – Invalid parameters provided for request to complete |
| 500 | Internal Server Error – We had a problem with our server. Try again later. |
| 503 | Service Unavailable – We’re temporarily offline for maintenance. Please try again later. |