FORMAT: 1A # Group Vectorapi Group of all vectorapi-related resources. ## Releasenew Release resource is responsible for managing all related functionality with a release. Release is the one which have main focus rather that any other module. In fact all other modules are directly or indirectly dependent on release resource. Eg. Artist. Artist is the one who wants to create release to publish it. User is allowable to create release in Audio format. User needs to fill all necessary detail information about release which he wants to publish. User needs to mentioned Artist name for which he wants to create release. Along with all details user need to upload tracks and Artwork ( a coverpage ). After filling all valid data user can submit it. Before publishing that release in store or before it it is visible to all users, it is very much important to approved it by Orchard Admin . After submission of release OA performs major role here. If admin finds sound data then he will approve it. Otherwise admin will reject it with appropriate reason. If Release is approved then it is visible for other users. And if its rejected then user needs to make improvement in provided information as per the comments specified in reason by Admin. This API resource manages the GET, INDEX and DELETE functionality for both audio and film release while POST, PUT functionality only for audio release ## Index [/vectorapi/releasenew/index{?dimReleaseFlag,fields,sortBy,sortOrder,limit,access_token}] Fetch releases data requested parameters ### Index [GET] + Parameters + dimReleaseFlag (optional, boolean, `false`) + fields (optional, varchar, `track,cdReceive`) + sortBy (optional, varchar, `releaseId`) + sortOrder (optional, varchar, `DESC`) + limit (optional, number, `2`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "/vectorapi/releasenew/index?dimReleaseFlag=false&fields=track%2CcdReceive&sortBy=releaseId&sortOrder=DESC&limit=2", "response": { "releases": [ { "releaseId": 1516338, "upc": "889176190568", "releaseName": "dredd release", "releaseDate": "2010-01-05", "ArtistInfo": { "artistId": 179552, "name": "Agnostic Front", "vendorId": 7123 }, "Track": [], "CdReceive": { "id": 1457225, "upc": "889176190568", "totalTracks": null, "artistName": "Agnostic Front", "releaseName": "dredd release", "dateReceived": "2015-01-16", "orchadminUserId": null, "rightsStatus": "not_evaluated", "assetType": "release_builder", "imageScan": "N", "imageScanDate": null, "encoding": "N", "encodingDate": null, "totalTracksEncoded": null, "harddriveNo": null, "comment": null, "qtyReceived": null, "videoMasteredDate": null, "videoTracksMastered": null, "videoMastered": null } }, { "releaseId": 1516337, "upc": "889176190537", "releaseName": "dredd release", "releaseDate": "2010-01-05", "ArtistInfo": { "artistId": 179552, "name": "Agnostic Front", "vendorId": 7123 }, "Track": [], "CdReceive": { "id": 1457224, "upc": "889176190537", "totalTracks": null, "artistName": "Agnostic Front", "releaseName": "dredd release", "dateReceived": "2015-01-16", "orchadminUserId": null, "rightsStatus": "not_evaluated", "assetType": "release_builder", "imageScan": "N", "imageScanDate": null, "encoding": "N", "encodingDate": null, "totalTracksEncoded": null, "harddriveNo": null, "comment": null, "qtyReceived": null, "videoMasteredDate": null, "videoTracksMastered": null, "videoMastered": null } } ], "totalRecords": "7371" } } } + **Other Optional Parameters** + Pagination Options : limit, offset + Sort Options : sort_by, sort_order (By default order is ASC) + Parameter options : vendorId, subaccountId, track, cdReceive, checkedOutBy, assignedTo,dateSubmitted, genre, subgenre ## GET [/vectorapi/releasenew/get{?id,access_token}] Fetch release data by provided release id + Parameters + id (required,number, `1360050`) + access_token (required,varchar, `some token`) ### Get [GET] + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "/vectorapi/releasenew/get?id=1360050", "response": { "release": { "releaseId": 1360050, "upc": "888831135388", "releaseName": "World Music & Turkish Soundtrack", "label": "121st Street Records", "description": "", "releaseDate": "1900-05-16", "listprice": null, "sellprice": null, "display": "Y", "deletions": "N", "distribution": "digital", "format": "Full Length", "origReleaseYear": null, "promocode": null, "cLine": "2014 Test Label", "manufacturerUpc": "", "albumDownload": "Y", "downloadPrice": null, "priority": 3, "territory": null, "saleStartDate": "1900-05-16", "originalReleaseDate": null, "vendorCatalogNumber": "", "languageId": null, "subtitleLanguageId": null, "additionalId": null, "channelId": null, "trackdownBlackList": "N", "notForDistribution": "N", "newRelease": "New", "promoUpc": null, "syncOnly": "N", "countryOfOrigin": null, "shortSynopsis": null, "keywords": null, "preorderDate": "1900-01-01", "amdId": null, "productionNumber": null, "vodStartDate": null, "physicalReleaseDate": null, "theatricalReleaseDate": null, "originalDigitalReleaseDate": null, "vod": null, "tmsId": null, "digitalOnly": "N", "version": "", "ingestionCompleted": null, "releaseStatus": "label_processing", "displayUpc": "888831135388", "lastUpdated": "2014-05-16 02:13:30", "metaLanguage": "ENG", "itunesPreviewable": "yes", "vendorReleaseIdentifier": "", "ProductType": { "id": 1, "productType": "Music" }, "ProductSubtype": null, "Genre": { "genreId": 11, "genre": "World Music" }, "ReleaseArtist": [ { "releaseArtistId": 2188260, "upc": "888831135388", "artistName": "ewrew", "url": null, "role": "composer" }, { "releaseArtistId": 2188261, "upc": "888831135388", "artistName": "7 Days", "url": null, "role": "performer" }, { "releaseArtistId": 2188262, "upc": "888831135388", "artistName": "Cappella", "url": null, "role": "performer" } ], "ReleaseSubgenre": { "id": 1296809, "upc": "888831135388", "Subgenre": { "orchardId": 885, "name": "Turkish Soundtrack" } }, "Subaccount": null } } } } + **Required Parameters** + id - Primary key of releases table. ## POST [/vectorapi/releasenew/post{?data,access_token}] Create new Audio release. ### Post [POST] + Parameters + data (required, varchar,`{"releaseName":"dredd release", "releaseStatus":"label_processing", "manufacturerUpc":null,"label":"Lookou LLC", "description":"Testing", "releaseDate":"2010-01-05", "saleStartDate":"2010-01-05", "display":"Y","deletions":"Y", "distribution":"digital", "format":"Single", "cLine":"2013 record label", "albumDownload":"Y","trackdownBlackList":"N", "newRelease":"New", "productType":"music", "productFormat":"LP", "artistId":"179552", "genreId":14,"releaseSubgenre":"490", "metaLanguage":"ENG", "performer":[{"artistName":"Performer111", "role":"primaryArtist"},{"artistName":"Test Performer2222", "role":"performer"}], "featuring":[{"artistName":"f111", "role":"featuring"},{"artistName":"Tf222", "role":"featuring"}], "remixer":[{"artistName":"rrr1111", "role":"remixer"},{"artistName":"rr222","role":"remixer"}], "changedBy":"20805", "assetType":"release_builder","itunesPreviewable":"yes","subtitleLanguageId":"ENG", "customerId":[1,2,3],"vendorCatalogNumber":"vendor catlog 24234"}`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "releasenew/post?params=vectorapi&releasenew&post&json&{\"releaseName\":\"dredd release\",\"releaseStatus\":\"label_processing\", \"manufacturerUpc\":null,\"label\":\"Lookou LLC\", \"description\":\"Testing\", \"releaseDate\":\"2010-01-05\", \"saleStartDate\":\"2010-01-05\", \"display\":\"Y\",\"deletions\":\"Y\", \"distribution\":\"digital\", \"format\":\"Single\", \"cLine\":\"2013 record label\", \"albumDownload\":\"Y\",\"trackdownBlackList\":\"N\", \"newRelease\":\"New\", \"productType\":\"music\", \"productFormat\":\"LP\", \"artistId\":\"179552\", \"genreId\":14,\"releaseSubgenre\":\"490\", \"metaLanguage\":\"ENG\", \"performer\":[{\"artistName\":\"Performer111\", \"role\":\"primaryArtist\"},{\"artistName\":\"Test Performer2222\", \"role\":\"performer\"}], \"featuring\":[{\"artistName\":\"f111\", \"role\":\"featuring\"},{\"artistName\":\"Tf222\", \"role\":\"featuring\"}], \"remixer\":[{\"artistName\":\"rrr1111\", \"role\":\"remixer\"},{\"artistName\":\"rr222\",\"role\":\"remixer\"}], \"changedBy\":\"20805\", \"assetType\":\"release_builder\",\"itunesPreviewable\":\"yes\",\"subtitleLanguageId\":\"ENG\", \"customerId\":[1,2,3],\"vendorCatalogNumber\":\"vendor catlog 24234\"}&", "response": { "releaseId": 1372073, "additional_info": "" } } } + **Required Parameters** + releaseName + label + releaseDate + saleStartDate + format + cLine + productType + saleStartDate + artistId + genreId + releaseSubgenre + metaLanguage + performer + **Optional Parameters** + releaseStatus + vendorCatalogNumber + description + distribution + vendorReleaseIdentifier + preorderDate + itunesPreviewable + changedByType(either oa or Vendor) + assetType + featuring + remixer + releaseArtist + productFormat + trackdownBlackList + albumDownload + languageId + subtitleLanguageId + itunesPreviewable ## Put [/vectorapi/releasenew/put{?id,data,access_token}] Update Audio release. ### Put [POST] + Parameters + id (required, number, `1516348`) + data (required, varchar,`{"releaseName":"Updating dredd release ","releaseStatus":"label_processing", "subaccountId":"", "manufacturerUpc":null,"label":"test label127", "description":"Testing", "format":"Single", "cLine":"2013 updating cline", "albumDownload":"Y","trackdownBlackList":"N", "productFormat":"LP", "genreId":14,"releaseSubgenre":"490", "metaLanguage":"ENG", "performer":[{"artistName":"Performer555", "role":"primaryArtist"},{"artistName":"Test Performer555","role":"performer"}], "featuring":[{"artistName":"f155", "role":"featuring"},{"artistName":"T55", "role":"featuring"}], "remixer":[{"artistName":"rrr1111", "role":"remixer"},{"artistName":"rr5511","role":"remixer"}], "changedBy":"20805", "assetType":"release_builder","itunesPreviewable":"yes", "customerId":[1,2,3], "vendorCatalogNumber":"vendor catlog 24234"}`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "releasenew/put?params=vectorapi&releasenew&put&json&1372073&{\"releaseName\":\"Updating dredd release \",\"releaseStatus\":\"label_processing\", \"subaccountId\":\"\", \"manufacturerUpc\":null,\"label\":\"test label127\", \"description\":\"Testing\", \"format\":\"Single\", \"cLine\":\"2013 updating cline\", \"albumDownload\":\"Y\",\"trackdownBlackList\":\"N\", \"productFormat\":\"LP\", \"genreId\":14,\"releaseSubgenre\":\"490\", \"metaLanguage\":\"ENG\", \"performer\":[{\"artistName\":\"Performer555\", \"role\":\"primaryArtist\"},{\"artistName\":\"Test Performer555\",\"role\":\"performer\"}], \"featuring\":[{\"artistName\":\"f155\", \"role\":\"featuring\"},{\"artistName\":\"T55\", \"role\":\"featuring\"}], \"remixer\":[{\"artistName\":\"rrr1111\", \"role\":\"remixer\"},{\"artistName\":\"rr5511\",\"role\":\"remixer\"}], \"changedBy\":\"20805\", \"assetType\":\"release_builder\",\"itunesPreviewable\":\"yes\", \"customerId\":[1,2,3], \"vendorCatalogNumber\":\"vendor catlog 24234\"}&", "response": { "releaseId": 1516348, "additional_info": "" } } } + **Required Parameters** + id - primary key of releases table. + **Optional Parameters** + releaseName + label + releaseDate + saleStartDate + format + cLine + productType + saleStartDate + artistId + genreId + releaseSubgenre + metaLanguage + performer + releaseStatus + vendorCatalogNumber + description + distribution + vendorReleaseIdentifier + preorderDate + itunesPreviewable + changedByType(either oa or Vendor) + assetType + featuring + remixer + releaseArtist + productFormat + trackdownBlackList + albumDownload + languageId + subtitleLanguageId + itunesPreviewable ## Delete [/vectorapi/releasenew/delete{?id,access_token}] ### Delete [DELETE] + Parameters + id (number, `1372065`) + access_token (varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "releasenew/delete?params=vectorapi&releasenew&delete&json&1372065&", "response": { "releaseId": 1372065, "Tracks": [ 16735659 ] } } } + **Required Parameters** + id - primary key of releases table. ## POST [/vectorapi/releasenew/post{?data,access_token}] Create new Film release. ### Post [POST] + Parameters + data (required, varchar,`{"vendorId": 16055,"releaseName": "Test Release","vendorCatalogNumber": null,"label": "2012 Synergy","releaseDate": "2012-05-04","saleStartDate": "2012-05-04","newRelease": "New","manufacturerUpc": null,"cLine": "2012 VAPItestlabel","genreId": null,"metaLanguage": "GER","itunesPreviewable": null,"distribution":"digital","artistId": "181596","version": null,"format": "null","lastUpdated": "","changedByType": "vendor","assetType": "release_builder","ReleaseSubgenre": null,"changedBy": "16228","productType": "Movie","productSubtype": "5","languageId": "POR","countryOfOrigin": "44","subtitleLanguage": "","primaryGenre": "26","secondaryGenres": ["39","21","13","8"],"shortSynopsis": "A demo release for testing.....","description": "A demo release for testing. It;s done....","vodStartDate": "2012-05-23","physicalReleaseDate": "2012-05-04","theatricalReleaseDate": "2012-05-18","subaccountId": 1}`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "releasenew/post?params=vectorapi&releasenew&post&json&{\"vendorId\": 16055,\"releaseName\": \"Test Release\",\"vendorCatalogNumber\": null,\"label\": \"2012 Synergy\",\"releaseDate\": \"2012-05-04\",\"saleStartDate\": \"2012-05-04\",\"newRelease\": \"New\",\"manufacturerUpc\": null,\"cLine\": \"2012 VAPItestlabel\",\"genreId\": null,\"metaLanguage\": \"GER\",\"itunesPreviewable\": null,\"distribution\":\"digital\",\"artistId\": \"181596\",\"version\": null,\"format\": \"null\",\"lastUpdated\": \"\",\"changedByType\": \"vendor\",\"assetType\": \"release_builder\",\"ReleaseSubgenre\": null,\"changedBy\": \"16228\",\"productType\": \"Movie\",\"productSubtype\": \"5\",\"languageId\": \"POR\",\"countryOfOrigin\": \"44\",\"subtitleLanguage\": \"\",\"primaryGenre\": \"26\",\"secondaryGenres\": [\"39\",\"21\",\"13\",\"8\"],\"shortSynopsis\": \"A demo release for testing.....\",\"description\": \"A demo release for testing. It;s done....\",\"vodStartDate\": \"2012-05-23\",\"physicalReleaseDate\": \"2012-05-04\",\"theatricalReleaseDate\": \"2012-05-18\",\"subaccountId\": 1}&", "response": { "releaseId": 1372090, "additional_info": "" } } } + **Required Parameters** + releaseName + label + releaseDate + saleStartDate + productType + artistId + metaLanguage + performer + physicalReleaseDate + primaryGenre + secondaryGenres + languageId + **Optional Parameters** + releaseStatus + vendorCatalogNumber + description + languageId + distribution + vendorReleaseIdentifier + itunesPreviewable + changedByType(either oa or Vendor) + assetType + featuring + remixer + productFormat + trackdownBlackList + albumDownload + itunesPreviewable + subtitleLanguageId ## POST [/vectorapi/releasenew/put{?id,vendorId,data,access_token}] Update status of release from label_processing to orchard_processing. ### Put [POST] + Parameters + id (required, number, `1359959`) + vendorId (required, number, `7123`) + data (required, varchar,`{"releaseName":"transferring to orchard processing", "releaseStatus":"orchard_processing"}`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "releasenew/put?params=vectorapi&releasenew&put&json&1360045&7123&{\"releaseName\":\"transferring to orchard processing\", \"releaseStatus\":\"orchard_processing\"}&", "response": { "releaseId": 1360045, "additional_info": "" } } } + **Required Parameters** + id - primary key of releases table. + vendorId + data ## POST [/vectorapi/releasenew/put{?id,vendorId,data,access_token}] Transfer the release from label_processing or orchard_processing to transfer_to_content. ### Put [POST] + Parameters + id (required, number, `1372105`) + vendorId (required, number, `7123`) + data (required, varchar,`{"releaseStatus":"transfer_to_content"}`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "releasenew/put?params=vectorapi&releasenew&put&json&1372105&7123&{\"releaseStatus\":\"transfer_to_content\"}&", "response": { "releaseId": 1372105, "additional_info": "" } } } + **Required Parameters** + id - primary key of releases table. + vendorId ## POST [/vectorapi/releasenew/put{?id,vendorId,data,access_token}] Transfer the release from transfer_to_content to in_content status. ### Put [POST] + Parameters + id (required, number, `1372105`) + vendorId (required, number, `7123`) + data (required, varchar,`{"releaseStatus":"in_content"}`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "releasenew/put?params=vectorapi&releasenew&put&json&1372105&7123&{\"releaseStatus\":\"in_content\"}&", "response": { "releaseId": 1372105, "additional_info": "" } } } + **Required Parameters** + id - primary key of releases table. + vendorId ## POST [/vectorapi/releasenew/post{?data,access_token}] Create new classical Audio release. ### Post [POST] + Parameters + data (required, varchar,`{"releaseName":"dredd release","releaseStatus":"label_processing", "manufacturerUpc":null,"label":"Lookou LLC", "description":"Testing", "releaseDate":"2010-01-05", "saleStartDate":"2010-01-05", "display":"Y","deletions":"Y", "distribution":"digital", "format":"Single", "cLine":"2013 record label", "albumDownload":"Y","trackdownBlackList":"N", "newRelease":"New", "productType":"music", "productFormat":"LP", "artistId":"179552", "genreId":12,"releaseSubgenre":"265", "metaLanguage":"ENG", "performer":[{"artistName":"Performer111", "role":"primaryArtist"},{"artistName":"Test Performer2222", "role":"performer"}], "featuring":[{"artistName":"f111", "role":"featuring"},{"artistName":"Tf222", "role":"featuring"}], "remixer":[{"artistName":"rrr1111", "role":"remixer"},{"artistName":"rr222","role":"remixer"}], "changedBy":"20805", "assetType":"release_builder","itunesPreviewable":"yes","subtitleLanguageId":"ENG", "customerId":[1,2,3],"vendorCatalogNumber":"vendor catlog 24234","releaseArtist":[{"artistName":"A Guy","role":"composer"},{"artistName":"Some People","role":"orchestra"},{"artistName":"The Thing","role":"ensemble"},{"artistName":"A Dude","role":"conductor"}]}`) + access_token (required, varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.55", "httpStatusCode": 200 }, "request": "/vectorapi/releasenew/post?data=%7B%22releaseName%22%3A%22dredd%20release%22%2C%22releaseStatus%22%3A%22label_processing%22%2C%20%22manufacturerUpc%22%3Anull%2C%22label%22%3A%22Lookou%20LLC%22%2C%20%22description%22%3A%22Testing%22%2C%20%22releaseDate%22%3A%222010-01-05%22%2C%20%22saleStartDate%22%3A%222010-01-05%22%2C%20%22display%22%3A%22Y%22%2C%22deletions%22%3A%22Y%22%2C%20%22distribution%22%3A%22digital%22%2C%20%22format%22%3A%22Single%22%2C%20%22cLine%22%3A%222013%20record%20label%22%2C%20%22albumDownload%22%3A%22Y%22%2C%22trackdownBlackList%22%3A%22N%22%2C%20%22newRelease%22%3A%22New%22%2C%20%22productType%22%3A%22music%22%2C%20%22productFormat%22%3A%22LP%22%2C%20%22artistId%22%3A%22179552%22%2C%20%22genreId%22%3A12%2C%22releaseSubgenre%22%3A%22265%22%2C%20%22metaLanguage%22%3A%22ENG%22%2C%20%22performer%22%3A%5B%7B%22artistName%22%3A%22Performer111%22%2C%20%22role%22%3A%22primaryArtist%22%7D%2C%7B%22artistName%22%3A%22Test%20Performer2222%22%2C%20%22role%22%3A%22performer%22%7D%5D%2C%20%22featuring%22%3A%5B%7B%22artistName%22%3A%22f111%22%2C%20%22role%22%3A%22featuring%22%7D%2C%7B%22artistName%22%3A%22Tf222%22%2C%20%22role%22%3A%22featuring%22%7D%5D%2C%20%22remixer%22%3A%5B%7B%22artistName%22%3A%22rrr1111%22%2C%20%22role%22%3A%22remixer%22%7D%2C%7B%22artistName%22%3A%22rr222%22%2C%22role%22%3A%22remixer%22%7D%5D%2C%20%22changedBy%22%3A%2220805%22%2C%20%22assetType%22%3A%22release_builder%22%2C%22itunesPreviewable%22%3A%22yes%22%2C%22subtitleLanguageId%22%3A%22ENG%22%2C%20%22customerId%22%3A%5B1%2C2%2C3%5D%2C%22vendorCatalogNumber%22%3A%22vendor%20catlog%2024234%22%7D&access_token=some token", "response": { "releaseId": 1516356, "additional_info": "" } } } + **Required Parameters** + releaseName + label + releaseDate + saleStartDate + format + cLine + productType + saleStartDate + artistId + genreId + releaseSubgenre + metaLanguage + performer + **Optional Parameters** + releaseStatus + vendorCatalogNumber + description + distribution + vendorReleaseIdentifier + preorderDate + itunesPreviewable + changedByType(either oa or Vendor) + assetType + featuring + remixer + releaseArtist + productFormat + trackdownBlackList + albumDownload + languageId + subtitleLanguageId + itunesPreviewable