FORMAT: 1A HOST: http://192.168.0.53:5555 # Group Vectorapi Group of all vectorapi-related resources. ## Release 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 or Film 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 ( in format of audio or film ) and Artwork ( a coverpage ). If user wants to create Film release then Film should be divided into chapters for which time should be specified. 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 submit, save, validate, approval and much more related functionality of releases. This resource also allow for multiple submission of releases too. ## Index [/vectorapi/release{?limit,vendorId,dimReleaseFlag,access_token}] ### Index [GET] + Parameters + limit (optional,number, `5`) + vendorId (required, number, `7123`) + dimReleaseFlag (required, number, `0`) + access_token (optional,varchar, `some token`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "envelope": { "header": { "apiVersion": "1.0", "baseUrl": "192.168.0.69", "httpStatusCode": 200 }, "request": "release/index?params=vectorapi&release&index&5&7123&0&&json", "response": { "releases": [ { "releaseId": 12, "upc": "123456789120", "releaseName": "Release 9", "releaseDate": "1983-05-11", "ArtistInfo": { "artistId": 52540, "name": "Nightingale Band", "vendorId": 7123 } }, { "releaseId": 13, "upc": "123456789121", "releaseName": "Release 5", "releaseDate": null, "ArtistInfo": { "artistId": 39146, "name": "Nightingale", "vendorId": 7123 } }, { "releaseId": 14, "upc": "123456789122", "releaseName": "Release 4", "releaseDate": null, "ArtistInfo": { "artistId": 39146, "name": "Nightingale", "vendorId": 7123 } }, { "releaseId": 15, "upc": "123456789123", "releaseName": "Release 6", "releaseDate": null, "ArtistInfo": { "artistId": 39143, "name": "Artist 5", "vendorId": 7123 } }, { "releaseId": 16, "upc": "123456789124", "releaseName": "Release 7", "releaseDate": null, "ArtistInfo": { "artistId": 39143, "name": "Artist 5", "vendorId": 7123 } } ], "totalRecords": "5940" } } } + **Other Optional Parameters** + limit + offset + pageNumber + totalRecords + vendorId + subaccountId + **Sort Options (optional)** + sortBy + sortOrder ## GET [/vectorapi/release/get{?access_token,release_id,getTrack}] ### Index [GET] + Parameters + access_token (optional,varchar, `some token`) + release_id (required,number, `1275544`) ... An unique identifier of the release. + getTrack (required,number, `0`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "release": { "release_id": 1275544, "upc": "5055122150435", "release_name": "Deck of Cards", "label": "Stage Door", "description": "", "release_date": "1959-01-01", "listprice": null, "sellprice": null, "display": "Y", "deletions": "N", "distribution": "digital", "applfees": null, "referral_id": null, "dateAddedRemove": null, "format": "Full Length", "orig_release_year": null, "promocode": null, "c_line": "2013 Stage Door Records", "manufacturer_upc": "", "album_download": "Y", "download_price": null, "priority": 3, "territory": null, "sale_start_date": "2014-02-02", "original_release_date": null, "vendor_catalog_number": "STAGE2033", "language_id": null, "subtitle_language_id": null, "promobox_no": null, "additional_id": null, "dracatalog": null, "channel_id": null, "trackdown_black_list": "N", "not_for_distribution": "N", "europe_public_domain": null, "karaoke": null, "unknown_artist": null, "new_release": "New", "product_format": null, "promos_number": null, "promo_upc": null, "sync_only": "N", "country_of_origin": null, "short_synopsis": null, "keywords": null, "production_co": null, "preorder_date": "2014-01-23", "amd_id": null, "wholesale_price_tier": null, "season": null, "episode": null, "production_number": null, "network": null, "genre_note": null, "vod_start_date": null, "physical_release_date": null, "theatrical_release_date": null, "original_digital_release_date": null, "est": null, "vod": null, "rsd_comment": null, "int_mkt_manager": null, "tms_id": null, "brand": null, "digital_only": "N", "version": "", "ingestion_completed": "2014-01-23 11:50:04", "release_status": "in_content", "display_upc": "5055122150435", "last_updated": "2014-04-29 16:49:15", "meta_language": "ENG", "itunes_previewable": "yes", "vendor_release_identifier": null, "ArtistInfo": { "artist_id": 646094, "url": "", "artist_email": null, "when_entered": { "date": "2014-01-23 06:47:26", "timezone_type": 3, "timezone": "America/New_York" }, "entered_by": "25991", "description": null, "name": "Wink Martindale", "vendor_id": 18730, "last_updated": null, "join_artist_id": null, "myspace_url": null, "myspace_id": null, "address_city": null, "address_state": null, "address_other_state": null, "orchard_country": 3, "active": "-", "tms_id": null, "address_zip": null, "youtube_mytourdate_url": null, "twitter_mytourdate_url": null, "primary_photo_id": null, "artist_type": "artist" }, "ProductType": { "id": 1, "product_type": "Music" }, "ProductSubtype": null, "Genre": { "genre_id": 7, "genre": "Pop" }, "ReleaseArtist": [], "Performer": [ { "release_artist_id": 1989405, "upc": "5055122150435", "artist_name": "Wink Martindale", "url": null, "role": "performer" } ], "ReleaseSubgenre": { "id": 1206672, "upc": "5055122150435", "Subgenre": { "orchard_id": 85, "name": "Male Vocalist" } }, "Subaccount": { "subaccount_id": 9250, "subaccount_name": "Stage Door", "website_url": "", "myspace_url": "", "city": "", "state_province": null, "description": "", "commission_override": 0, "date_deleted": null, "date_created": { "date": "2013-03-14 00:00:00", "timezone_type": 3, "timezone": "America/New_York" }, "last_updated": { "date": "2013-03-24 21:05:34", "timezone_type": 3, "timezone": "America/New_York" } }, "CdReceive": { "id": 886080, "upc": "5055122150435", "total_tracks": 10, "artist_name": "Wink Martindale", "release_name": "Deck of Cards", "date_received": "2014-01-23", "orchadmin_user_id": null, "rights_status": "not_evaluated", "asset_type": "release_builder", "image_scan": "Y", "image_scan_date": "2014-01-23", "encoding": "Y", "encoding_date": "2014-01-23", "total_tracks_encoded": 10, "harddrive_no": null, "comment": null, "qty_received": null, "video_mastered_date": null, "video_tracks_mastered": null, "video_mastered": null }, "is_mixed_release": false, "product_type": false } } + **Required Parameters** + release_id // This is primary key of youtube_channel table. ## POST [/vectorapi/release{?data,access_token,vendor_id}] ### Post [POST] + Parameters + data (required,varchar, `{"release_status":"label_processing","vendor_id":"7123","release_name":"Audio Release Test","vendor_catalog_number":"23123sfsdfsdf","label":"2006 Big Eye","release_date":"2013-01-18","sale_start_date":"2013-01-18","new_release":"New","manufacturer_upc":"123456789555","c_line":"2013 Record Label 1","genre_id":"20","description":"description description","meta_language":"ENG","distribution":"digital","vendor_release_identifier":"G0hb67uj89ikl0","artist_id":"39146", "version":"vr1","preorder_date":"1900-01-01","itunes_previewable":"yes","subaccount_id":"","format":"Full Length","last_updated":{},"changed_by_type":"vendor","asset_type":"release_builder","ReleaseSubgenre":["223"],"changed_by":"16228","Featuring":[{"artist_name":"rel_feat","role":"featuring"}],"Remixer":[{"artist_name":"rel_rem","role":"remixer"}],"Performer":[{"artist_name":"$aa_selenium_artist_1357918678818","role":"performer"}],"product_type":"music"}`) + access_token (optional,varchar, `some token`) + vendor_id (optional,number, `7123`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "release_id": 1372092 } + **Required Parameters** + artist_id + release_name + release_date + performer + format + genre + label + c_line + meta_language + changed_by + **Optional Parameters** + release_status + vendor_id + vendor_catalog_number + sale_start_date + description + distribution + vendor_release_identifier + preorder_date + itunes_previewable + subaccount_id + changed_by_type + asset_type + Featuring + Remixer + product_type ## DELETE [/vectorapi/release{?access_token,release_id}] ### DELETE [DELETE] + Parameters + access_token (optional,varchar, `some token`) + release_id (required, number ,`[1372092]`) + Request JSON Message + Headers Accept: application/json + Response 200 (application/json) + Body { "response": [ { "release_id": 1372091, "Tracks": [] } ], "status": "success" } + **Required Parameters** + release_id