The Harvest Media API comprises two key endpoints that are designed for delivery of different services both leveraging off assets and resources stored within the Harvest Media platform.
\nEach resource is assigned its own Service URL and is manipulated in isolation.
\nMethods in one API will not work in the other.
\n1. The Harvest Media Public API
\nThe Public API allows clients to leverage off assets within the Harvest Media platform and provides access to audio and metadata, transcoding, member management, downloads, samples and search functions.
This is primarily used to build custom music search engines and management tools.
2. The Harvest Media Export API
\nThe Export API allows content to be sent to clients, networks, and third parties so that they can automate the deliver of audio and metadata into their systems instead of receiving deliveries to FTP.
\nThis is designed to handle bulk content movement and delivery along with access to metadata and audio files.
\n\nIncluded at the bottom of our documentation is Additional Information common to both end-points including:
\nRelease notes & updates
\nGlossary of terms
\nAPI Response codes*
\nSupport
\nAll support queries should be sent to support@harvestmedia.net.
\nIf you have any functionality that you feel would be a great addition to Harvest Media and/or the Harvest Media API then please reach out to our team.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8325040","collectionId":"1fdbc3d4-864c-498a-ae3e-ae52d2c5b256","publishedId":"SVYouLCf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6633"},"publishDate":"2020-06-29T04:04:49.000Z"},"item":[{"name":"Public API","item":[{"name":"Getting Started","item":[{"name":"Implementation Guide - Getting Started","id":"f403ac1f-c9c0-44fd-97c8-038d8ca7286a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"Authorization
\nAuthorization is the first development step in integrating with the API. To do so you will need the Client ID, Client Secret, Access key & Authorization Endpoint outlined in the Security & oAuth 2.0 section above.
\nIn response to authorizing with the API you will be provisioned a Access Token.
\nService Token
\nThe second step is to obtain a Service Token. A Service Token represents a claim on the API, essentially acting as the means by which the API verifies access to specific methods.
\nService Tokens are expiration-based, which means they can, and will, expire. The expiration date is provided as part of the authorization response and will help to determine when a renewal is required. Given this expiration date, we recommend that your website does not wait until a service token has expired, but rather renew it early to prevent any possible issues during natural expiration.
\nFurther, it is recommended you maintain the Service Token in Application Cache or another data store so that all users of your website can share the same Service Token.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"f403ac1f-c9c0-44fd-97c8-038d8ca7286a"},{"name":"Get Authorised","event":[{"listen":"test","script":{"id":"bc68800f-115c-4163-8bd7-5e5b1872c367","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataToken = \"\";","","/*if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataToken = jsonData.responseservicetoken.token.$.value;","} else {*/"," jsonData = JSON.parse(responseBody)"," jsonDataToken = jsonData.access_token;","/*}*/","","console.log(\"HM_ServiceAPI_AuthToken set to \" + jsonDataToken);","","postman.setEnvironmentVariable(\"HM_ServiceAPI_AuthToken\", jsonDataToken);","","postman.setNextRequest(\"Get Service Token\");"],"type":"text/javascript"}}],"id":"8fecff8a-9c87-4f2e-af3e-44e5f37dcaf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","type":"text","value":"{{HM_ServiceAPI_AuthGrantType}}"},{"key":"client_id","type":"text","value":"{{HM_ServiceAPI_AuthClientID}}"},{"key":"client_secret","type":"text","value":"{{HM_ServiceAPI_AuthClientSecret}}"}]},"url":"{{HM_ServiceAPI_AuthUrl}}","description":"Returns an Access Token that is required for access to all API methods. The Access Token must be included as an \"Authorization\" Header for all requests sent to the API. Without it, any request made to the API will be denied.
\nRequest Elements
\nRequest Notes
\nThe request form key \"grant_type\" must have it's value set to the string \"client_credentials\". Please see the example for reference.
\nResponse Notes
\nThe response value \"expires_in\" is a value in seconds and represents the expiration for this Access Token. A new Access Token must be requested within that expiration period or Access will be revoked.
\n","urlObject":{"host":["{{HM_ServiceAPI_AuthUrl}}"],"query":[],"variable":[]}},"response":[{"id":"89f0e4f4-1c29-4c9e-b6f1-80e72e221740","name":"Get Authorised (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","type":"text","value":"client_credentials"},{"key":"client_id","type":"text","value":"Request Elements
\n","urlObject":{"path":["getservicetoken"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f5383945-d2ad-4eb4-b11a-ddd09b70472b","name":"Get Service Token (XML)","originalRequest":{"method":"GET","header":[{"key":"AccessKey","value":"{{HM_ServiceAPI_Key}} ","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getservicetoken"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Thu, 08 Aug 2019 01:41:05 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"320"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis operation will return the details of the service token, notably the expiry date and the creation date.
\nDate format will be UTC+10 or UTC+11 and shown as YYYY-MM-DDTHH:MM:SS:SSS.
\nReturns Service Token details which include:
\nRequest Elements
\n","urlObject":{"path":["getservicetokeninfo","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"57bacbc4-e276-4527-b082-2b8358d23344","name":"Validate Service Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getservicetokeninfo/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Thu, 08 Aug 2019 01:42:43 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"343"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis operation will expire the provided Service Token immediately.
\nAny subsequent calls to the API using the provided Service Token will result in an error response.
\nRequest Elements
\n","urlObject":{"path":["expiretoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"733c7224-ad83-4339-bae5-e1ecb251265c","name":"Expire Service Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/expiretoken/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 02:02:09 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"f6725445-11cb-4288-99bf-e9cc0a49a65d","name":"Expire Service Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/expiretoken/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 02:02:42 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nWaveforms are an important visualization of audio, that users interact with.
\nCurrently we support two differing ways of requesting waveforms:
\nThe way in which you use each of these varies, however the core idea remains the same in that the waveform is generated off a set of datapoints that is extracted from an analysis of the audio master file.
\nThis method takes away the need for your website to have to build the waveform itself. Instead it relies on an on-demand generation of the waveform with specified parameters. These parameters are sent as part of the URL. The waveform that is returned is done so as a PNG.
\nOne important aspect of this method to consider is that the waveform is generated at a specific width & height that is provided at the time of generation. This means that for sites that are responsive, you can either scale the existing image based on the new browser size (maintaining aspect ratio) or you can re-request a newly generated waveform at the width & height. We recommend re-requesting the waveform however you should only perform the request after the user has stopped resizing their browser - otherwise you could be requesting image for each pixel adjustment which will result in a very slow user experience.
\nRequest Notes: WaveFormURL
\nThis method provides the datapoints back in the request for the requester to implement the waveform with.
\nOne important aspect of this method is that it is more efficient and effective for responsive websites, as there will not need to be subsequent requests as the browser changes in size.
\nRequest Notes: WaveformDataPointUrl
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"860148a4-a6c3-4afe-9c89-960c0b36c699"},{"name":"Implementation Guide - Tracking Usage & Asset URLs","id":"3aee9d7e-593f-4734-a87f-e11750816f5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"An important part of integrating with the Harvest Media Public API is leveraging off the assets that are ingested alongside the metadata, however, it should be taken one step further. Instead of just utilising the assets you should endevour to track the usage of these assets (e.g. tracking sample usage). The following outlines two different paths that can be taken to achieve this; single region path, multiple region path.
\n1) Single Region Implementation
\nThis path should be taken when you know that your implementation will only use a single Harvest Media defined region. If you are unsure as to whether your implementation will be single or multiple, then we recommend taking the multiple region path to future proof your solution.
\nFor a single region;
\nPlease note that Get Service Info should be re-requested each time your implementation requests a new service token. Failing to do so may result in failed usage tracking for guests.
\n2) Multiple Regions Implementation
\nThis path should be taken when you know that your implementation will use multiple Harvest Media defined regions. If you are unsure as to whether your implementation will be single or multiple, then we recommend taking this path to future proof your solution.
\nFor multiple regions;
\nGetServiceInfo returns image, download and file format URL patterns that are required to access assets for members.
\nFor more details please see:
\nThere is also a property isdefaultdownloadfortype-\"true\" which is a default for the available types (WAV,AIFF,MP3).
\nThese can also be define for members (see Members).
\nRequest Elements
\nRequest Notes
\nResponse Notes
\n","urlObject":{"path":["getserviceinfo","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"be2bb899-6962-4314-9fb4-ebbc2f15f42c","name":"Get Service Info (Service Asset URLs and File Formats) (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getserviceinfo/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Jun 2024 13:52:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ServiceInfoURLs\": {\n \"DirectDownloadURL\": \"https://dl.harvestmedia.net/assets/downloads/{downloadtoken}\",\n \"TrackStreamURL\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/samples/abc78243569b28ba654321/{id}\",\n \"ProfileImageURL\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/memberprofile/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"AlbumMontageSampleURL\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/samples/montage/abc78243569b28ba654321/{id}\",\n \"AlbumArtURL\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/albumart/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"WaveformURL\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/waveforms/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"MontageWaveformURL\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/waveforms/montage/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"LibraryLogoUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/librarylogo/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"PlaylistArtUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/playlistart/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"PlaylistCategoryArtUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/playlistcategoryart/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"RightHolderProfileUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/rightholderprofile/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"WaveformDataPointUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/waveform_data/abc78243569b28ba654321/{id}/{dataformat}\",\n \"StyleArtUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/styleart/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"MemberGroupLogoUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/membergrouplogo/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"MemberGroupArtUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/membergroupart/abc78243569b28ba654321/{id}/{width}/{height}\",\n \"MemberGroupProductionArtUrl\": \"https://e3xslkmk3mm6yh.cloudfront.net/assets/membergroupproductionart/abc78243569b28ba654321/{id}/{width}/{height}\"\n },\n \"SearchSimilarInfo\": [\n {\n \"Name\": \"Jukebox HM AIMS\",\n \"Type\": \"AIMS\",\n \"Settings\": {\n \"SimiliarByTrackID\": {\n \"Allow\": true,\n \"Types\": [],\n \"MaximumDuration\": 0,\n \"MaximumSize\": 0,\n \"AllowPrioritizeBPM\": true,\n \"AllowIgnoreVocals\": true,\n \"AllowHighlights\": true,\n \"AllowSegmentSelection\": true,\n \"MaximumSegmentSelectionDuration\": 60\n },\n \"SimiliarByUpload\": {\n \"Allow\": true,\n \"Types\": [\n \"mp3\",\n \"wav\"\n ],\n \"MaximumDuration\": 900,\n \"MaximumSize\": 120,\n \"AllowPrioritizeBPM\": true,\n \"AllowIgnoreVocals\": true,\n \"AllowHighlights\": true,\n \"AllowSegmentSelection\": true,\n \"MaximumSegmentSelectionDuration\": 60\n },\n \"SimiliarByUrl\": {\n \"Allow\": true,\n \"Types\": [\n \"YouTube\",\n \"Spotify\",\n \"Vimeo\",\n \"SoundCloud\",\n \"AppleMusic\",\n \"TikTok\"\n ],\n \"MaximumDuration\": 900,\n \"MaximumSize\": 0,\n \"AllowPrioritizeBPM\": true,\n \"AllowIgnoreVocals\": true,\n \"AllowHighlights\": true,\n \"AllowSegmentSelection\": true,\n \"MaximumSegmentSelectionDuration\": 60\n },\n \"AllowMultiSeedSearching\": true,\n \"AllowPaging\": false,\n \"AllowFilterSearching\": false\n }\n },\n {\n \"Name\": \"Jukebox HM CYANITE\",\n \"Type\": \"CYANITE\",\n \"Settings\": {\n \"SimiliarByTrackID\": {\n \"Allow\": true,\n \"Types\": [],\n \"MaximumDuration\": 0,\n \"MaximumSize\": 0,\n \"AllowPrioritizeBPM\": false,\n \"AllowIgnoreVocals\": false,\n \"AllowHighlights\": false,\n \"AllowSegmentSelection\": false,\n \"MaximumSegmentSelectionDuration\": 0\n },\n \"SimiliarByUpload\": {\n \"Allow\": true,\n \"Types\": [\n \"mp3\"\n ],\n \"MaximumDuration\": 900,\n \"MaximumSize\": 120,\n \"AllowPrioritizeBPM\": false,\n \"AllowIgnoreVocals\": false,\n \"AllowHighlights\": false,\n \"AllowSegmentSelection\": false,\n \"MaximumSegmentSelectionDuration\": 0\n },\n \"SimiliarByUrl\": {\n \"Allow\": true,\n \"Types\": [\n \"YouTube\",\n \"Spotify\"\n ],\n \"MaximumDuration\": 900,\n \"MaximumSize\": 0,\n \"AllowPrioritizeBPM\": false,\n \"AllowIgnoreVocals\": false,\n \"AllowHighlights\": false,\n \"AllowSegmentSelection\": false,\n \"MaximumSegmentSelectionDuration\": 0\n },\n \"AllowMultiSeedSearching\": false,\n \"AllowPaging\": false,\n \"AllowFilterSearching\": false\n }\n }\n ],\n \"FileFormats\": [\n {\n \"ID\": \"19b8f5935503tggy\",\n \"FileExtension\": \"mp3\",\n \"BitRate\": 320000,\n \"SampleRate\": 44.1,\n \"SampleSize\": 0,\n \"IsMaster\": false,\n \"Isdefaultdownload\": true,\n \"isdefaultdownloadfortype\": true,\n \"usemasterifnotavailable\": false\n },\n {\n \"ID\": \"99dc08a83ff1621r\",\n \"FileExtension\": \"aif\",\n \"BitRate\": 1536000,\n \"SampleRate\": 48,\n \"SampleSize\": 16,\n \"IsMaster\": false,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": false,\n \"usemasterifnotavailable\": false\n },\n {\n \"ID\": \"bce3cac31bcb8534\",\n \"FileExtension\": \"aif\",\n \"BitRate\": 1411200,\n \"SampleRate\": 44.1,\n \"SampleSize\": 16,\n \"IsMaster\": false,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": false,\n \"usemasterifnotavailable\": false\n },\n {\n \"ID\": \"d59bc885aeeb0e12\",\n \"FileExtension\": \"mp3\",\n \"BitRate\": 256000,\n \"SampleRate\": 48,\n \"SampleSize\": 0,\n \"IsMaster\": false,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": false,\n \"usemasterifnotavailable\": false\n },\n {\n \"ID\": \"7026280a00766601\",\n \"FileExtension\": \"mp3\",\n \"BitRate\": 128000,\n \"SampleRate\": 44.1,\n \"SampleSize\": 0,\n \"IsMaster\": false,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": false,\n \"usemasterifnotavailable\": false\n },\n {\n \"ID\": \"47ec1487133769b9\",\n \"FileExtension\": \"mp3\",\n \"BitRate\": 96000,\n \"SampleRate\": 44.1,\n \"SampleSize\": 0,\n \"IsMaster\": false,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": false,\n \"usemasterifnotavailable\": false\n },\n {\n \"ID\": \"0cd0dbbf8c4d6621\",\n \"FileExtension\": \"wav\",\n \"BitRate\": 0,\n \"SampleRate\": 0,\n \"SampleSize\": 0,\n \"IsMaster\": true,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": false,\n \"usemasterifnotavailable\": false\n },\n {\n \"ID\": \"cf95c1161cfc5d16\",\n \"FileExtension\": \"aif\",\n \"BitRate\": 0,\n \"SampleRate\": 0,\n \"SampleSize\": 0,\n \"IsMaster\": true,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": false,\n \"usemasterifnotavailable\": false\n }\n ],\n \"AccountGlobalSettingsAndRegions\": {\n \"Account\": {\n \"FileDownloadNameConvention\": \"[library no]_TK[TRACK NO]_[TRACK DISPLAY TITLE]_[composer]_[publisher]\",\n \"RankExpression\": \"\",\n \"SearchFieldsValue\": 31777786,\n \"MaxBPM\": 200,\n \"MinBPM\": 60,\n \"MaxDuration\": 504,\n \"MinDuration\": 4\n },\n \"Regions\": [\n {\n \"ID\": \"4bece7bcdj34i21k\",\n \"FileDownloadNameConvention\": \"[LIBRARY PREFIX]_[attribute_AnE]\",\n \"LicensingModel\": \"None\",\n \"Blocked\": false\n },\n {\n \"ID\": \"01b2527888fd94tt\",\n \"FileDownloadNameConvention\": \"[LIBRARY PREFIX]_[TRACK NO]\\t_attribute_AEVM]_TRACK DISPLAY TITLE]\",\n \"LicensingModel\": \"None\",\n \"Blocked\": false\n },\n {\n \"ID\": \"c345ed4ec786fskl\",\n \"FileDownloadNameConvention\": \"[library no]_[TRACK NO]_[TRACK DISPLAY TITLE]_[writer]\",\n \"LicensingModel\": \"None\",\n \"Blocked\": false\n },\n {\n \"ID\": \"88f8791e732f09i0\",\n \"FileDownloadNameConvention\": \"[TRACK NO]_[TRACK DISPLAY TITLE]_[TRACK NO]_VERSION]\",\n \"LicensingModel\": \"None\",\n \"Blocked\": false\n }\n ]\n }"},{"id":"2d77640e-eeb2-4240-802f-1e7bd963cc45","name":"Get Service Info (Service Asset URLs and File Formats) (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml-dtd"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getserviceinfo/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 11 Jul 2024 17:40:53 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns all Attributes for the service.
\nRequest Elements
\n","urlObject":{"path":["getserviceattribute","{{HM_ServiceAPI_Token}}","{attributeTypeCode}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"887e28d6-e970-4e7c-be22-dcf4e6745215","name":"Get Service Attributes (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getserviceattribute/{{HM_ServiceAPI_Token}}/{AttributeTypeCode}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 04:19:19 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"361"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a short URL using the default \"hrvst.co\" domain.
\nRequest Elements
\n","urlObject":{"path":["getshorturl","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"49450c9f-682c-4a38-9304-cc5355616938","name":"Get Short URL (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"text/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Returns a list of all regions configured on the account.
\nRequest Elements
\nRequest Notes
\nThe are three possible values for RegionSelectionOnly;
\n?regionselectiononly=true - this will return all Regions which are marked as available for Region Selection?regionselectiononly=false - this will return all regions which are marked as not available for Region SelectionReturns the details of a specific Region.
\nRequest Elements
\n","urlObject":{"path":["getregion","{{HM_ServiceAPI_Token}}","{RegionID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"59c2b87e-90ff-4e67-b933-eaabbbda643a","name":"Get Region (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getregion/{{HM_ServiceAPI_Token}}/3a62f6be7414498b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 04:44:05 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"301"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Region\": {\n \"ID\": \"3a6a2f6be74144198b\",\n \"Name\": \"Australia\",\n \"Countries\": [\n {\n \"TLD\": \"AU\",\n \"Name\": \"Australia\",\n\t\t \"IsTaxed\": false,\n\t\t \"TaxRate\": 0.0000\n }\n ],\n \"LanguageCode\": \"\",\n \t\"SubscribeDefault\": false,\n \t\"LicensingModel\": \"None\",\n \t\"Currency\": {\n \t\t\"Name\": \"Australian\",\n\t \"Code\": \"AUD\",\n \t\"Symbol\": \"A$\"\n \t},\n \"Blocked\": false\n }\n}"},{"id":"e6ecf7f0-f9ed-4fad-8b42-0fc2cc185efd","name":"Get Region (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getregion/{{HM_ServiceAPI_Token}}/3a62f6be7414498b"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 04:44:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"311"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns regions using an IPv4 or IPv6 address.
\nRequest Elements
\nYou can set subscription defaults to regions in the Admin via Account Settings>Regions.
\nTypically this is used in front-ends to pre-select any newsletter subscription services upon signing up.
\nThere are three possible values: opt-in, opt-out, assumed opt-in. The API currently does not support assumed opt-in but does support the other two options.
\n\"SubscribeDefault\" field will be returned upon calling the getregions endpoint if you have assigned either of the valid endpoints, it will be \"true\" when opt-in is selected for that region and \"false\" for opt-out.
\n","urlObject":{"path":["getregionbyip","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"description":{"content":"IPv4 or IPv6 IP address
\n","type":"text/plain"},"key":"ip","value":"{IP}"}],"variable":[]}},"response":[{"id":"d85d66f5-6e94-48fa-bb07-5aafd5355b52","name":"Get Regions by IP (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getregionbyip/{{HM_ServiceAPI_Token}}?ip={IP}","host":["{{HM_ServiceAPI_URL}}"],"path":["getregionbyip","{{HM_ServiceAPI_Token}}"],"query":[{"key":"ip","value":"{IP}","description":"IPv4 or IPv6 IP address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 04:47:35 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"380"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a list of countries available for the account.
\nThis list of countries can be used in conjunction with the Register Member [InsertLink] operation to provide valid Country codes.
\nRequest Elements
\n","urlObject":{"path":["getcountries","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"391c7fc3-e715-4a29-b6ec-3e6f57bab441","name":"Get Countries (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getcountries/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 04:49:41 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"36995"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a guest MemberToken for a region.
\nReturns an error message/code if the MemberToken is invalid.
\nRequest Elements
\n","urlObject":{"path":["getguestmembertoken","{{HM_ServiceAPI_Token}}","{{Region_ID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"987cae79-ac3e-4f57-8c35-452f70bb69c6","name":"Authenticate Guest Member (XML)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getguestmembertoken/{{HM_ServiceAPI_Token}}/bdctc9d055g5a1b08h"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Tue, 20 Aug 2019 06:52:32 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"319"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis function returns a list of labels/libraries for the account.
\nGetLibraries returns labels/libraries set to “active” in the admin.
\nRequest Elements
\n","urlObject":{"path":["getlibraries","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c598ecf5-1b62-454c-9fa2-60b125c9a258","name":"Get Labels/Libraries (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getlibraries/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 05:26:14 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"127070"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Libraries\": [\n {\n \"Featured\": false,\n \"Detail\": \"\",\n \"Name\": \"Masters Of Score\",\n \"ID\": \"a29195c1c0da826c13\",\n \"Location\": \"\",\n \"Website\": \"\",\n \"LibraryLogoUrl\": \"\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 12:44:29\"\n },\n {\n \"Featured\": false,\n \"Detail\": \"\",\n \"Name\": \"Off To Battle\",\n \"ID\": \"91befc67976784b7az\",\n \"Location\": \"\",\n \"Website\": \"\",\n \"LibraryLogoUrl\": \"\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-05-23 09:22:03\"\n }\n ]\n}"},{"id":"1d323318-f93e-496f-aa7d-3c39123f62a9","name":"Get Labels/Libraries (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getlibraries/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 05:26:59 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"86413"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis function returns a list of labels/libraries for the account, including any inactive labels/libaries.
\nRequest Elements
\n","urlObject":{"path":["getlibraries","{{HM_ServiceAPI_MemberToken}}","includeinactive"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7800e6c9-85ab-479c-ae71-ae1683e27fbe","name":"Get Labels/Libraries (Include Inactive) (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getlibraries/{{HM_ServiceAPI_MemberToken}}/includeinactive"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 05:26:14 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"127070"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Libraries\": [\n {\n \"Featured\": false,\n \"Detail\": \"\",\n \"Name\": \"Masters Of Score\",\n \"ID\": \"a29195c1c0da826c13\",\n \"Location\": \"\",\n \"Website\": \"\",\n \"LibraryLogoUrl\": \"\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 12:44:29\"\n },\n {\n \"Featured\": false,\n \"Detail\": \"\",\n \"Name\": \"Off To Battle\",\n \"ID\": \"91befc67976784b7az\",\n \"Location\": \"\",\n \"Website\": \"\",\n \"LibraryLogoUrl\": \"\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-05-23 09:22:03\"\n }\n ]\n}"},{"id":"977bdc78-c48c-48cc-b875-d8337462240e","name":"Get Labels/Libraries (Include Inactive) (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getlibraries/{{HM_ServiceAPI_MemberToken}}/includeinactive"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"},{"key":"Date","value":"Fri, 16 Aug 2019 05:26:59 GMT","description":"","type":"text"},{"key":"Server","value":"Microsoft-IIS/8.0","description":"","type":"text"},{"key":"X-Powered-By","value":"ASP.NET","description":"","type":"text"},{"key":"Content-Length","value":"86413","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nReturns the details of a specific label/library.
\nRequest Elements
\nRequest Notes: ReturnCodes
\nWhen true, this will return codes that are assigned to the library being returned. By default this property when not set is false and so is required to be opted into.
\nThis will populate the Codes array in the response.
Returns a list of all album style groups available for the account.
\nRequest Elements
\n","urlObject":{"path":["getstylegroups","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4d7d1100-9984-4f6d-84d2-b6b25ccaa2bc","name":"Get Style Groups (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getstylegroups/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 22 Jun 2020 04:59:44 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns a list of all album styles available for the account.
\nRequest Elements
\nRequest Notes: GroupID
\nSpecifying a GroupID will return only those styles which belong to that style group.
\nRequest Notes: AllowEmptyStyle
\nWhen false or not provided, a style will only return if it is assigned to at least one album or playlist.
\nWhen true, a style will return regardless of it's assignments existence or not.
\n","urlObject":{"path":["getstyles","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"groupID","value":"{GroupID}"},{"key":"allowEmptyStyle","value":"false"}],"variable":[]}},"response":[{"id":"3c2c51c0-0089-4fb2-bb70-b150a77ce476","name":"Get Styles (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getstyles/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 06:35:11 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"4097"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Styles\": [\n {\n \"ID\": \"8b73920d2989f83g1e\",\n \"Name\": \"Acoustic / Folk\",\n \"LanguageItems\": [],\n \"HasArtwork\": false\n },\n {\n \"ID\": \"cf0b0a7fed1c37r4e1\",\n \"Name\": \"Ambient & Chill\",\n \"LanguageItems\": [],\n \"HasArtwork\": false\n }\n ]\n}"},{"id":"e7db7f73-5edf-4cdd-9ccb-e68f3ba3c030","name":"Get Styles (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getstyles/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 06:35:48 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"3580"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a list of all album styles available for the account, for the specific language code.
\nRequest Elements
\n","urlObject":{"path":["getstyles","{{HM_ServiceAPI_MemberToken}}","{LanguageCode}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"groupID","value":"{GroupID}"}],"variable":[]}},"response":[{"id":"560dc7c6-3f0e-463b-b739-e2931ebaf1ab","name":"Get Styles By Language Code (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getstyles/{{HM_ServiceAPI_MemberToken}}/en"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"},{"key":"Date","value":"Fri, 16 Aug 2019 06:35:48 GMT","description":"","type":"text"},{"key":"Server","value":"Microsoft-IIS/8.0","description":"","type":"text"},{"key":"X-Powered-By","value":"ASP.NET","description":"","type":"text"},{"key":"Content-Length","value":"3580","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nReturns all albums for a specific Label/ibrary.
\nRequest Elements
\nRequest Notes
\nTo return styles in the response append /returnstyle to your request for example:\n/getalbums/{memberToken}/libraryID/returnstyle
\n","urlObject":{"path":["getalbums","{{HM_ServiceAPI_MemberToken}}","{LibraryID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a871ecbc-c9e4-4ead-ac57-f1f2c34d755e","name":"Get Albums By Label/Library (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getalbums/{{HM_ServiceAPI_MemberToken}}/a29195c1c0da826c13"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 05:42:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"15007"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Albums\": [\r\n {\r\n \"LibraryID\": \"41dd220d57f9cdce7c3\",\r\n \"LibraryName\": \"Chalk Music\",\r\n \"LibraryFeatured\": false,\r\n \"Featured\": false,\r\n \"ReleaseDate\": \"2018-12-21 00:00:00\",\r\n \"Code\": \"CHALK017\",\r\n \"Detail\": \"An assorted collection of light and quirky cues filled with character, charm, mischief and whimsy\",\r\n \"Name\": \"A Little Curious - Imaginative Small Ensemble\",\r\n \"DisplayTitle\": \"A Little Curious - Imaginative Small Ensemble\",\r\n \"Keywords\": \"\",\r\n \"ID\": \"1756d9c8e38s061ec8\",\r\n \"Status\": \"active\",\r\n \"LastUpdated\": \"2019-08-12 21:20:57\"\r\n },\r\n {\r\n \"LibraryID\": \"41dd220d57f9cdce7c3\",\r\n \"LibraryName\": \"Chalk Music\",\r\n \"LibraryFeatured\": false,\r\n \"Featured\": false,\r\n \"ReleaseDate\": \"2018-04-19 00:00:00\",\r\n \"Code\": \"CHALK005\",\r\n \"Detail\": \"Ethereal, dreamy and atmospheric synth-led indie and pop beds with some vocal textures\",\r\n \"Name\": \"Afterlight - Cinematic Dream Pop\",\r\n \"DisplayTitle\": \"Afterlight - Cinematic Dream Pop\",\r\n \"Keywords\": \"Cinematic, Filmic, Synthesiser, Synths, Dream Pop, Dreamwave, Cool, Current, Synthwave,\",\r\n \"ID\": \"8d6b7608d1da93f9ac\",\r\n \"Status\": \"active\",\r\n \"LastUpdated\": \"2018-11-21 03:28:19\"\r\n }\r\n ]\r\n}"},{"id":"68b0aae7-8e51-45cf-9adf-cd86e23b2941","name":"Get Albums By Label/Library (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getalbums/{{HM_ServiceAPI_MemberToken}}/a29195c1c0da826c13"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 05:44:11 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"10006"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns all albums for a specific Label/ibrary, including any inactive albums.
\nRequest Elements
\nRequest Notes
\nTo return styles in the response append /returnstyle to your request for example:\n/getalbums/{memberToken}/libraryID/includeinactive/returnstyle
\n","urlObject":{"path":["getalbums","{{HM_ServiceAPI_MemberToken}}","{LibraryID}","includeinactive"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e0c45c81-029e-4d94-a9a8-ab2511a32034","name":"Get Albums By Label/Library (Include Inactive) (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getalbums/{{HM_ServiceAPI_MemberToken}}/a29195c1c0da826c13/includeinactive"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 05:42:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"15007"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Albums\": [\r\n {\r\n \t\"LibraryID\": \"41dd220d57f9cdce7c3\",\r\n \"LibraryName\": \"Chalk Music\",\r\n \"LibraryFeatured\": false,\r\n \"Featured\": false,\r\n \"ReleaseDate\": \"2018-12-21 00:00:00\",\r\n \"Code\": \"CHALK017\",\r\n \"Detail\": \"An assorted collection of light and quirky cues filled with character, charm, mischief and whimsy\",\r\n \"Name\": \"A Little Curious - Imaginative Small Ensemble\",\r\n \"DisplayTitle\": \"A Little Curious - Imaginative Small Ensemble\",\r\n \"Keywords\": \"\",\r\n \"ID\": \"1756d9c8e38s061ec8\",\r\n \"Status\": \"active\",\r\n \"LastUpdated\": \"2019-08-12 21:20:57\"\r\n },\r\n {\r\n \t\"LibraryID\": \"41dd220d57f9cdce7c3\",\r\n \"LibraryName\": \"Chalk Music\",\r\n \"LibraryFeatured\": false,\r\n \"Featured\": false,\r\n \"ReleaseDate\": \"2018-04-19 00:00:00\",\r\n \"Code\": \"CHALK005\",\r\n \"Detail\": \"Ethereal, dreamy and atmospheric synth-led indie and pop beds with some vocal textures\",\r\n \"Name\": \"Afterlight - Cinematic Dream Pop\",\r\n \"DisplayTitle\": \"Afterlight - Cinematic Dream Pop\",\r\n \"Keywords\": \"Cinematic, Filmic, Synthesiser, Synths, Dream Pop, Dreamwave, Cool, Current, Synthwave,\",\r\n \"ID\": \"8d6b7608d1da93f9ac\",\r\n \"Status\": \"active\",\r\n \"LastUpdated\": \"2018-11-21 03:28:19\"\r\n }\r\n ]\r\n}"},{"id":"6bb35137-06af-4ba1-8095-e398b7d89d78","name":"Get Albums By Label/Library (Include Inactive) (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getalbums/{{HM_ServiceAPI_MemberToken}}/a29195c1c0da826c13/includeinactive"},"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\nReturns a list of albums available for the account based on a style.
\nRequest Elements
\nRequest Notes
\nTo only return track counts for main active Tracks in your response set the \"mainOnly\" property in the request to true.
\n","urlObject":{"path":["getalbumsbystyles","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"827dc0fe-c363-46c5-87f6-18852466e96d","name":"Get Albums By Style (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"style\":[{\r\n\t\t\"id\":\"b41601b244a020a2d2\"\r\n\t}],\r\n \"mainOnly\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getalbumsbystyles/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 05:11:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"300509"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Albums\": [\r\n {\r\n \t\"LibraryID\": \"9edfa2flbbk8020e5a\",\r\n \t\"LibraryName\": \"42 Records\",\r\n \"LibraryFeatured\": false,\r\n \"Featured\": false,\r\n \"ReleaseDate\": \"10/26/2012 12:00:00 AM\",\r\n \"Code\": \"42-002\",\r\n \"Detail\": \"Intoxicating indie rock\",\r\n \"Name\": \"Magic Powers\",\r\n \"DisplayTitle\": \"42-002 Magic Powers\",\r\n \"Keywords\": \"Beads punk, no wave, noisy rock, disco punk, grunge, math rock, 80s to today.\",\r\n \"ID\": \"b8a4b14379boeaea12\",\r\n \"TrackCount\": \"6\",\r\n \"LastUpdated\": \"\"\r\n },\r\n {\r\n \t\"LibraryID\": \"9edfa2flbbk8020e5a\",\r\n \t\"LibraryName\": \"42 Records\",\r\n \"LibraryFeatured\": false,\r\n \"Featured\": false,\r\n \"ReleaseDate\": \"3/27/2013 12:00:00 AM\",\r\n \"Code\": \"42-003\",\r\n \"Detail\": \"Heady, modern and creative pop-rock\",\r\n \"Name\": \"Action, please!\",\r\n \"DisplayTitle\": \"42-003 Action, Please!\",\r\n \"Keywords\": \"modern creative music, pop rock, Scandinavian, Danish, Swedish, Norwegian.\",\r\n \"ID\": \"6e5faf68cab05685a\",\r\n \"TrackCount\": \"16\",\r\n \"LastUpdated\": \"\"\r\n }\r\n ]\r\n}"},{"id":"7355897c-9a15-434f-802a-c1ccada4c3ff","name":"Get Albums By Style (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Returns a list of albums available for the account.
\nRequest Elements
\n","urlObject":{"path":["getalbumsbyids","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"aebdcf8b-e33d-49f4-8387-841200561b60","name":"Get Albums By Album (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"albumid\":[{\r\n\t\t\"id\":\"7fafc73f390144b94b\"\r\n\t}]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getalbumsbyids/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 05:59:52 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"667"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Albums\": [\r\n {\r\n \"LibraryID\": \"be494ef2af6c0d72c3\",\r\n \"LibraryName\": \"Acoustitracks\",\r\n \"LibraryFeatured\": false,\r\n \"Featured\": false,\r\n \"ReleaseDate\": \"5/16/2012 12:00:00 AM\",\r\n \"Code\": \"ATR004\",\r\n \"Detail\": \"Contemporary promos for advertisements television and film.\",\r\n \"Name\": \"Promologic 1\",\r\n \"DisplayTitle\": \"ATR004 Promologic 1\",\r\n \"Keywords\": \"\",\r\n \"ID\": \"7fafc73f390144b94b\",\r\n \"LastUpdated\": \"2019-07-11 09:24:55\",\r\n \"Styles\": [\r\n {\r\n \"ID\": \"af3dd4f729698de8e5\",\r\n \"Name\": \"Indie\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},{"id":"6622ed9d-01a8-4fab-b33f-4a5219576543","name":"Get Albums By Album (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Returns all albums flagged as “featured” for the account.
\nFeatured albums will return in the order set on the account.
\nRequest Elements
\nRequest Notes
\nThe \"Top\" parameter can be used to return a specific number of featured albums
\nRequest Notes: SortOrder
\nSortOrder is optional and defaults to LastFeaturedDateDesc if not provided. Possible values include; DisplayTitle, DisplayTitleDesc, ReleasedDate, ReleasedDateDesc, DateReceived, DateReceivedDesc, Random, LastFeaturedDate, LastFeaturedDateDesc
\n","urlObject":{"path":["getfeaturedalbums","{{HM_ServiceAPI_MemberToken}}","{Top}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returntrackcount","value":"{returnTrackCount}"},{"key":"mainonly","value":"{mainOnly}"},{"key":"sort","value":"{sortorder}"}],"variable":[]}},"response":[{"id":"8e28b2a4-385a-4e86-9be2-2297cd744b8c","name":"Get Featured Albums (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getfeaturedalbums/{{HM_ServiceAPI_MemberToken}}/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 06:28:01 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"1218"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Albums\": [\n {\n \"LibraryID\": \"5cadaea139953e2d9\",\n \"LibraryFeatured\": false,\n \"Featured\": true,\n \"ReleaseDate\": \"2018-05-30 00:00:00\",\n \"Code\": \"PPOP003\",\n \"Detail\": \"A heavy dose of pulsing, pounding, building beats with epic drops and massive hits is about to pump your senses full of energy. They say everything in moderation, but in this case, you'll want to indulge.\",\n \"Name\": \"PPOP003 - Hard Candy\",\n \"DisplayTitle\": \"PPOP003 - Hard Candy\",\n \"Keywords\": \"Pop, Electronic\",\n \"ID\": \"00212cae96d1835fcb\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2018-05-16 12:39:34\",\n \"Tags\": \"\"\n },\n {\n \"LibraryID\": \"5cade2a139953e2dv9\",\n \"LibraryFeatured\": false,\n \"Featured\": true,\n \"ReleaseDate\": \"2018-05-31 00:00:00\",\n \"Code\": \"PPOP004\",\n \"Detail\": \"Male Vocal, Pop, Swagger, R&B, Romanti.\",\n \"Name\": \"PPOP004 - Super Rich\",\n \"DisplayTitle\": \"PPOP004 - Super Rich\",\n \"Keywords\": \"\",\n \"ID\": \"2bc1fe225241c720b9\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2018-05-16 12:35:01\",\n \"Tags\": \"\"\n }\n ]\n}"},{"id":"51983dd7-1cff-4615-82dd-6abf208ef009","name":"Get Featured Albums (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getfeaturedalbums/{{HM_ServiceAPI_MemberToken}}/2"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 06:28:56 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"985"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns the most recently released albums.
\nThe albums will be returned in descending order.
\nRequest Elements
\nRequest Notes
\nThe \"Top\" parameter can be used to return a specific number of latest albums
\n","urlObject":{"path":["getlatestalbums","{{HM_ServiceAPI_MemberToken}}","{Top}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f20d4855-05f0-4970-8c8e-2885b4b4ee77","name":"Get Latest Albums (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getlatestalbums/{{HM_ServiceAPI_MemberToken}}/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 06:28:01 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"1218"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Albums\": [\n {\n \"LibraryID\": \"5cadaea139953e2d9\",\n \"LibraryFeatured\": false,\n \"Featured\": true,\n \"ReleaseDate\": \"2018-05-31 00:00:00\",\n \"Code\": \"PPOP003\",\n \"Detail\": \"A heavy dose of pulsing, pounding, building beats with epic drops and massive hits is about to pump your senses full of energy. They say everything in moderation, but in this case, you'll want to indulge.\",\n \"Name\": \"PPOP003 - Hard Candy\",\n \"DisplayTitle\": \"PPOP003 - Hard Candy\",\n \"Keywords\": \"Pop, Electronic\",\n \"ID\": \"00212cae96d1835fcb\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2018-05-16 12:39:34\",\n \"Tags\": \"\"\n },\n {\n \"LibraryID\": \"5cade2a139953e2dv9\",\n \"LibraryFeatured\": false,\n \"Featured\": true,\n \"ReleaseDate\": \"2018-05-30 00:00:00\",\n \"Code\": \"PPOP004\",\n \"Detail\": \"Male Vocal, Pop, Swagger, R&B, Romanti.\",\n \"Name\": \"PPOP004 - Super Rich\",\n \"DisplayTitle\": \"PPOP004 - Super Rich\",\n \"Keywords\": \"\",\n \"ID\": \"2bc1fe225241c720b9\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2018-05-16 12:35:01\",\n \"Tags\": \"\"\n }\n ]\n}"},{"id":"cb898a3d-2e2b-49e8-bdba-f297277b1e55","name":"Get Latest Albums (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getlatestalbums/{{HM_ServiceAPI_MemberToken}}/2"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 06:28:56 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"985"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns the details of a specific album.
\nRequest Elements
\nRequest Notes: ReturnLibraryCodes
\nWhen true, this will return codes that are assigned to the library that the album being returned belongs to. By default this property when not set is false.
\nThis will populate the LibraryCodes array in the response.
Returns all tracks for a specific album.
\nResults are ordered by tracknumber and then displaytitle.
\nRequest Elements
\n","urlObject":{"path":["getalbumtracks","{{HM_ServiceAPI_MemberToken}}","{AlbumID}","mainonly"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"skip","value":"{skip}"},{"key":"limit","value":"{limit}"}],"variable":[]}},"response":[{"id":"dfca172c-63b1-4626-bf46-e1ceb89ee3ba","name":"Get Album Tracks (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getalbumtracks/{{HM_ServiceAPI_MemberToken}}/7faf73ff39044b941b/mainonly"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 06:14:59 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"109398"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"TrackNumber\": \"1\",\n \"Time\": \"01:17\",\n \"LengthSeconds\": \"77\",\n \"Comment\": \"Promo - Contemporary. Chug some of this retro, indie-rock jungle juice featuring killer distorted guitars, slammin' drums and a gritty bass that lay down the attitude while retro transistor/computer efx and groovy tambourine show The Man who's boss... POI :41 hang ten with a sweet guitar solo as the party rages on with a kitshcy 60's organ and screaming guitar licks! Retro-Kremlin-Beach-Party-Blowout! Full Mix\",\n \"Composer\": \"Jamen Brooks (ASCAP) 100%\",\n \"Publisher\": \"Acoustitracks Obsessive Music (ASCAP) 100%\",\n \"Name\": \"Cosmonaut Hula Hooch\",\n \"AlbumID\": \"7faf73ff39044b941b\",\n \"ID\": \"08f6537012bc7ffc86\",\n \"Keywords\": \"Commercial, TV, Promo, Rock, Retro, Fun, Party, 60's, Indie, Punk, Alternative, Sports, Beach, Kitschy, Nostalgia, Happy, Classic Rock.\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Cosmonaut Hula Hooch\",\n \"Genre\": \"Promo\",\n \"Tempo\": \"\",\n \"Instrumentation\": \"\",\n \"Bpm\": \"152\",\n \"Mixout\": \"\",\n \"Frequency\": \"48000\",\n \"DateIngested\": \"2013-09-07 02:26:03\",\n \"Version\": \"Full Mix\",\n \"CdCode\": \"ATR004\",\n \"AlbumName\": \"ATR004 Promologic 1\",\n \"LibraryName\": \"Acoustitracks\",\n \"LibraryFeatured\": false,\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 09:24:55\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n },\n {\n \"TrackNumber\": \"2\",\n \"Time\": \"01:20\",\n \"LengthSeconds\": \"80\",\n \"Comment\": \"Promo - Contemporary. Tension slowly builds with hammered dulcimer, eerie backwards piano and stomped kick drum leading into POI :14 brutal, pounding toms, thick bass, heavy piano and ethereal vocals that light the track on fire with driving, aggressive power both mysterious and uplifting. POI :32 arpeggiated piano plays under majestic, chiming electric guitars and solid drums that lead this rocker into its exalted, emotional conclusion. Full Mix\",\n \"Composer\": \"Jamen Brooks (ASCAP) 100%\",\n \"Publisher\": \"Acoustitracks Obsessive Music (ASCAP) 100%\",\n \"Name\": \"Dulcimated\",\n \"AlbumID\": \"7faf73f39044zb94b9\",\n \"ID\": \"9ef5988bd84c807ac5\",\n \"Keywords\": \"Commercial, TV, Promo, Rock, Inspiring, Alternative, Driving, Indie, Sophisticated, Emotional, Positive Male Vocal.\",\n \"DisplayTitle\": \"Dulcimated\",\n \"Genre\": \"Promo\",\n \"Instrumentation\": \"\",\n \"Bpm\": \"132\",\n \"Frequency\": \"48000\",\n \"DateIngested\": \"2013-09-07 02:26:42\",\n \"Version\": \"Full Mix\",\n \"CdCode\": \"ATR004\",\n \"AlbumName\": \"ATR004 Promologic 1\",\n \"LibraryName\": \"Acoustitracks\",\n \"LibraryFeatured\": false,\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 09:24:55\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ]\n}"},{"id":"1b5b5531-995b-45d0-9752-e032628e4c84","name":"Get Album Tracks (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getalbumtracks/{{HM_ServiceAPI_MemberToken}}/7faf73ff39044b941b/mainonly"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 06:16:53 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"56012"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns all tracks for a specific album.
\nResults are ordered by tracknumber and then displaytitle.
\nRequest Elements
\n","urlObject":{"path":["getalbumtracks","{{HM_ServiceAPI_MemberToken}}","{AlbumID}","includeinactive"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"skip","value":"{skip}"},{"key":"limit","value":"{limit}"}],"variable":[]}},"response":[{"id":"3b3b6d5e-3e74-4501-af14-1b76ef483e32","name":"Get Album Tracks (Include Inactive) (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getalbumtracks/{{HM_ServiceAPI_MemberToken}}/7faf73ff39044b941b/includeinactive"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 06:14:59 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"109398"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"TrackNumber\": \"1\",\n \"Time\": \"01:17\",\n \"LengthSeconds\": \"77\",\n \"Comment\": \"Promo - Contemporary. Chug some of this retro, indie-rock jungle juice featuring killer distorted guitars, slammin' drums and a gritty bass that lay down the attitude while retro transistor/computer efx and groovy tambourine show The Man who's boss... POI :41 hang ten with a sweet guitar solo as the party rages on with a kitshcy 60's organ and screaming guitar licks! Retro-Kremlin-Beach-Party-Blowout! Full Mix\",\n \"Composer\": \"Jamen Brooks (ASCAP) 100%\",\n \"Publisher\": \"Acoustitracks Obsessive Music (ASCAP) 100%\",\n \"Name\": \"Cosmonaut Hula Hooch\",\n \"AlbumID\": \"7faf73ff39044b941b\",\n \"ID\": \"08f6537012bc7ffc86\",\n \"Keywords\": \"Commercial, TV, Promo, Rock, Retro, Fun, Party, 60's, Indie, Punk, Alternative, Sports, Beach, Kitschy, Nostalgia, Happy, Classic Rock.\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Cosmonaut Hula Hooch\",\n \"Genre\": \"Promo\",\n \"Tempo\": \"\",\n \"Instrumentation\": \"\",\n \"Bpm\": \"152\",\n \"Mixout\": \"\",\n \"Frequency\": \"48000\",\n \"DateIngested\": \"2013-09-07 02:26:03\",\n \"Version\": \"Full Mix\",\n \"CdCode\": \"ATR004\",\n \"AlbumName\": \"ATR004 Promologic 1\",\n \"LibraryName\": \"Acoustitracks\",\n \"LibraryFeatured\": false,\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 09:24:55\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n },\n {\n \"TrackNumber\": \"2\",\n \"Time\": \"01:20\",\n \"LengthSeconds\": \"80\",\n \"Comment\": \"Promo - Contemporary. Tension slowly builds with hammered dulcimer, eerie backwards piano and stomped kick drum leading into POI :14 brutal, pounding toms, thick bass, heavy piano and ethereal vocals that light the track on fire with driving, aggressive power both mysterious and uplifting. POI :32 arpeggiated piano plays under majestic, chiming electric guitars and solid drums that lead this rocker into its exalted, emotional conclusion. Full Mix\",\n \"Composer\": \"Jamen Brooks (ASCAP) 100%\",\n \"Publisher\": \"Acoustitracks Obsessive Music (ASCAP) 100%\",\n \"Name\": \"Dulcimated\",\n \"AlbumID\": \"7faf73f39044zb94b9\",\n \"ID\": \"9ef5988bd84c807ac5\",\n \"Keywords\": \"Commercial, TV, Promo, Rock, Inspiring, Alternative, Driving, Indie, Sophisticated, Emotional, Positive Male Vocal.\",\n \"DisplayTitle\": \"Dulcimated\",\n \"Genre\": \"Promo\",\n \"Instrumentation\": \"\",\n \"Bpm\": \"132\",\n \"Frequency\": \"48000\",\n \"DateIngested\": \"2013-09-07 02:26:42\",\n \"Version\": \"Full Mix\",\n \"CdCode\": \"ATR004\",\n \"AlbumName\": \"ATR004 Promologic 1\",\n \"LibraryName\": \"Acoustitracks\",\n \"LibraryFeatured\": false,\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 09:24:55\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ]\n}"},{"id":"040f2324-e06f-4971-aa50-e97a2904b0e2","name":"Get Album Tracks (Include Inactive) (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getalbumtracks/{{HM_ServiceAPI_MemberToken}}/7faf73ff39044b941b/includeinactive"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 06:21:23 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"58214"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns all tracks specified in the request body.
\nThe response will include one or more track elements.
\nRequest Elements
\nNotes regarding Request Elements
\nRequest Notes: ReturnRegionOnlyTracks
\nUnder most scenarios this should be set to false or not provided at all. This is because all other API endpoints that return tracks in their responses will provide regionalized tracks. This follow up call to get the additional facets for a track therefor does not need to re-do the same regional checking.
\nA scenario in which this could be true, is a single track share - where there is no previous call before it that does the regional check.
\n","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"aea9a4c2-7059-4092-8edd-ebf312a234f2","name":"Get Tracks (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"true\",\r\n\t\"ReturnCategories\":\"true\",\r\n\t\"ReturnCategoryFacet\":\"true\",\r\n\t\"ReturnCodes\":\"true\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"Offset\":\"0\",\r\n\t\"Limit\":\"10\",\r\n\t\"track\":[\"a9566457021b715g6f\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 01:43:49 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"20476"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"Time\": \"02:01\",\n \"LengthSeconds\": \"121\",\n \"Comment\": \"Haunting vocal and synth led intro, driving into a modern choppy future bass anthem at 0:25\",\n \"Composer\": \"Eamonn Patrick Downes\",\n \"Publisher\": \"Twisted Jukebox (PRS)\",\n \"Name\": \"Element\",\n \"AlbumID\": \"474ema59t8a83br018\",\n \"LibraryID\": \"1dbb8lc46d26ct5d77\",\n \"ID\": \"a9566457021b715g6f\",\n \"Keywords\": \"Trap, 808, bass, booming, hip hop, urban, energetic, driving, synths, pumping, club, festival, modern, future bass, trapstep, leading edge, motivation, action / drive, bold, dynamic, endurance, lively, positive, upbeat, cool, creative, exciting, dancing, late night, youthful, sunny, beach\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Element\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Dance, Electronica, Trap, hip hop\",\n \"Tempo\": \"Medium Slow\",\n \"Instrumentation\": \"Synth Bass, Drum Machine / Electronic Drums, Piano, Synths, DJ Effects and Samples, Female Vocals\",\n \"Bpm\": \"150\",\n \"Mixout\": \"Full\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"DateIngested\": \"2019-08-01 20:18:15\",\n \"Version\": \"MAIN\",\n \"AlternateTracks\": [\n {\n \"TrackNumber\": \"012\",\n \"Time\": \"01:59\",\n \"LengthSeconds\": \"119\",\n \"Comment\": \"Haunting vocal and synth led intro, driving into a modern, choppy future bass anthem at 0:25\",\n \"Composer\": \"Eamonn Patrick Downes\",\n \"Publisher\": \"Twisted Jukebox (PRS)\",\n \"Name\": \"Element (INSTRUMENTAL)\",\n \"AlbumID\": \"474ema59t8a83br018\",\n \"ID\": \"71cb15b915dfb12422\",\n \"Keywords\": \"Trap, 808, bass, booming, hip hop, urban, energetic, driving, synths, pumping, club, festival, modern, future bass, trapstep, leading edge, motivation, action / drive, bold, determined, dynamic, endurance, energetic, lively, positive, punchy, stirring, upbeat, cool, creative, exciting, rousing, driving, dancing, late night, strong, youthful\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Element (INSTRUMENTAL)\",\n \"Genre\": \"Dance, Electronica, Trap\",\n \"Tempo\": \"Medium Slow\",\n \"Instrumentation\": \"Synth Bass, Drum Machine / Electronic Drums, Piano, Synths, DJ Effects and Samples, Female Vocals\",\n \"Bpm\": \"150\",\n \"Mixout\": \"Full\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"Version\": \"Instrumental\",\n \"Status\": \"active\",\n \"CDCode\": \"TJ0126\",\n \"IsAlternate\": \"true\",\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"a9566457021b715g6f\"\n }\n ],\n \"Status\": \"active\",\n \"CDCode\": \"TJ0126\",\n \"AlbumReleaseDate\": \"2019-08-01 20:18:15\",\n \"AlbumName\": \"TJ0126 Boom\",\n \"LibraryName\": \"Twisted Jukebox\",\n \"LibraryFeatured\": false,\n \"FileName\": \"TJ0126_trk1_ELEMENT_Eamonn_Patrick_Downes.wav\",\n \"IsAlternate\": \"false\",\n \"TrackAttribute\": [\n {\n \"AttributeTypeName\": \"SM Category\",\n \"Value\": \"\"\n },\n {\n \"AttributeTypeName\": \"SM Subcategory\",\n \"Value\": \"\"\n }\n ],\n \"Codes\": [\n {\n \"AttributeTypeName\": \"ISRC\",\n \"Value\": \"\"\n },\n {\n \"AttributeTypeName\": \"ISWC\",\n \"Value\": \"\"\n },\n {\n \"AttributeTypeName\": \"LC Code\",\n \"Value\": \"\"\n }\n ],\n \"AlternateCount\": \"7\",\n \"RightHolders\": [\n {\n \"OriginalPublisher\": \"Twisted Jukebox\",\n \"ID\": \"3dpadbc536ad15ccce\",\n \"FirstName\": \"Eamonn\",\n \"MiddleName\": \"Patrick\",\n \"LastName\": \"Downes\",\n \"CollectingSociety\": \"PRS\",\n \"IPI\": \"178307061\",\n \"Capacity\": \"Composer\",\n \"OwnerPerformanceShare\": \"100.00\",\n \"OwnerMechanicalShare\": \"0.00\",\n \"Territory\": \"2WL\"\n }\n ],\n \"Mood\": \"\",\n \"MusicFor\": \"\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ]\n}"},{"id":"d1130c9f-ae33-45b5-8f4c-85d5a0d7ce51","name":"Get Tracks (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns top tracks based on varied criteria.
\nRequest Elements
\nNotes regarding Request Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\n","urlObject":{"path":["gettoptracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"60f15a63-9064-4770-b405-0e58ffc05fda","name":"Get Top Tracks (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"RelationType\": \"RightHolder\",\r\n \"RelationTypeID\": \"91981eb698620262\",\r\n \"Metric\": \"Download\",\r\n \"MetricDetermination\": \"TotalCount\",\r\n \"MetricRange\": null,\r\n \"PopularityDecay\": 0.95,\r\n \"TrackType\": \"MainOnly\", // MainOnly, AlternateOnly, MainAndAlternate\r\n \"Skip\": 0,\r\n \"Limit\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/gettoptracks/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Jan 2026 06:55:50 GMT"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"Time\": \"02:01\",\n \"LengthSeconds\": \"121\",\n \"Comment\": \"Haunting vocal and synth led intro, driving into a modern choppy future bass anthem at 0:25\",\n \"Composer\": \"Eamonn Patrick Downes\",\n \"Publisher\": \"Twisted Jukebox (PRS)\",\n \"Artist\": \"\",\n \"Name\": \"Element\",\n \"AlbumID\": \"474ema59t8a83br018\",\n \"LibraryID\": \"1dbb8lc46d26ct5d77\",\n \"ID\": \"a9566457021b715g6f\",\n \"Keywords\": \"Trap, 808, bass, booming, hip hop, urban, energetic, driving, synths, pumping, club, festival, modern, future bass, trapstep, leading edge, motivation, action / drive, bold, dynamic, endurance, lively, positive, upbeat, cool, creative, exciting, dancing, late night, youthful, sunny, beach\",\n \"DisplayTitle\": \"Element\",\n \"AlternateTitle\": \"\",\n \"Genre\": \"Dance, Electronica, Trap, hip hop\",\n \"Tempo\": \"Medium Slow\",\n \"Instrumentation\": \"Synth Bass, Drum Machine / Electronic Drums, Piano, Synths, DJ Effects and Samples, Female Vocals\",\n \"Bpm\": \"150\",\n \"Mixout\": \"Full\",\n \"Filesize\": \"\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"DateIngested\": \"2019-08-01 20:18:15\",\n \"Version\": \"MAIN\",\n \"Alternates\": [],\n \"AlternateTracks\": [],\n \"RelatedTracks\": [],\n \"Categories\": [],\n \"Status\": \"active\",\n \"Relations\": [],\n \"CDCode\": \"TJ0126\",\n \"Composers\": [],\n \"AlbumName\": \"TJ0126 Boom\",\n \"LibraryName\": \"Twisted Jukebox\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"7\",\n \"RightHolderIDs\": [],\n \"RightHolders\": [],\n \"Mood\": \"\",\n \"MusicFor\": \"\",\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"IsCached\": false,\n \"Title\": \"Element\",\n \"StemCount\": \"0\",\n \"Stems\": [],\n \"LanguageItems\": [],\n \"LibraryFeatured\": false,\n \"Highlighted\": false,\n \"EvokeSegments\": [],\n \"HighlightedInPlaylists\": [],\n \"IsOriginator\": false,\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"LibraryType\": \"\"\n }\n ],\n \"Album\": {\n \"LibraryFeatured\": false\n },\n \"Library\": {\n \"Featured\": false\n }\n}"},{"id":"1082de5d-9afe-4fa7-903e-45d852dfbfe3","name":"Get Top Tracks (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns a list of categories for the account.
\nRequest Elements
\nRequest Notes
\nSpecifying a LanguageCode (EN, FR, etc.) will provide the styles back in English, with a child languageitem element that contains the name in that language. Note that this will only work if;
\nThat relevant language is assigned to your account as seen in the HM Admin
\nThe relevant category has a name in that language specified
\nReturns a list of Rightholders for a specific track.
\nRequest Elements
\n","urlObject":{"path":["getrightholders","{{HM_ServiceAPI_MemberToken}}","{TrackID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"04dea3e8-6e71-4e65-99fa-4da97e15361e","name":"Get Rightholders By Track (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getrightholders/{{HM_ServiceAPI_MemberToken}}/925d05536e0e4f421a"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 12:43:59 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"1101"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns playlist categories associated with the account.
\nRequest Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Name_ASC if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc, Custom_Asc, Custom_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending account defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\n","urlObject":{"path":["getfeaturedplaylistcategories","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"skip","value":"{{HM_ServiceAPI_Skip}}"},{"key":"limit","value":"{{HM_ServiceAPI_Limit}}"},{"key":"sort","value":"{{HM_ServiceAPI_PlaylistSortOrder}}"}],"variable":[]}},"response":[{"id":"9e789a94-fc81-4cde-9dd0-5b61b06b2ca9","name":"Get Featured Playlist Categories (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getfeaturedplaylistcategories/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&skip=0&limit=10&sort=Custom_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getfeaturedplaylistcategories","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Custom_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 20 Oct 2021 00:05:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistCategories\": [\n {\n \"ID\": \"0bu32c9a35e534283e\",\n \"Name\": \"Category Name\",\n \"Description\": \"Category Description\",\n \"CreatedDate\": \"2021-10-20 11:04:14\",\n \"PlaylistCount\": \"2\"\n }\n ]\n}"},{"id":"466d1eee-6c4d-4187-9e5b-41fbe71368df","name":"Get Featured Playlist Categories (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getfeaturedplaylistcategories/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&skip=0&limit=10&sort=Custom_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getfeaturedplaylistcategories","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Custom_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 20 Oct 2021 00:07:24 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns root level playlist categories & playlists along with all associated playlists per playlist category associated with the account.
\nRequest Elements
\nRequest Notes: PlaylistCategoryID
\nWhen set to a value this will return those playlists that are within that folder. This is to be used when retrieving content for a folder. It's important to note that when this attribute has a value, Skip and Limit will work to page the contents of the folder as opposed to the contents on the root level.
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Name_ASC if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc, Custom_Asc, Custom_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending account defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\n","urlObject":{"path":["getfeaturedplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"returntrackcount","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"returnrootobjectsonly","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"playlistcategoryid","value":"{{HM_ServiceAPI_NewMemberPlaylistCategoryID}}"},{"key":"skip","value":"{{HM_ServiceAPI_Skip}}"},{"key":"limit","value":"{{HM_ServiceAPI_Limit}}"},{"key":"sort","value":"{{HM_ServiceAPI_PlaylistSortOrder}}"}],"variable":[]}},"response":[{"id":"fe34d345-2edd-4b98-b126-0f02dcf365fb","name":"Get Featured Playlist Categories & Playlists (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getfeaturedplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&returntrackcount=true&returnrootobjectsonly=false&playlistcategoryid=&skip=0&limit=10&sort=Custom_DESC","host":["{{HM_ServiceAPI_URL}}"],"path":["getfeaturedplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"returntrackcount","value":"true"},{"key":"returnrootobjectsonly","value":"false"},{"key":"playlistcategoryid","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Custom_DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 20 Oct 2021 00:13:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistObjects\": [\n {\n \"ID\": \"0bu32c9a35e534283e\",\n \"Name\": \"Category Name\",\n \"Description\": \"Category Description\",\n \"ObjectType\": \"PlaylistCategory\",\n \"HasImage\": false,\n \"AutoSave\": false,\n \"CreatedDate\": \"10/20/2021 11:04:14 AM\",\n \"PlaylistsCount\": \"2\",\n \"Playlists\": [\n {\n \"Name\": \"Playlist Name 1\",\n \"ID\": \"0af91945912df335cz\",\n \"Description\": \"Playlist Description 1\",\n \"CreatedDate\": \"7/8/2021 3:44:15 PM\",\n \"TrackCount\": \"1\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ObjectType\": \"Playlist\",\n \"OrderBy\": \"\"\n },\n {\n \"Name\": \"Playlist Name 2\",\n \"ID\": \"ddcfc292a72i34a99c\",\n \"Description\": \"Playlist Description 2\",\n \"CreatedDate\": \"3/18/2019 3:04:18 PM\",\n \"TrackCount\": \"11\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": true,\n \"Tags\": \"k_acoustic folk\",\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ObjectType\": \"Playlist\",\n \"OrderBy\": \"\"\n }\n ]\n }\n ],\n \"TotalPlaylistsCount\": \"2\",\n \"TotalPlaylistCategoriesCount\": \"1\",\n \"TotalCount\": \"1\"\n}"},{"id":"d0adc59a-4e61-4ed0-84b9-50679e7458aa","name":"Get Featured Playlist Categories & Playlists (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getfeaturedplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&returntrackcount=true&returnrootobjectsonly=false&playlistcategoryid=&skip=0&limit=100&sort=Custom_DESC","host":["{{HM_ServiceAPI_URL}}"],"path":["getfeaturedplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"returntrackcount","value":"true"},{"key":"returnrootobjectsonly","value":"false"},{"key":"playlistcategoryid","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"100"},{"key":"sort","value":"Custom_DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 20 Oct 2021 00:16:44 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns all playlists flagged as “featured” on the account including:
\nThis method will not return the tracks within a playlist.
\nRequest Notes
\nSpecifying a LanguageCode (EN, FR, etc.) will provide the styles back in English, with a child languageitem element that contains the name in that language. Note that this will only work if;
\nThat relevant language is assigned to your account as seen in the HM Admin
\nThe relevant featured playlist has a name in that language specified
\nThis method returns returns the requested playlist, and has options for including:
\nTracks will be ordered matching the track list set on the account for the playlist.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Sort
\nSort is optional and defaults to Created_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Title_Asc, Title_Desc, ReleaseDate_Asc, ReleaseDate_Desc
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track display title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["getfeaturedplaylistandtracks","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"9257107a-0392-41b1-bfc7-fbf92cba0fac","name":"Get Featured Playlist (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"ReturnTracks\": true,\r\n \"ReturnAlbums\": true,\r\n \"ReturnLibraries\": true,\r\n \"AllowInactive\": false,\r\n \"LanguageCode\": \"EN\",\r\n \"OrderBy\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getfeaturedplaylistandtracks/{{HM_ServiceAPI_Token}}/djy1fc9da7f2234a9c"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 04:16:12 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"14011"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"ACOUSTIC FOLK\",\n \"ID\": \"djy1fc9da7f2234a9c\",\n \"Description\": \"\",\n \"Tags\": \"\",\n \"CreatedDate\": \"2019-03-18 15:04:18\",\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"Time\": \"02:51\",\n \"LengthSeconds\": \"171\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"Comment\": \"A chilled, future-bass track with swelling synths, enchanted chimes and lovely textures.\",\n \"Composer\": \"Saccardo, Andrea (PRS)\",\n \"Publisher\": \"Felt Licensing Ltd (PRS)\",\n \"Name\": \"Luxury\",\n \"AlbumID\": \"613ff4b1cdab68ebv1\",\n \"LibraryID\": \"a002a2fv42c090gd98\",\n \"ID\": \"e01eaccccdd972168c\",\n \"Keywords\": \"Commercials, Electronic, Electro, Electronica, Chill, Calm, Carefree, Cool, Dreamy, Emotive, Inspirational, Peaceful / Tranquil, Whistful, Surreal, Pensive / Thoughtful, Breakbeat, Easy listening, Corporate, Dance, Downtempo, Pop, Trailer, Vocal, Atmospheric, Ethereal, Drums - Electronic, Synth - bass, Synth - Pad, SFX, Synth - noises, Synth - Keyboards, Vocal - processed\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Luxury\",\n \"Genre\": \"Electronic 005\",\n \"Tempo\": \"Downtempo\",\n \"Instrumentation\": \"Drums - Electronic, Synth - bass, Synth - Pad, SFX, Synth - noises, Synth - Keyboards, Vocal - processed\",\n \"Bpm\": \"80\",\n \"Mixout\": \"\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"Version\": \"Full length\",\n \"CdCode\": \"FMLFC103\",\n \"AlbumName\": \"FMLFC103 Soho Sessions Vol. 2: Geograph\",\n \"LibraryName\": \"Felt Music Library\",\n \"LibraryFeatured\": false,\n \"Album\": {\n \"LibraryFeatured\": false,\n \"Code\": \"FMLFC103\",\n \"Detail\": \"A collection of polished sounds, processed vocals and wavy synths layered over chilled rhythms and electronic beats.\",\n \"Name\": \"Soho Sessions Vol. 2: Geograph\",\n \"ID\": \"613ff4b1cdab68ebv1\"\n },\n \"Library\": {\n \"Featured\": false,\n \"Detail\": \"After many years serving the creative hub of UK advertising with original & characterful music, the team at Felt has developed a reputation for being unique in their approach. This varied and extensive custom experience combined with ongoing collaborations with cutting edge artists and talented composer teams now delivers the bespoke-quality Felt Music Library.\",\n \"Name\": \"Felt Music Library\",\n \"ID\": \"a002a2fv42c090gd98\",\n \"Location\": \"London\",\n \"Website\": \"www.feltmusiclibrary.com\"\n },\n \"AlternateTracks\": [],\n \"LastUpdated\": \"2018-09-27 19:54:36\",\n \"Composers\": [],\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"4\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ],\n \"RelatedPlaylists\": [],\n \"HasImage\": true,\n \"Type\": \"Curated\"\n }\n ]\n}"},{"id":"1892079a-b995-4794-b5bd-1ec190cda05f","name":"Get Featured Playlist (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searches tracks on a specific featured playlist.
\nIt is possible to define which field(s) are searched on.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Title_Asc, Title_Desc, ReleaseDate_Asc, ReleaseDate_Desc, DateAdded_Asc, DateAdded_Desc, Duration_Asc, Duration_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track dispaly title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["searchfeaturedplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_FeaturedPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"774e0eca-1456-41a5-827a-7c99120849dd","name":"Search Featured Playlist Tracks (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Keyword\": \"Rock\",\r\n \"Fields\": \"TrackDisplayTitle,TrackDescription\",\r\n \"ReturnTrackCount\": true,\r\n \"Skip\": 0,\r\n \"Limit\": 10,\r\n \"OrderBy\": \"Custom_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchfeaturedplaylisttracks/{{HM_ServiceAPI_MemberToken}}/vfbf8fc96f7l4f38e5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2024 01:52:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"TrackNumber\": \"005\",\n \"Time\": \"03:09\",\n \"LengthSeconds\": \"189\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"Comment\": \"Medium. Driving Rock tune with distorted guitars.\",\n \"Composer\": \"Claude Engel\",\n \"Publisher\": \"BMG Production Works (France) (SACEM) 100%\",\n \"Name\": \"French Rock\",\n \"AlbumID\": \"bfb2bc47h7u73359ec\",\n \"LibraryID\": \"mgaa2444n1da891521\",\n \"ID\": \"as2634a2e843346jp7\",\n \"Keywords\": \"Heavy, Retro, Vintage, Instrumental, Driving, Drive, Determined, Pushing, Urging, Thrusting, Cool, Chic, Attitude, Hip, Slick, Smooth, Suave, Stylish, Swagger, Confident, Positive, Upbeat, Cheerful, Joyful, Joyous, Feel Good, Friendly, Happiness, Optimistic, Happy, Exciting, Action, Activity, Adrenaline, Excitement, Bustling, Busy, Energy, Lively, Thrilling, Energetic, Adventurous, Adventure, Discovery, Open Road, Road Trip, Travel, Wilderness, Wild, Brave, Courageous, Free,\",\n \"Lyrics\": \"N\",\n \"DisplayTitle\": \"French Rock\",\n \"Genre\": \"Rock\",\n \"Tempo\": \"Medium\",\n \"Instrumentation\": \"Drum Kit, Bass Guitar, Electric Guitar\",\n \"Bpm\": \"108\",\n \"Mixout\": \"Main\",\n \"Filesize\": \"\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"DateIngested\": \"2016-10-13 00:08:16\",\n \"Version\": \"main\",\n \"AlternateTracks\": [],\n \"RelatedTracks\": [],\n \"Categories\": [],\n \"ISRC\": \"\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2020-05-27 03:07:44\",\n \"CDCode\": \"TM3026\",\n \"Composers\": [],\n \"AlbumName\": \"TM3026 99% Pop\",\n \"LibraryName\": \"Tele Music Classic Vaults\",\n \"LibraryFeatured\": false,\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"IsCached\": false\n }\n ],\n \"TotalTracks\": \"1\"\n}"},{"id":"cab6b907-bd83-4dec-bb82-f26113404d1f","name":"Search Featured Playlist Tracks (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns a playlist shared from another member or from the account.
\nRequest Elements
\nRequest Notes
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\n","urlObject":{"path":["getsharedplaylistwithmembertoken","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"{Skip}"},{"key":"Limit","value":"{Limit}"}],"variable":[]}},"response":[{"id":"48d559ee-1ce6-434c-9b4b-7d5080c52ba5","name":"Get Shared Playlist (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getsharedplaylistwithmembertoken/{{HM_ServiceAPI_MemberToken}}/l0r8dfb9a476ed71a5"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 04:36:22 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"69186"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"Weekend Bliss\",\n \"ID\": \"7158db9a4176edf7a5\",\n \"Description\": \"\",\n \"CreatedDate\": \"2016-01-19 11:49:03\",\n \"TrackCount\": \"20\",\n \"Tracks\": [\n {\n \"TrackNumber\": \"008\",\n \"Time\": \"02:25\",\n \"LengthSeconds\": \"145\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"Comment\": \"Laidback downtempo perfect for the sun. Shimmering electric piano and guitar with sparkling female vocal samples, rolling synth bass and dusty beats.\",\n \"Composer\": \"Gareth Salmon (PRS)\",\n \"Publisher\": \"Twisted Jukebox (PRS)\",\n \"Name\": \"Sunshaker\",\n \"AlbumID\": \"bva2803f2fj6f65381\",\n \"ID\": \"12s4a2a3d92b133o5b\",\n \"Keywords\": \"chilled, beats, laidback, downtempo, lounge, electronica, beach, fresh, relax, relaxation, classy, happy, fashion, corporate, travel, holiday, technology, positive, vibes, organic, warm, easy, flight, soulful, soul, deep, sun, car, perfume, slow\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Sunshaker\",\n \"Genre\": \"Warm Chilled Beats\",\n \"Tempo\": \"Slow\",\n \"Instrumentation\": \"Electric Piano, beats, guitar, female vocal sample, synths\",\n \"Bpm\": \"75 BPM\",\n \"Mixout\": \"Full\",\n \"Frequency\": \"44100\",\n \"Bitrate\": \"1411\",\n \"Version\": \"MAIN\",\n \"CdCode\": \"FMLFC103\",\n \"AlbumName\": \"FMLFC103 Soho Sessions Vol. 2: Geograph\",\n \"LibraryName\": \"Felt Music Library\",\n \"LibraryFeatured\": false,\n \"Album\": {\n \"LibraryFeatured\": false,\n \"Code\": \"TJ0058\",\n \"Detail\": \"Warm Laid Back Chilled Downtempo Beats & Vibes\",\n \"Name\": \"TJ0058 Lazy Days\",\n \"ID\": \"bva2803f2fj6f65381\"\n },\n \"Library\": {\n \"Featured\": false,\n \"Detail\": \"The Twisted Jukebox label is written and produced by a team of internationally successful musicians and composers. Among them are award winning musicians who have performed & worked with prestigious artists such as The Prodigy, Paul van Dyk, Groove Armada, Underworld, Pitchshifter and the Royal Philharmonic Orchestra. These same composers have also written for big budget film & game trailers, feature films, advertising campaigns and television productions, with credits including Rise of the Planet of the Apes (trailer), Transformers (gaming) and TV shows including Pimp My Ride and Melrose Place.\",\n \"Name\": \"Twisted Jukebox\",\n \"ID\": \"dxb81fc46d2zc9gd77\"\n },\n \"AlternateTracks\": [],\n \"CDCode\": \"TJ0058\",\n \"Composers\": [],\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\"\n }\n ]\n}"},{"id":"359c7fb7-ae3b-433b-8f45-0dd1eff58991","name":"Get Shared Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getsharedplaylistwithmembertoken/{{HM_ServiceAPI_MemberToken}}/70f8db9a476ed7a5"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Tue, 20 Aug 2019 04:39:28 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"33106"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a cuesheet file for requested track(s), album or playlist.
\nRequest Elements
\nRequest Notes
\nWhen requesting tracks, at least one track is required.
\nWhen requesting an album or playlist only one can be requested at a time.
\nOnly active tracks will be returned in the response.
\n","urlObject":{"path":["getcuesheet","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"filename","value":"{Filename}"}],"variable":[]}},"response":[{"id":"1f1d89fc-5fa9-4d93-be7f-29d0384db1a1","name":"Get Generated Cuesheet (Tracks) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"track\":[\r\n \"d5db153b69cha0v35q\", \r\n \"4f42ta8o90e427dqcf\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HM_ServiceAPI_URL}}/getcuesheet/{{HM_ServiceAPI_MemberToken}}?filename=afile","host":["{{HM_ServiceAPI_URL}}"],"path":["getcuesheet","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"filename","value":"afile"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 05:15:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"167"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"FullUrl\": \"https://{cuesheetdomainpath}}/afile.csv\"\n}"},{"id":"1fede8e5-be7d-4b8b-a01d-88f7debea0e2","name":"Get Generated Cuesheet (Tracks) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"This section provides information on how to access library, albums, categories, styles and tracks stored within a Harvest Media account
\n","event":[{"listen":"prerequest","script":{"id":"03feb865-2203-4991-93d8-f6df49b39eb2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ad5a36a-c412-4055-91f5-82026d9ae97e","type":"text/javascript","exec":[""]}}],"_postman_id":"9263b8b1-a2e5-4e4d-a2bb-7f342efbd18a"},{"name":"Searching Metadata","item":[{"name":"Search","item":[{"name":"Implementation Guide Search","id":"4cbdd738-1533-4130-a74e-f795e39069a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"HM API Cloud Search aims to provide fast and efficient searching of a number of entities within the Harvest Media platform.
\nCurrently we support searching on:
\nTracks
\nAlbums
\nLibraries
\nStyles
\nCategories
\nRightholders
\nDuration
\nBPM
\nWithin results
\nThe way in which you configure to search for each of these entities varies, however the core framework remains the same. At the core of each requestcloudsearch and responsecloudsearch object we have the following sections;
\nOptions these are used to set up the search environment. For example, in this section you would identify whether you are searching on tracks account-wide, or just within tracks for a member. You can look at these as your top-level configuration options.
\nSearchTermBundle this is your current search terms for the search being performed
\nSearchTermBundleHistory these are you previous search terms for the search being performed. This should only exist if you are performing within result searches, otherwise you will only ever have a SearchTermBundle
\nResultView where the Configuration options are your top-level options setting up the environment, this is your current search options setting up your search results. Here, you can set up paging or modify the order in which the results are returned.
\nWhilst a search sounds simple in nature, setting up a \"within results\" search can be confusing at first. As such, below, we have listed a number of key things to look out for as well as a few recommendations on how to use various options.
\nIn general, if your site maintains a list of search crumbs to show the user the terms on which they have been searching on, each of these should map to a single SearchTermBundle. This is a good way to break down how you searchTermBundle & PreviousSearchTermBundles should look when requesting a search.
\nExample of a site having just one search crumb (a simple not-within-result search) – Keyword: Pop
\nIn this example, when performing the request, you would have a SearchTermBundle and no PreviousSearchTermBundles,
\nIn this example, when receiving the response, you would have no SearchTermBundle however a single PreviousSearchTermBundles of the keyword search Pop
\nExample of a site having more than one search crumb (a within-result search) – Keyword: Pop & Keyword: Dance
\nIn this example, when performing a request, you would have a SearchTermBundle and a single PreviousSearchTermBundles. The SearchTermBundle of keyword search Dance and a PreviousSearchTermBundles of keyword search Pop
\nIn this example, when receiving the response, you would have no SearchTermBundle however two PreviousSearchTermBundles. 1 for keyword search Pop and 1 for keyword search Dance
\nWhen performing searches for a specific entity, for example a specific Album or Library it is recommended to search using ID’s as opposed to free text on the Album title or Library name. We have gone to lengths to provide efficient structures for searching using these terms so in order to have the fastest possible responses delivered to your site, please use these.
\nWhen performing searches, it is possible to negate the search such that it retrieves everything but what had been searched on. This works with single searches just as well as it does with within result searches. Each term bundle type (st_keyword_aggregate, st_custom, st_track, st_album etc) will have \"negative\" attribute that can be either true or false. When false, it will perform a search as per normal however when true it will negate the results that would normally be delivered.
\nSearch history is an important part of our Cloud Search capabilities. In order to have your search history maintained there are a number of rules that should be followed. Following these will not only mean your search history will be saved, but they will also enhance your knowledge of our Cloud Search capabilities:
\nAfter having performed a search you will notice that in your Response Object it will include a ParentSearchHistoryID property as well as a PreviousSearchTermBundles. These MUST be maintained for future searches if you are doing within result searches. If this is not sent into subsequent searches then the search history will not be maintained and your search may not work as expected or be recorded as expected when viewing the Search Keyword Reports in the HM Admin
\nParentSearchHistoryID; this will change each time you perform a search. In order to maintain a correct search history you will need to pass the changed value into any within-result searches each time. For new searches you need to remove it.
\nPreviousSearchTermBundles; that is the aggregate of your previous Search Bundles, it will contain your SearchTermBundle that you passed into the Request Object, however it will also contain the following important attributes; SearchTermBundle contains a “searchhistoryid” attribute and the SearchTerm_ contains a “SearchTermID”. It’s essential that they are included in the Request object for within result searches each time until a new search is performed from scratch.
\nWhen removing a search crumb from a within-result search it is important that the removal is sent in the request when performing a new search and is not just removed. This is so that the search history maintains that a removal took place.
\nIf we take our previous example, in which we had Keyword: Pop & Keyword: Dance, and remove Dance then we need to send that removal to perform the search. So we would have two SearchTermBundleHistory, one for Pop and one for Dance and a single SearchTermBundle that includes our removal of Pop ()
\nBelow is an example of how to remove \"Dance\".
We make a new Search Term Bundle which will be called \"st_removesearchterms\" , within it we pass the SearchHistoryID of the term we want to remove (you should find this in the response of your previous call) as well as \"SearchTermID\": 1 .
Finally we also update the ParentSearchHistoryID to the one received in our last Search response as well as update the PreviousSearchTermBundles :
{\n \"SaveSearchHistory\": \"true\",\n \"SearchFilters\": {\n \"SearchType\": \"Normal\",\n \"IncludeInactive\": \"false\",\n \"MainOnly\": \"true\",\n \"AlternateOnly\": \"false\",\n \"FeaturedLibrariesOnly\": null,\n \"LibraryType\": null,\n \"HasStems\": null,\n \"NearestBPM\": \"false\",\n \"NearestDuration\": \"false\",\n \"NearestAlternate\": \"false\",\n \"ParentSearchHistoryID\": \"7fd71e443023aca1a8715cb9ba8b88f5\",\n \"SearchTermBundle\": {\n \"st_removesearchterms\": [\n {\n \"SearchHistoryID\": 88748422,\n \"SearchTermID\": 1\n }\n ]\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 88745385,\n \"st_keyword_aggregated\": {\n \"searchtermid\": 1,\n \"searchtermidenc\": \"272f1d66c82967de\",\n \"Keywords\": \"pop\",\n \"exactphrase\": false,\n \"oroperation\": false,\n \"wildcard\": true,\n \"disablekeywordgroup\": false,\n \"negative\": false\n }\n },\n {\n \"SearchHistoryID\": 88748422,\n \"st_keyword_aggregated\": {\n \"searchtermid\": 1,\n \"searchtermidenc\": \"272f1d66c82967de\",\n \"Keywords\": \"dance\",\n \"exactphrase\": false,\n \"oroperation\": false,\n \"wildcard\": true,\n \"disablekeywordgroup\": false,\n \"negative\": false\n }\n }\n ],\n\nReturns tracks/albums/libraries/styles/playlists found using a combination of search terms.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Session
\nRequest Notes: Search Filters
\nThese parameters will be shared between “first search” and “search within results”.
\nRequest Notes: SearchTermBundle
\nFor st_keyword_aggregate and st_keyword there are a number of other fields that can be set.
\n“exactphrase” is optional, choose from \"true\" / \"false\", case insensitive, default value is “false”. Pass \"true\" to perform an exact phrase search on the keyword provided
\n“wildcard” is optional, choose from \"true\" / \"false\", case insensitive, default value is \"false\". Pass \"true\" to perform an wildcard search on the keyword provided.
\n\"disablekeywordgroup\" is optional, choose from \"true\" / \"false\", case insensitive, default value is \"false\". Pass \"true\" to prevent keyword groups from being included in searches.
\n\"oroperation\" is optional, choose from \"true\" / \"false\", case insensitive, default value is \"false\". This field is useful when a search is performed using multiple keywords in the one search term. For example, when this is false a search on \"pop rock\" will perform an AND search on these terms meaning that for a result to appear it must contain both pop AND rock. If this field is set to true, using the same search on \"pop rock\" will perform an OR search on these terms meaning that for a result to appear it must contain either pop OR rock.
\nIt is possible to perform a wildcard search with no term, to return all tracks/albums/libraries, by passing \"%\" into the keyword field for st_keyword and st_keyword_aggregated.
\nRequest Notes: ResultView
\nRequest Notes: SearchHistory
\nRequest Notes: Generate Playlist
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"af1b5f3f-1acf-48ca-ba18-0b31f9aabaa2","name":"Search (Aggregate Keyword Search) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Session\": null,\r\n \"SaveSearchHistory\": \"true\",\r\n \"SearchFilters\": {\r\n \"SearchType\": \"Normal\",\r\n \"IncludeInactive\": \"false\",\r\n \"MainOnly\": \"true\",\r\n \"AlternateOnly\": \"false\",\r\n \"FeaturedLibrariesOnly\": null,\r\n \"HasStems\": null,\r\n \"HasLyrics\": null,\r\n \"ExplicitOnly\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"GeneratePlaylist\": null,\r\n \"SearchTermBundle\": {\r\n \"St_Keyword_Aggregated\": {\r\n \"ExactPhrase\": \"false\",\r\n \"Wildcard\": \"false\",\r\n \"DisableKeywordGroup\": \"false\",\r\n \"OrOperation\": \"false\",\r\n \"Keywords\": \"france\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Track\",\r\n \"View_Style_Album_Count\": \"false\",\r\n \"View_Style_Playlist_Count\": \"false\",\r\n \"Sort_Predefined\": \"ReleaseDate_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"1\",\r\n \"Facet_LibraryGroup\": \"false\",\r\n \"Facet_LibraryGroupSkip\": \"0\",\r\n \"Facet_LibraryGroupLimit\": \"0\",\r\n \"Facet_Library\": \"false\",\r\n \"Facet_LibrarySkip\": \"0\",\r\n \"Facet_LibraryLimit\": \"0\",\r\n \"Facet_Album\": \"false\",\r\n \"Facet_AlbumSkip\": \"0\",\r\n \"Facet_AlbumLimit\": \"0\",\r\n \"Facet_Style\": \"false\",\r\n \"Facet_StyleSkip\": \"0\",\r\n \"Facet_StyleLimit\": \"0\",\r\n \"Facet_Category\": \"false\",\r\n \"Facet_CategorySkip\": \"0\",\r\n \"Facet_CategoryLimit\": \"0\",\r\n \"Facet_Composer\": \"false\",\r\n \"Facet_ComposerSkip\": \"0\",\r\n \"Facet_ComposerLimit\": \"0\",\r\n \"Facet_BPM\": \"false\",\r\n \"Facet_Duration\": \"false\",\r\n \"Facet_ReleaseYear\": \"false\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 17 Sep 2019 05:45:48 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"10076"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 4746,\n \"TotalAlbums\": 1266,\n \"TotalLibraries\": 153,\n \"TotalStyles\": 12,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"featuredlibrariesonly\": null,\n \"hasstems\": null,\n \"haslyrics\": null,\n \"explicitonly\": null,\n \"nearestduration\": false,\n \"nearestbpm\": false,\n \"nearestalternate\": false, \n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"generateplaylist\": null,\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"ReleaseDate_Asc\",\n \"rankexpression\": \"\",\n \"skip\": 0,\n \"limit\": 1,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_librarygroup\": false,\n \"facet_librarygroupskip\": 0,\n \"facet_librarygrouplimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false,\n \"facet_releaseyear\": false,\n \"view_style_album_count\": false,\n \"view_style_playlist_count\": false\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 11676439,\n \"st_keyword_aggregated\": {\n \"searchtermid\": 1,\n \"Keywords\": \"france\",\n \"exactphrase\": false,\n \"oroperation\": false,\n \"wildcard\": false,\n \"disablekeywordgroup\": false\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"005\",\n \"LengthSeconds\": \"189\",\n \"Comment\": \"Medium. Driving Rock tune with distorted guitars.\",\n \"Composer\": \"Claude Engel\",\n \"AlbumID\": \"qf2bcl77hqf73359ec\",\n \"LibraryID\": \"7ga24341da8f8915b1\",\n \"ID\": \"a30634aem432346072\",\n \"DisplayTitle\": \"French Rock\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Rock\",\n \"Bpm\": \"108\",\n \"Version\": \"Original\",\n \"CDCode\": \"TM 3026\",\n \"AlbumName\": \"TM 3026 99% Pop\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"2\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"a660d506e12f7c7ckf\"\n }\n ],\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"851764f4-54c7-4a69-95bf-405075af2816","name":"Search (Aggregate Keyword Search) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns suggestions for terms entered. Only active status contents will be included in the response.
\nSuggested search can used across each of the following areas:
\nTracks
\nAlbums
\nLabels
\nStyles
\nCategories
\nRightholders
\nLyrics
\nKeywords
\nFeatured Playlists
\nRequest Elements
\nRequest Notes
\nThese parameters will be shared between \"first search\" and \"search within results\".
\nRequest Notes: Fields
\nRequest Notes: Ordering
\nRequest Notes: Right Holders
In the request, when choosing to return right hoders the rightholdertypes is comma-seperated string of right holder types Possible options include; Author, Composer, ComposerAuthor, Arranger, Publisher, SubPublisher, Artist. Leaving this empty will search across all types.
Response Notes: Keywords
If, in the request, returnkeywordsformatch is \"true\" then returnfeaturedplaylist_fields will be referenced to determine what fields the kewyords should be drawn from. The default is TrackKeywords, however there are a number of other possible fields that can also be applied. When returnfeaturedplaylist_fields is set then the response will include new properties for each keyword returned that will advise where the keyword was drawn from.
For example, if the request returnfeaturedplaylist_fields was set to \"TrackKeywords, TrackGenre\" and the response provided keywords that were drawn from both of these sources then each keyword will provide what source it was out of the 2 that it was drawn from. If there are two keywords with the same name but coming from difference sources then these result will be combined to form a unique keyword and the source will display as \"TrackKeywords, TrackGenre\".
There are four different approaches available in the HM Public API for searching of similar tracks.
\nThese four approaches are:
\nSearching by a HM TrackID
\nSearching by an Uploaded AudioFile
\nSearching by a URL
\nSearching by Prompt/Free-text
\nHarvest Media currently integrates closely with three external similarity providers; AIMS, Cyanite and Harmix.
\nPlease note that regardless of which similiarity service you are working with, this is a specialized service in Harvest Media and requires indexing of your account before it can be used. As it is specialised, there are costs associated with it's integration and use. Please contact us for more information.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"70ad6427-d9c9-4dad-bd04-ac21f252dded"}],"id":"cccbe827-d49b-4964-8f84-67bb787aefcc","_postman_id":"cccbe827-d49b-4964-8f84-67bb787aefcc","description":""},{"name":"AIMS","item":[{"name":"Similarity (By TrackID)","item":[{"name":"Search Similar Tracks (By TrackID)","event":[{"listen":"test","script":{"id":"6790c81e-b83a-4d10-b757-6071201df62e","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f0ffaf9e-2405-464a-9add-2f455ad97b23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\"TrackID\": \"{{HM_ServiceAPI_TrackID}}\"}],\r\n \"Start\": \"\",\r\n \"Duration\": \"\" \r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_IncludeSeed\": false,\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Limit\": \"{{HM_ServiceAPI_Limit}}\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","description":"Returns similar tracks based a seed track.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\nResponse Notes
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b327490a-a5e4-4c1b-bbbb-1d9c5daac84f","name":"Search Similar Tracks (By TrackID) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\"TrackID\": \"91b2b4eghd66f9d252\"}],\r\n \"Start\": \"20\",\r\n \"Duration\": \"40\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_IncludeSeed\": true,\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 17 Sep 2019 06:35:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2125"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 13,\n \"TotalAlbums\": 1,\n \"TotalLibraries\": 1,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"oa4ja92abe12bp2922\",\n \"region\": \"3a6pqf6be7413d498b\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"evoke_includeseed\": true,\n \"rankexpression\": \"\",\n \"skip\": 0,\n \"limit\": 1,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 11676448,\n \"st_audio\": {\n \"trackid\": \"91b2b4eghd66f9d252\",\n \"start\": \"20\",\n \"duration\": \"40\"\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"LengthSeconds\": \"219\",\n \"Comment\": \"Emotive guitar mood / glitzy and dreamy\",\n \"Composer\": \"Sergey Kolosov\",\n \"AlbumID\": \"qf2bcl77hqf73359ec\",\n \"LibraryID\": \"7ga24341da8f8915b1\",\n \"ID\": \"a30634aem432346072\",\n \"DisplayTitle\": \"Starfish\",\n \"alternatetitle\": \"\",\n \"Genre\": \"indie, rock, rock 'n' roll, promo\",\n \"Bpm\": \"103\",\n \"Version\": \"Main\",\n \"CDCode\": \"ALT 001\",\n \"AlbumName\": \"ALT 001 Indie Star Anthems\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"5\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"a660d506e12f7c7ckf\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"c5006876-059a-46c6-8d74-9324179a0cf8","name":"Search Similar Tracks (By TrackID) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by a HM Track Identity, allows you to provide a Track Identifer found from any of our track responses to obtain similar tracks based off that Track. This is perhaps the simplest to implement from the outset;
\n\n","_postman_id":"ce63993c-9684-44f6-b874-c757bd9eb59f"},{"name":"Similarity (By Audio File Upload)","item":[{"name":"Get Audio File Upload URL","event":[{"listen":"test","script":{"id":"bc2aa5c8-9648-4a26-b25d-7fa35c0f9fff","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","// var jsonData = null;","// var jsonDataPresignedURL = \"\";","// var jsonDataResourceURL = \"\";","","// if (responseBody.indexOf(\"= 0) {","// jsonData = xml2Json(responseBody);","// jsonDataPresignedURL = jsonData.responsepresigneduploadurl.presigneduploadurl;","// jsonDataResourceURL = jsonData.responsepresigneduploadurl.resourceurl;","// } else {","// jsonData = JSON.parse(responseBody);","// jsonDataPresignedURL = jsonData.PresignedUploadUrl;","// jsonDataResourceURL = jsonData.ResourceUrl;","// }","","// console.log(\"HM_ServiceAPI_PresignedURL set to \" + jsonDataPresignedURL);","// console.log(\"HM_ServiceAPI_ResourceURL set to \" + jsonDataResourceURL);","","// postman.setEnvironmentVariable(\"HM_ServiceAPI_PresignedURL\", jsonDataPresignedURL);","// postman.setEnvironmentVariable(\"HM_ServiceAPI_ResourceURL\", jsonDataResourceURL);","","postman.setNextRequest(\"Confirm Member Image Upload Complete\");"],"type":"text/javascript"}}],"id":"0b7396d7-ff89-4f2f-87fc-8799633def7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n\t\"ContentType\":\"audio/mpeg\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}","description":"Returns a URL for which an audio file asset can be uploaded to.
\nRequest Elements
\nRequest Notes
\nResponse Elements
\n","urlObject":{"path":["getpresigneduploadurl","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a21a0716-fb47-49ec-853b-a70b389cdfbd","name":"Get Audio File Upload URL (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n\t\"ContentType\":\"audio/mpeg\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:50:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PresignedUploadUrl\": \"https://{domain}/test.mp3?X-Amz-Expires=120&X-Amz-Algorithm=&X-Amz-Credential=&X-Amz-Date=&X-Amz-SignedHeaders=\",\n \"ResourceUrl\": \"https://{domain}/test.mp3\"\n}"},{"id":"a433340e-20c7-40ab-8f3d-f9e9dca383c7","name":"Get Audio File Upload URL (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Finalises an asset upload.
\nPlease note that this is the final step in uploading a audio file for searching similar tracks. Prior to performing this you should;
\nCall Get Audio File Upload URL to retrieve a pre-signed upload URL
\nPerformed a PUT request to the retrieved pre-signed upload URL, with the contentType on the request set to the content type that was provided when retrieving the pre-signed URL - audio/mpeg for mp3 or audio/wave for wav.
\nPerform this API call to finalize that upload has been completed. Failure to call this final step will result in the asset not being available to search with.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["confirmpresignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"314c21fd-92a5-4ded-95de-7524dce833cd","name":"Confirm Audio File Upload Complete (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ImportAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n \"ReturnWaveformDatapoints\": false,\r\n\t\"ObjectId\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/confirmpresignedupload/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:51:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"e432740c-230e-4b0e-b413-8d97406652fc","name":"Confirm Audio File Upload Complete (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns similar tracks based an uploaded audio file.
\nAt present, only MP3 and WAV are allowed for upload with AIMS.
\nRefer to the implementation guide for any pre-requisite steps before being able to search - Searching Similar Tracks. An audio file must be uploaded, and finished analysis before it can be used for similarity searching.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\nResponse Notes
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e480339c-7790-43c9-9e8b-e19f2d41833f","name":"Search Similar Tracks (By Audio File Upload) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\r\n \"Url\": \"https://{domain}.mp3\",\r\n \"Type\": \"MP3\",\r\n \"Start\": \"0\",\r\n \"Duration\": \"60\" \r\n }]\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Aug 2020 08:36:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 47,\n \"TotalAlbums\": 17,\n \"TotalLibraries\": 10,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"h7076ffb4d82a03n05\",\n \"region\": \"3a62sb6bed741449ob\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"9fae21e2027f3a8bd2431e6gh13108fb2f\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 1,\n \"st_audio\": {\n \"searchtermid\": 1,\n \"audio\": [\n {\n \"url\": \"https://{domain}/test.mp3\",\n \"type\": \"MP3\",\n \"start\": \"0\",\n \"duration\": \"60\" \n }\n ]\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"126\",\n \"LengthSeconds\": \"114\",\n \"Comment\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"Composer\": \"Lior Rosner, Jack Lawrence Starbuck Wilson\",\n \"AlbumID\": \"520a3f8y470e4fa242\",\n \"LibraryID\": \"3d8ae6f5fg5bf0ceb0\",\n \"ID\": \"3i2d46f2e893jf1bik\",\n \"Keywords\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"DisplayTitle\": \"Apex STEM (bass pulse)\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Trailer\",\n \"Bpm\": \"137\",\n \"Version\": \"MAIN\",\n \"CDCode\": \"XRCD076b\",\n \"AlbumName\": \"XRCD076b - Dogma 2 Lethal Bites STEMS\",\n \"LibraryName\": \"X-Ray Dog\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"12\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"5d2fba234a4cg97468\"\n },\n {\n \"ID\": \"9s0dcg777995e2b416\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ]\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"763d0014-eb56-4145-b7d5-3876240d582a","name":"Search Similar Tracks (By Audio File Upload) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by an uploaded audio file requires a number of steps;
\nObtaining a pre-signed audio upload URL. This will allow you to get permission to upload an audio file for analysis to our servers.
\n\nPerform a PUT FILE request to the generated pre-signed URL. This is the act of actually uploading / delivering the audio file to us. This file will be used for analysis purposes
\nConfirm the audio upload has completed. By confirming your upload complete, we can provide access to the file for similarity searching
\n\nRequest a similar search. This is the actual request to find similar tracks based on the uploaded file.
\n\nReturns a streaming URL for which an external audio file asset, using a URL.
\nNote this is only usable for specific search similar integrations (e.g. AIMS). Attempting to use this when an integration is not on an account will result in an error code.
\nRequest Elements
\nRequest Notes
\nResponse Elements
\n","urlObject":{"path":["getexternalaudiobyurl","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"830b1d76-a6bd-4d95-abc5-b76db1914cf1","name":"Get External Audio File (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Url\": \"https://www.youtube.com/watch?v=fV4DiAyExN0xxx\",\r\n \"Type\": \"YouTube\",\r\n \"ReturnWaveformDataPoints\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getexternalaudiobyurl/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 May 2022 06:01:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ResourceUrl\": \"https://{resourceurl}/fv4diayexn0xxx.mp3\",\n \"Asset\": {\n \"MaxDuration\": \"251\",\n \"WaveformDatapoints\": \"{'version':2,'channels':1,'sample_rate':44100,'samples_per_pixel':4428,'bits':8,'length':2495,'data':[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,-6,8,-12,11,-15,14,-21,15,-21,23,-32,27,-34,29,-34,36,-31,33,-47,39,-36,39,-45,37,-36,45,-44,50,-50,53,-51,46,-52,53,-50,46,-52,48,-50,49,-47,42,-49,52,-43,50,-41,42,-36,39,-34,32,-31,31,-32,27,-32,29,-23,26,-33,28,-29,29,-26,24,-29,32,-27,29,-33,33,-26,25,-28,24,-23,24,-24,27,-31,26,-20,23,-23,22,-33,28,-22,24,-23,27,-31,28,-24,29,-20,22,-19,19,-22,21,-25,25,-19,19,-23,24,-50,34,-18,29,-23,20,-19,18,-22,28,-23,17,-30,20,-14,15,-44,31,-20,22,-28,28,-22,15,-16,22,-19,21,-19,24,-18,25,-23,19,-19,20,-21,22,-23,20,-20,22,-14,17,-22,16,-13,14,-14,15,-18,16,-19,20,-13,15,-18,15,-15,13,-17,17,-15,16,-14,23,-14,20,-21,19,-23,16,-21,18,-21,20,-20,17,-24,21,-24,19,-25,18,-17,24,-24,21,-18,17,-17,20,-19,23,-24,23,-33,27,-49,71,-94,108,-108,121,-111,121,-120,123,-101,116,-103,107,-100,120,-105,109,-101,109,-117,127,-127,127,-123,125,-126,122,-118,121,-108,122,-112,117,-123,127,-112,127,-94,88,-49,58,-45,36,-71,67,-118,120,-25,26,-31,28,-18,18,-23,17,-19,16,-91,67,-107,...]}\"\n }\n}"},{"id":"57ce5245-de28-484b-9564-e55ee02cba27","name":"Get External Audio File (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns similar tracks based on a music URL.
\nPresently YouTube, Spotify, SoundCloud, Apple Music and Vimeo is supported by AIMS.
\nRefer to the implementation guide for any pre-requisite steps before being able to search - Searching Similar Tracks. An URL must finish analysis before it can be used for similarity searching.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\nResponse Notes
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"9fe91021-410a-4297-a779-e6aaedfbb657","name":"Search Similar Tracks (By YouTube URL) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\r\n \"Url\": \"https://www.youtube.com/watch?v={id}\",\r\n \"Type\": \"Youtube\",\r\n \"Start\": \"20\",\r\n \"Duration\": \"40\"\r\n }]\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Aug 2020 08:36:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 47,\n \"TotalAlbums\": 17,\n \"TotalLibraries\": 10,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"h7076ffb4d82a03n05\",\n \"region\": \"3a62sb6bed741449ob\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"9fae21e2027f3a8bd2431e6gh13108fb2f\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 1,\n \"st_audio\": {\n \"searchtermid\": 1,\n \"audio\": [\n {\n \"url\": \"https://www.youtube.com/watch?v={id}\",\n \"type\": \"YouTube\",\n \"start\": \"20\",\n \"duration\": \"40\"\n }\n ]\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"126\",\n \"LengthSeconds\": \"114\",\n \"Comment\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"Composer\": \"Lior Rosner, Jack Lawrence Starbuck Wilson\",\n \"AlbumID\": \"520a3f8y470e4fa242\",\n \"LibraryID\": \"3d8ae6f5fg5bf0ceb0\",\n \"ID\": \"3i2d46f2e893jf1bik\",\n \"Keywords\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"DisplayTitle\": \"Apex STEM (bass pulse)\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Trailer\",\n \"Bpm\": \"137\",\n \"Version\": \"MAIN\",\n \"CDCode\": \"XRCD076b\",\n \"AlbumName\": \"XRCD076b - Dogma 2 Lethal Bites STEMS\",\n \"LibraryName\": \"X-Ray Dog\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"12\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"5d2fba234a4cg97468\"\n },\n {\n \"ID\": \"9s0dcg777995e2b416\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"2b32e498-f259-47ce-a0f0-cb4b62fe009d","name":"Search Similar Tracks (By YouTube URL) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by a URL requires a single step;
\nThis step is not required, however if you would like to retrieve the external audio file from the URL for in-site sampling then you can request the external audio file and datapoints
\nRequest a similar search by URL. It should be noted that the following URL types are supported; YouTube, Spotify, Vimeo and SoundCloud.
\nSee
\n\nReturns similar tracks based on a prompt / free-text.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"fe42adb7-cb70-4ea7-91dc-c7425baa368d","name":"Search Similar Tracks (By Prompt) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\": [\r\n {\r\n \"Prompt\": \"Waves hitting the beach\"\r\n }\r\n ],\r\n \"Start\": \"\",\r\n \"Duration\": \"\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_IncludeSeed\": false,\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Skip\": \"0\",\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 17 Sep 2019 06:35:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2125"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 13,\n \"TotalAlbums\": 1,\n \"TotalLibraries\": 1,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"oa4ja92abe12bp2922\",\n \"region\": \"3a6pqf6be7413d498b\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"evoke_includeseed\": true,\n \"rankexpression\": \"\",\n \"skip\": 0,\n \"limit\": 1,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 11676448,\n \"st_audio\": {\n \"prompt\": \"Waves hitting the beach\",\n \"start\": \"\",\n \"duration\": \"\"\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"LengthSeconds\": \"219\",\n \"Comment\": \"Emotive guitar mood / glitzy and dreamy\",\n \"Composer\": \"Sergey Kolosov\",\n \"AlbumID\": \"qf2bcl77hqf73359ec\",\n \"LibraryID\": \"7ga24341da8f8915b1\",\n \"ID\": \"a30634aem432346072\",\n \"DisplayTitle\": \"Starfish\",\n \"alternatetitle\": \"\",\n \"Genre\": \"indie, rock, rock 'n' roll, promo\",\n \"Bpm\": \"103\",\n \"Version\": \"Main\",\n \"CDCode\": \"ALT 001\",\n \"AlbumName\": \"ALT 001 Indie Star Anthems\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"5\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"a660d506e12f7c7ckf\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"9851d71b-2448-49a7-ac94-6059ed320571","name":"Search Similar Tracks (By Prompt) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by Prompt, allows you to provide a sentence or prompt and receive similar tracks based off that;
\n\n","_postman_id":"7e75c0db-9202-4140-942c-7fdac0055158"}],"id":"477760b4-7d38-45fe-bd66-6b32b61f41c9","_postman_id":"477760b4-7d38-45fe-bd66-6b32b61f41c9","description":""},{"name":"CYANITE","item":[{"name":"Similarity (By TrackID)","item":[{"name":"Search Similar Tracks (By TrackID)","id":"e8a09a78-e030-4ee4-bff1-36616ba1422b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","description":"Returns similar tracks based a seed track.
\nRefer to the implementation guide for any pre-requisite steps before being able to search - Searching Similar Tracks
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e995e594-fc03-4066-90fb-69b59bf6781c","name":"Search Similar Tracks (By TrackID) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\"TrackID\": \"91b2b4eghd66f9d252\"}],\r\n \"Start\": \"0\",\r\n \"Duration\": \"60\" \r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 17 Sep 2019 06:35:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2125"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 13,\n \"TotalAlbums\": 1,\n \"TotalLibraries\": 1,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"oa4ja92abe12bp2922\",\n \"region\": \"3a6pqf6be7413d498b\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"evoke_includeseed\": true,\n \"rankexpression\": \"\",\n \"skip\": 0,\n \"limit\": 1,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 11676448,\n \"st_audio\": {\n \"trackid\": \"91b2b4eghd66f9d252\",\n \"start\": \"0\",\n \"duration\": \"60\"\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"LengthSeconds\": \"219\",\n \"Comment\": \"Emotive guitar mood / glitzy and dreamy\",\n \"Composer\": \"Sergey Kolosov\",\n \"AlbumID\": \"qf2bcl77hqf73359ec\",\n \"LibraryID\": \"7ga24341da8f8915b1\",\n \"ID\": \"a30634aem432346072\",\n \"DisplayTitle\": \"Starfish\",\n \"alternatetitle\": \"\",\n \"Genre\": \"indie, rock, rock 'n' roll, promo\",\n \"Bpm\": \"103\",\n \"Version\": \"Main\",\n \"CDCode\": \"ALT 001\",\n \"AlbumName\": \"ALT 001 Indie Star Anthems\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"5\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"a660d506e12f7c7ckf\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"143dba21-616d-4ec2-b06b-d07890796a18","name":"Search Similar Tracks (By TrackID) (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by a HM Track Identity, allows you to provide a Track Identifer found from any of our track responses to obtain similar tracks based off that Track. This is perhaps the simplest to implement from the outset;
\n\n","_postman_id":"ebca0e03-8772-4e8c-b513-385b7ac11685"},{"name":"Similarity (By Uploaded Audio File)","item":[{"name":"Get Audio File Upload URL","id":"f046e419-ba3d-495a-87b5-327bbed7b0ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}","description":"Returns a URL for which an audio file asset can be uploaded to.
\nRequest Elements
\nRequest Notes
\nResponse Elements
\n","urlObject":{"path":["getpresigneduploadurl","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6307e63b-7569-44dc-a122-480896975f61","name":"Get Audio File Upload URL (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n\t\"ContentType\":\"audio/mpeg\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:50:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PresignedUploadUrl\": \"https://{domain}/test.mp3?X-Amz-Expires=120&X-Amz-Algorithm=&X-Amz-Credential=&X-Amz-Date=&X-Amz-SignedHeaders=\",\n \"ResourceUrl\": \"https://{domain}/test.mp3\"\n}"},{"id":"8948841d-7883-44e2-a496-4275a6a3a121","name":"Get Audio File Upload URL (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Finalises an asset upload.
\nPlease note that this is the final step in uploading a audio file for searching similar tracks. Prior to performing this you should;
\nCall
\n\nto retreive a pre-signed upload URL
\nPerformed a PUT request to the retreived pre-signed upload URL, with the contentType on the request set to the content type that was provided when retrieving the pre-signed URL - in this case audio/mpeg
\nPerform this API call to finalize that upload has been completed. Failure to call this final step will result in the asset not being available to search with
\nRequest Elements
\nRequest Notes
\nResponse Notes
\n","urlObject":{"path":["confirmpresignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a99919c9-00b9-45ab-997e-7d2ca2a9849e","name":"Confirm Audio File Upload Complete (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ImportAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n \"ReturnWaveformDatapoints\": false,\r\n \"ReturnWaveformDatapointsUrl\": false,\r\n\t\"ObjectId\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/confirmpresignedupload/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:51:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\",\n \"Asset\": {\n \"MaxDuration\": \"\",\n \"WaveformDatapoints\": \"\",\n \"WaveformDatapointsUrl\": \"\",\n \"ExternalID\": \"38da4b33a20e0021209b71878f91c0bcd6\"\n }\n}"},{"id":"f5a78b20-9b75-41a4-b5a8-227ffd45f18e","name":"Confirm Audio File Upload Complete (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\n Returns a status code indicating whether an external search similar provider has completed analysis on the uploaded audio file, and if the audio file is ready for searching against.
\nRequest Elements
\nRequest Notes
\nResponse Notes:
\nThere are a variety of responses to manage here.
\nAnalysis Pending - this indicates that the external file is still undergoing analysis and is not yet able to provide similar results. Please wait a while and request status again
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Pending\"\n }\n}\n\nAnalysis Failed - Service not available - this indicates that the service is not available on this account. Please contact us
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - Service not available\"\n }\n}\n\nAnalysis Failed - Account limit reached - this indicates that the account has reached it's available capacity for analysis. Please contact the similiarity provider about your account
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - Account limit reached\"\n }\n}\n\nAnalysis Failed - The song does not have a preview url and can therefore not be analyzed - this is a Spotify only error and indicates that the particular track does not have a preview. Thus, the Spotify URL cannot be used to provide similar results
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - The song does not have a preview url and can therefore not be analyzed\"\n }\n}\n\nOK - this indicates that the external file has completed analysis and is now ready to return similar results.
\n{\n \"Code\": \"OK\"\n}\n\nOK\nReturns similar tracks based an uploaded audio file.
\nAt present, only MP3 is allowed for upload with Cyanite.
\nRefer to the implementation guide for any pre-requisite steps before being able to search - Searching Similar Tracks. An audio file must be uploaded, and finished analysis before it can be used for similarity searching.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a26ee32c-c500-4f58-b29a-e322ae0d7e08","name":"Search Similar Tracks (By Audio File Upload) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\r\n \"Url\": \"https://{domain}/test.mp3\",\r\n \"Type\": \"MP3\"\r\n }],\r\n \"Start\": \"0\",\r\n \"Duration\": \"60\" \r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Aug 2020 08:36:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 47,\n \"TotalAlbums\": 17,\n \"TotalLibraries\": 10,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"h7076ffb4d82a03n05\",\n \"region\": \"3a62sb6bed741449ob\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"9fae21e2027f3a8bd2431e6gh13108fb2f\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 1,\n \"st_audio\": {\n \"searchtermid\": 1,\n \"audio\": [\n {\n \"url\": \"https://{domain}/test.mp3\",\n \"type\": \"MP3\",\n \"start\": \"0\",\n \"duration\": \"60\" \n }\n ]\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"126\",\n \"LengthSeconds\": \"114\",\n \"Comment\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"Composer\": \"Lior Rosner, Jack Lawrence Starbuck Wilson\",\n \"AlbumID\": \"520a3f8y470e4fa242\",\n \"LibraryID\": \"3d8ae6f5fg5bf0ceb0\",\n \"ID\": \"3i2d46f2e893jf1bik\",\n \"Keywords\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"DisplayTitle\": \"Apex STEM (bass pulse)\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Trailer\",\n \"Bpm\": \"137\",\n \"Version\": \"MAIN\",\n \"CDCode\": \"XRCD076b\",\n \"AlbumName\": \"XRCD076b - Dogma 2 Lethal Bites STEMS\",\n \"LibraryName\": \"X-Ray Dog\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"12\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"5d2fba234a4cg97468\"\n },\n {\n \"ID\": \"9s0dcg777995e2b416\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ]\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"a2685e9f-e679-479c-9ca4-51840fa6b04e","name":"Search Similar Tracks (By Audio File Upload) (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by an uploaded audio file requires a number of steps;
\nObtaining a pre-signed audio upload URL. This will allow you to get permission to upload an audio file for analysis to our servers.
\n\nPerform a PUT FILE request to the generated pre-signed URL. This is the act of actually uploading and delivering the audio file to the external provider
\nConfirm the audio upload completed. By confirming your upload complete, we can provide access to the file for similarity searching
\nOf special note is the ExternalID in the response. This will be used to poll status in the next step
\nPoll our service for status updates as to when the uploaded audio file has finished analysis and is ready for similarity requesting
\nContinue to repeat (4) if the response is Analysis Pending, until the response is OK before proceeding to step 5
\nRequest a similar search. This is the actual request to find similar tracks based on the uploaded file.
\n\nReturns a status code indicating whether an external search similar provider has completed analysis on the URL and if it is ready for searching against.
\nRequest Elements
\nRequest Notes
\nResponse Notes:
\nThere are a variety of responses to manage here.
\nAnalysis Pending - this indicates that the external file is still undergoing analysis and is not yet able to provide similar results. Please wait a while and request status again
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Pending\"\n }\n}\n\nAnalysis Failed - Service not available - this indicates that the service is not available on this account. Please contact us
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - Service not available\"\n }\n}\n\nAnalysis Failed - Account limit reached - this indicates that the account has reached it's available capacity for analysis. Please contact the similiarity provider about your account
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - Account limit reached\"\n }\n}\n\nAnalysis Failed - The song does not have a preview url and can therefore not be analyzed - this is a Spotify only error and indicates that the particular track does not have a preview. Thus, the Spotify URL cannot be used to provide similar results
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - The song does not have a preview url and can therefore not be analyzed\"\n }\n}\n\nOK - this indicates that the external file has completed analysis and is now ready to return similar results.
\n{\n \"Code\": \"OK\"\n}\n\nOK\nOK\nReturns similar tracks based an a music URL.
\nPresently only Spotify is supported by Cyanite.
\nRefer to the implementation guide for any pre-requisite steps before being able to search - Searching Similar Tracks. An URL must finish analysis before it can be used for similarity searching.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5266a6fb-ad79-46e4-ad7b-166762fcba13","name":"Search Similar Tracks (By YouTube URL) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\r\n \"Url\": \"https://open.spotify.com/track/4vcztrr5NN9g3CocSSBLGO2g\",\r\n \"Type\": \"Spotify\"\r\n }]\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Aug 2020 08:36:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 47,\n \"TotalAlbums\": 17,\n \"TotalLibraries\": 10,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"h7076ffb4d82a03n05\",\n \"region\": \"3a62sb6bed741449ob\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"9fae21e2027f3a8bd2431e6gh13108fb2f\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 1,\n \"st_audio\": {\n \"searchtermid\": 1,\n \"audio\": [\n {\n \"url\": \"https://open.spotify.com/track/4vcztr5NN9g3CocSSBLGOg\",\n \"type\": \"Spotify\",\n \"start\": \"\",\n \"duration\": \"\"\n }\n ]\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"126\",\n \"LengthSeconds\": \"114\",\n \"Comment\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"Composer\": \"Lior Rosner, Jack Lawrence Starbuck Wilson\",\n \"AlbumID\": \"520a3f8y470e4fa242\",\n \"LibraryID\": \"3d8ae6f5fg5bf0ceb0\",\n \"ID\": \"3i2d46f2e893jf1bik\",\n \"Keywords\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"DisplayTitle\": \"Apex STEM (bass pulse)\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Trailer\",\n \"Bpm\": \"137\",\n \"Version\": \"MAIN\",\n \"CDCode\": \"XRCD076b\",\n \"AlbumName\": \"XRCD076b - Dogma 2 Lethal Bites STEMS\",\n \"LibraryName\": \"X-Ray Dog\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"12\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"5d2fba234a4cg97468\"\n },\n {\n \"ID\": \"9s0dcg777995e2b416\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"a26f17bb-c584-4f9f-adeb-e4185a86f4dc","name":"Search Similar Tracks (By YouTube URL) (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by URL requires a number of steps. The steps vary depending on the type of URL.
\nSteps for a Spotify URL;
\nCheck the service for the availability of the Spotify URL
\nContinue to repeat (1) if the response is Analysis Pending, until the response is OK before proceeding to step 2
\nRequest a similar search. This is the actual request to find similar tracks based on the provided URL.
\n\nSteps for a YouTube URL;
\nCheck the service for the availability of the YouTube URL
\nGet External Audio File Ingestion Status and retrieve an External ID
\nGet External Audio File Ingestion Status using the External ID
\nContinue to repeat (2) if the response is Analysis Pending, until the response is OK before proceeding to step 2
\nRequest a similar search. This is the actual request to find similar tracks based on the provided URL.
\n\nReturns similar tracks based on a prompt / free-text.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b823e2d7-4f6e-4a72-9c83-cfe40840dbc3","name":"Search Similar Tracks (By Free Text) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\": [\r\n {\r\n \"Prompt\": \"Waves hitting the beach\"\r\n }\r\n ],\r\n \"Start\": \"\",\r\n \"Duration\": \"\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_IncludeSeed\": false,\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Skip\": \"0\",\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 17 Sep 2019 06:35:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2125"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 13,\n \"TotalAlbums\": 1,\n \"TotalLibraries\": 1,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"oa4ja92abe12bp2922\",\n \"region\": \"3a6pqf6be7413d498b\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"evoke_includeseed\": true,\n \"rankexpression\": \"\",\n \"skip\": 0,\n \"limit\": 1,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 11676448,\n \"st_audio\": {\n \"prompt\": \"Waves hitting the beach\",\n \"start\": \"\",\n \"duration\": \"\"\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"LengthSeconds\": \"219\",\n \"Comment\": \"Emotive guitar mood / glitzy and dreamy\",\n \"Composer\": \"Sergey Kolosov\",\n \"AlbumID\": \"qf2bcl77hqf73359ec\",\n \"LibraryID\": \"7ga24341da8f8915b1\",\n \"ID\": \"a30634aem432346072\",\n \"DisplayTitle\": \"Starfish\",\n \"alternatetitle\": \"\",\n \"Genre\": \"indie, rock, rock 'n' roll, promo\",\n \"Bpm\": \"103\",\n \"Version\": \"Main\",\n \"CDCode\": \"ALT 001\",\n \"AlbumName\": \"ALT 001 Indie Star Anthems\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"5\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"a660d506e12f7c7ckf\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"211d4795-0270-468b-8c15-67cfb182c3af","name":"Search Similar Tracks (By Free Text) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by Free Text, allows you to provide a sentence or free text and receive similar tracks based off that;
\n\n","_postman_id":"5ab3aea4-202b-4bfd-9c55-737ee99f0d0d"}],"id":"2b5548db-5a63-4c20-ad9e-8a9afd9d9e70","_postman_id":"2b5548db-5a63-4c20-ad9e-8a9afd9d9e70","description":""},{"name":"HARMIX","item":[{"name":"Similarity (By Track ID)","item":[{"name":"Search Similar Tracks (By TrackID)","id":"b1cf43d0-3c75-483a-8f9f-0cc4c6853f53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\": [\r\n {\r\n \"TrackID\": \"{{HM_ServiceAPI_TrackID}}\"\r\n }\r\n ],\r\n \"Start\": \"\",\r\n \"Duration\": \"\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_IncludeSeed\": false,\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Skip\": \"{{HM_ServiceAPI_Skip}}\",\r\n \"Limit\": \"{{HM_ServiceAPI_Limit}}\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","description":"Returns similar tracks based a seed track.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\nResponse Notes
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"dd91b396-a551-40f7-9ce9-87874017d871","name":"Search Similar Tracks (By TrackID) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\"TrackID\": \"91b2b4eghd66f9d252\"}],\r\n \"Start\": \"20\",\r\n \"Duration\": \"40\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_IncludeSeed\": true,\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 17 Sep 2019 06:35:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2125"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 13,\n \"TotalAlbums\": 1,\n \"TotalLibraries\": 1,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"oa4ja92abe12bp2922\",\n \"region\": \"3a6pqf6be7413d498b\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"evoke_includeseed\": true,\n \"rankexpression\": \"\",\n \"skip\": 0,\n \"limit\": 1,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 11676448,\n \"st_audio\": {\n \"trackid\": \"91b2b4eghd66f9d252\",\n \"start\": \"20\",\n \"duration\": \"40\"\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"LengthSeconds\": \"219\",\n \"Comment\": \"Emotive guitar mood / glitzy and dreamy\",\n \"Composer\": \"Sergey Kolosov\",\n \"AlbumID\": \"qf2bcl77hqf73359ec\",\n \"LibraryID\": \"7ga24341da8f8915b1\",\n \"ID\": \"a30634aem432346072\",\n \"DisplayTitle\": \"Starfish\",\n \"alternatetitle\": \"\",\n \"Genre\": \"indie, rock, rock 'n' roll, promo\",\n \"Bpm\": \"103\",\n \"Version\": \"Main\",\n \"CDCode\": \"ALT 001\",\n \"AlbumName\": \"ALT 001 Indie Star Anthems\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"5\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"a660d506e12f7c7ckf\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"83e3607e-8395-4222-bd1d-6ca6d2c5ffc4","name":"Search Similar Tracks (By TrackID) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by a HM Track Identity, allows you to provide a Track Identifer found from any of our track responses to obtain similar tracks based off that Track. This is perhaps the simplest to implement from the outset;
\n\n","_postman_id":"f78a9dce-a153-43be-8d90-5489398d3966"},{"name":"Similarity (By Audio File Upload)","item":[{"name":"Get Audio File Upload URL","id":"0eb3d019-0114-4942-a794-67dc429ca297","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n\t\"ContentType\":\"audio/mpeg\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}","description":"Returns a URL for which an audio file asset can be uploaded to.
\nThis is the first step in uploading an audio file. Please refer to the implementation guide for more information.
\nRequest Elements
\nRequest Notes
\nResponse Elements
\n","urlObject":{"path":["getpresigneduploadurl","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"fbd60be7-2f84-47c8-a6a3-95cff08363c8","name":"Get Audio File Upload URL (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n\t\"ContentType\":\"audio/mpeg\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:50:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PresignedUploadUrl\": \"https://{domain}/test.mp3?X-Amz-Expires=120&X-Amz-Algorithm=&X-Amz-Credential=&X-Amz-Date=&X-Amz-SignedHeaders=\",\n \"ResourceUrl\": \"https://{domain}/test.mp3\"\n}"},{"id":"b0fc938a-59ad-4f3c-9625-da995f61a0de","name":"Get Audio File Upload URL (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Finalises an asset upload.
\nPlease note that this is the final step in uploading a audio file for searching similar tracks. Prior to performing this you should;
\nCall
\n\nto retreive a pre-signed upload URL
\nPerformed a PUT request to the retreived pre-signed upload URL, with the contentType on the request set to the content type that was provided when retrieving the pre-signed URL - in this case audio/mpeg
\nPerform this API call to finalize that upload has been completed. Failure to call this final step will result in the asset not being available to search with
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["confirmpresignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4369ec36-3844-4b69-9dcb-49dda1797a9a","name":"Confirm Audio File Upload Complete (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ImportAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"AudioExtract\",\r\n\t\"FileName\":\"test.mp3\",\r\n \"ReturnWaveformDatapoints\": false,\r\n\t\"ObjectId\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/confirmpresignedupload/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:51:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"3222a852-f4f7-481a-8882-4d6018f3e5cc","name":"Confirm Audio File Upload Complete (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns similar tracks based an uploaded audio file.
\nAt present, only MP3 and WAV are allowed for upload with Harmix.
\nRefer to the implementation guide for any pre-requisite steps before being able to search - Searching Similar Tracks. An audio file must be uploaded, and finished analysis before it can be used for similarity searching.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\nResponse Notes
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7932b467-9921-4610-b60a-ecd53d7ca407","name":"Search Similar Tracks (By Audio File Upload) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\r\n \"Url\": \"https://{domain}.mp3\",\r\n \"Type\": \"MP3\",\r\n \"Start\": \"0\",\r\n \"Duration\": \"60\" \r\n }]\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Aug 2020 08:36:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 47,\n \"TotalAlbums\": 17,\n \"TotalLibraries\": 10,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"h7076ffb4d82a03n05\",\n \"region\": \"3a62sb6bed741449ob\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"9fae21e2027f3a8bd2431e6gh13108fb2f\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 1,\n \"st_audio\": {\n \"searchtermid\": 1,\n \"audio\": [\n {\n \"url\": \"https://{domain}/test.mp3\",\n \"type\": \"MP3\",\n \"start\": \"0\",\n \"duration\": \"60\" \n }\n ]\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"126\",\n \"LengthSeconds\": \"114\",\n \"Comment\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"Composer\": \"Lior Rosner, Jack Lawrence Starbuck Wilson\",\n \"AlbumID\": \"520a3f8y470e4fa242\",\n \"LibraryID\": \"3d8ae6f5fg5bf0ceb0\",\n \"ID\": \"3i2d46f2e893jf1bik\",\n \"Keywords\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"DisplayTitle\": \"Apex STEM (bass pulse)\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Trailer\",\n \"Bpm\": \"137\",\n \"Version\": \"MAIN\",\n \"CDCode\": \"XRCD076b\",\n \"AlbumName\": \"XRCD076b - Dogma 2 Lethal Bites STEMS\",\n \"LibraryName\": \"X-Ray Dog\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"12\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"5d2fba234a4cg97468\"\n },\n {\n \"ID\": \"9s0dcg777995e2b416\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ]\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"8c23083f-eba5-41c8-a02f-1c77346f7f77","name":"Search Similar Tracks (By Audio File Upload) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by an uploaded audio file requires a number of steps;
\nObtaining a pre-signed audio upload URL. This will allow you to get permission to upload an audio file for analysis to our servers.
\n\nPerform a PUT FILE request to the generated pre-signed URL. This is the act of actually uploading / delivering the audio file to us. This file will be used for analysis purposes
\nConfirm the audio upload completed. By confirming your upload complete, we can provide access to the file for similarity searching
\n\nRequest a similar search. This is the actual request to find similar tracks based on the uploaded file.
\n\nReturns a streaming URL for which an external audio file asset, using a URL.
\nNote this is only usable for specific search similar integrations (e.g. Harmix). Attempting to use this when an integration is not on an account will result in an error code.
\nRequest Elements
\nRequest Notes
\nResponse Elements
\n","urlObject":{"path":["getexternalaudiobyurl","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c474bf40-1b45-436f-a659-f9f6b3233cdc","name":"Get External Audio File (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Url\": \"https://www.youtube.com/watch?v=fV4DiAyExN0xxx\",\r\n \"Type\": \"YouTube\",\r\n \"ReturnWaveformDataPoints\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getexternalaudiobyurl/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 May 2022 06:01:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ResourceUrl\": \"https://{resourceurl}/fv4diayexn0xxx.mp3\",\n \"Asset\": {\n \"MaxDuration\": \"251\",\n \"WaveformDatapoints\": \"{'version':2,'channels':1,'sample_rate':44100,'samples_per_pixel':4428,'bits':8,'length':2495,'data':[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,-6,8,-12,11,-15,14,-21,15,-21,23,-32,27,-34,29,-34,36,-31,33,-47,39,-36,39,-45,37,-36,45,-44,50,-50,53,-51,46,-52,53,-50,46,-52,48,-50,49,-47,42,-49,52,-43,50,-41,42,-36,39,-34,32,-31,31,-32,27,-32,29,-23,26,-33,28,-29,29,-26,24,-29,32,-27,29,-33,33,-26,25,-28,24,-23,24,-24,27,-31,26,-20,23,-23,22,-33,28,-22,24,-23,27,-31,28,-24,29,-20,22,-19,19,-22,21,-25,25,-19,19,-23,24,-50,34,-18,29,-23,20,-19,18,-22,28,-23,17,-30,20,-14,15,-44,31,-20,22,-28,28,-22,15,-16,22,-19,21,-19,24,-18,25,-23,19,-19,20,-21,22,-23,20,-20,22,-14,17,-22,16,-13,14,-14,15,-18,16,-19,20,-13,15,-18,15,-15,13,-17,17,-15,16,-14,23,-14,20,-21,19,-23,16,-21,18,-21,20,-20,17,-24,21,-24,19,-25,18,-17,24,-24,21,-18,17,-17,20,-19,23,-24,23,-33,27,-49,71,-94,108,-108,121,-111,121,-120,123,-101,116,-103,107,-100,120,-105,109,-101,109,-117,127,-127,127,-123,125,-126,122,-118,121,-108,122,-112,117,-123,127,-112,127,-94,88,-49,58,-45,36,-71,67,-118,120,-25,26,-31,28,-18,18,-23,17,-19,16,-91,67,-107,...]}\"\n }\n}"},{"id":"84ebd4a2-67eb-4086-a3a8-6aec6b915b73","name":"Get External Audio File (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns similar tracks based on a music URL.
\nPresently YouTube, Spotify, SoundCloud and Vimeo is supported by Harmix.
\nRefer to the implementation guide for any pre-requisite steps before being able to search - Searching Similar Tracks. An URL must finish analysis before it can be used for similarity searching.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\nResponse Notes
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"57582bc3-46fb-4347-976b-f1b3addf7fcd","name":"Search Similar Tracks (By YouTube URL) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\":[{\r\n \"Url\": \"https://www.youtube.com/watch?v={id}\",\r\n \"Type\": \"Youtube\",\r\n \"Start\": \"20\",\r\n \"Duration\": \"40\"\r\n }]\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Aug 2020 08:36:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 47,\n \"TotalAlbums\": 17,\n \"TotalLibraries\": 10,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"h7076ffb4d82a03n05\",\n \"region\": \"3a62sb6bed741449ob\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"9fae21e2027f3a8bd2431e6gh13108fb2f\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 1,\n \"st_audio\": {\n \"searchtermid\": 1,\n \"audio\": [\n {\n \"url\": \"https://www.youtube.com/watch?v={id}\",\n \"type\": \"YouTube\",\n \"start\": \"20\",\n \"duration\": \"40\"\n }\n ]\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"126\",\n \"LengthSeconds\": \"114\",\n \"Comment\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"Composer\": \"Lior Rosner, Jack Lawrence Starbuck Wilson\",\n \"AlbumID\": \"520a3f8y470e4fa242\",\n \"LibraryID\": \"3d8ae6f5fg5bf0ceb0\",\n \"ID\": \"3i2d46f2e893jf1bik\",\n \"Keywords\": \"Dramatic, Suspense, Electronic, Uplifting, Minimalistic, Underscore, Pulsing, Sci-Fi, Bass\",\n \"DisplayTitle\": \"Apex STEM (bass pulse)\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Trailer\",\n \"Bpm\": \"137\",\n \"Version\": \"MAIN\",\n \"CDCode\": \"XRCD076b\",\n \"AlbumName\": \"XRCD076b - Dogma 2 Lethal Bites STEMS\",\n \"LibraryName\": \"X-Ray Dog\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"12\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"5d2fba234a4cg97468\"\n },\n {\n \"ID\": \"9s0dcg777995e2b416\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"386bea52-06c3-4ef4-894b-8df369165003","name":"Search Similar Tracks (By YouTube URL) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by a URL requires a single step;
\nThis step is not required, however if you would like to retrieve the external audio file from the URL for in-site sampling then you can request the external audio file and datapoints
\nRequest a similar search by URL. It should be noted that the following URL types are supported; YouTube, Spotify, Vimeo and SoundCloud.
\nSee
\n\nReturns similar tracks based on a prompt / free-text.
\nRequest Elements
\nRequest Notes: SearchTermBundle > St_Audio
\nRequest Notes: ResultView
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"fdf6d6a5-e363-47c4-a899-11bfe448023b","name":"Search Similar Tracks (By Free Text) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SearchFilters\": {\r\n \"SearchTermBundle\": {\r\n \"St_Audio\": {\r\n \"Audio\": [\r\n {\r\n \"Prompt\": \"Waves hitting the beach\"\r\n }\r\n ],\r\n \"Start\": \"\",\r\n \"Duration\": \"\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Evoke_PrioritizeBPM\": false,\r\n \"Evoke_SuppressVocals\": false,\r\n \"Skip\": \"0\",\r\n \"Limit\": \"1\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 17 Sep 2019 06:35:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2125"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalTracks\": 13,\n \"TotalAlbums\": 1,\n \"TotalLibraries\": 1,\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"oa4ja92abe12bp2922\",\n \"region\": \"3a6pqf6be7413d498b\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"EvokeRanking\",\n \"evoke_includeseed\": true,\n \"rankexpression\": \"\",\n \"skip\": 0,\n \"limit\": 1,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0\n },\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 11676448,\n \"st_audio\": {\n \"prompt\": \"Waves hitting the beach\",\n \"start\": \"\",\n \"duration\": \"\"\n }\n }\n ]\n },\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"LengthSeconds\": \"219\",\n \"Comment\": \"Emotive guitar mood / glitzy and dreamy\",\n \"Composer\": \"Sergey Kolosov\",\n \"AlbumID\": \"qf2bcl77hqf73359ec\",\n \"LibraryID\": \"7ga24341da8f8915b1\",\n \"ID\": \"a30634aem432346072\",\n \"DisplayTitle\": \"Starfish\",\n \"alternatetitle\": \"\",\n \"Genre\": \"indie, rock, rock 'n' roll, promo\",\n \"Bpm\": \"103\",\n \"Version\": \"Main\",\n \"CDCode\": \"ALT 001\",\n \"AlbumName\": \"ALT 001 Indie Star Anthems\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"5\",\n \"RightHolderIDs\": [\n {\n \"ID\": \"a660d506e12f7c7ckf\"\n }\n ],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"EvokeSegments\": [\n {\n \"Length\": 20,\n \"Start\": 10.752,\n \"Score\": 0.0\n },\n {\n \"Length\": 17,\n \"Start\": 54.784,\n \"Score\": 0.0\n }\n ],\n }\n ],\n \"Facets\": {},\n \"UseDatabase\": false\n}"},{"id":"3f57d579-3bf2-4f61-a94f-c84e1a905902","name":"Search Similar Tracks (By Free Text) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Searching by Prompt, allows you to provide a sentence or prompt and receive similar tracks based off that;
\n\n","_postman_id":"03c9b10f-0037-4908-9afe-178eb7d66a1a"}],"id":"77404d00-58f0-4049-a781-15b4fe8c21cd","_postman_id":"77404d00-58f0-4049-a781-15b4fe8c21cd","description":""}],"id":"58d1b76b-62dd-41c1-b261-88d5191e85c9","_postman_id":"58d1b76b-62dd-41c1-b261-88d5191e85c9","description":""}],"id":"e01f2384-7e6c-4409-adad-8848d0c8075e","_postman_id":"e01f2384-7e6c-4409-adad-8848d0c8075e","description":""},{"name":"Member Management","item":[{"name":"Registration","item":[{"name":"Implementation Guide Members","id":"92713dec-4819-47e2-a382-d11136a38581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"The Persistent Login functionality allows you to add a \"Remember Me\" option on the member login form. Persistent Login is independent of the application session settings and is more secure (and user-friendly) than simply setting a long application session lifetime.
\nThe administrator can control how long member logins are remembered, before a member will have to enter their credentials again.
\nIn the future, we provide additional security by attempting to detect unauthorized re-use of tokens.
\nNever pre-populate your login form with password. If Google wants to auto complete this then let it but never code your applications to do this.
\nThe following operations use a RequestMember object to receive data into the API and a ResponseMember object to return data out of the API. The table below indicates the fields and properties included in each:
\n\"login token\" cookie is set to expire at a configured time, use the UTCoffset to store the correct time in the cookie.
\n\"username\" cookie doesn't need an expiry as it can be used if \"login token\" expires
\nStreaming URL patterns that are required to access assets for members.
\nMember AssetURLs can be found in the getMember method response for both for guest and logged in members.
\nThe Asset URL contains parameters which are required to access the specified asset. Replace the parameters in the URL as required before requesting the resource.
\nRequest Elements
\nA members username and password will never be provided directly to them via an email. As such, the user will never be reminded of their current password but will instead be provided with the means to reset it via an email. This email will contain a link with a single-use reset token. The token itself will also have an expiration that can be defined during the request of the reset password email.
\nThere are three steps to implementing this;
\nRegisters a new member.
\nThis method will return an error if the request data is not valid or the member already exists based on email address uniqueness.
\nUpon a successful registration, the API will send email notifications to the Member and Administrator according to settings configured within the account.
\nDefault file format can be set using the fileformat property. Please use the trackformat identifier which can be located in Filefomats.
It is also possible to define a file format for each type (WAV, MP3, AIFF) in the fileformats element, however do not attempt to add more than one memberfileformat for each type.
Request Elements
\nRequest Notes
\nThese parameters will be shared between “first search” and “search within results”.
\n","urlObject":{"path":["registermember","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"56c02e3e-b4e9-4383-8d1d-b9b6ee4c534c","name":"Register Member (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"MemberAccount\":{\r\n\t\t\"FirstName\":\"First\",\r\n\t\t\"LastName\":\"Last\",\r\n\t\t\"Email\":\"first.last@company.net\",\r\n\t\t\"Company\":\"Company\",\r\n\t\t\"Production\":\"Production\",\r\n \"SubProduction\":\"Sub Production\",\r\n\t\t\"Position\":\"Position\",\r\n\t\t\"Address1\":\"Address Line 1\",\r\n\t\t\"Address2\":\"Address Line 2\",\r\n\t\t\"Suburb\":\"Suburb\",\r\n\t\t\"State\":\"State\",\r\n\t\t\"Postcode\":\"Postcode\",\r\n\t\t\"Country\":\"AU\",\r\n\t\t\"Phone\":\"Phone\",\r\n\t\t\"Username\":\"Username\",\r\n\t\t\"Password\":\"Password\",\r\n\t\t\"TermsAccept\":\"true\",\r\n\t\t\"PrivacyAccept\":\"true\",\r\n\t\t\"Subscribe\":\"true\",\r\n\t\t\"FileFormat\":\"mp3\",\r\n\t\t\"SearchFormat\":\"Track\",\r\n\t\t\"SearchSort\":\"New\",\r\n \"Attributes\": [],\r\n\t\t\"ExternalMemberID\": \"\",\r\n\t\t\"ExternalVerifyToken\": \"\",\r\n \"Freelancer\": \"true\",\r\n \"PositionType\": \"Position Type\"\r\n\t},\r\n\t\"NoMemberEmail\":false,\r\n \"VerifierEmail\": \"\",\r\n \"RegistrationCode\": \"\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/registermember/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 20:43:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"MemberAccount\": {\n \"ID\": \"6bd9980321f1234a\",\n \"FirstName\": \"First\",\n \"LastName\": \"Last\",\n \"Email\": \"first.last@company.net\",\n \"Company\": \"Company\",\n \"Production\": \"Production\",\n \"SubProduction\": \"Sub Production\",\n \"Position\": \"Position\",\n \"Address1\": \"Address Line 1\",\n \"Address2\": \"Address Line 2\",\n \"Suburb\": \"Suburb\",\n \"State\": \"State\",\n \"Postcode\": \"Postcode\",\n \"Country\": \"AU\",\n \"Phone\": \"Phone\",\n \"Username\": \"Username\",\n \"TermsAccept\": \"true\",\n \"Subscribe\": \"true\",\n \"FileFormat\": \"19b8f5935123abcd\",\n \"SearchFormat\": \"track\",\n \"SearchSort\": \"fav\",\n \"SampleEnabled\": \"true\",\n \"Status\": \"pending\",\n \"RegionID\": \"88f6543e732f1234\",\n \"ServiceInfoURLs\": {\n \"DirectDownloadURL\": \"https://dl.harvestmedia.net/assets/downloads/{downloadtoken}\",\n \"TrackStreamURL\": \"https://abcdefghjk.cloudfront.net/assets/samples/123459a832ceb64d32f261c763d4f63224412345/{id}\",\n \"ProfileImageURL\": \"https://abcdefghjk.cloudfront.net/assets/memberprofile/123459a832ceb64d32f261c763d4f632244qwert/{id}/{width}/{height}\",\n \"AlbumMontageSampleURL\": \"https://abcdefghjk.cloudfront.net/assets/samples/montage/123459a832ceb64d32f261c763d4f632244qwert/{id}\",\n \"AlbumArtURL\": \"https://abcdefghjk.cloudfront.net/assets/albumart/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"WaveformURL\": \"https://abcdefghjk.cloudfront.net/assets/waveforms/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"MontageWaveformURL\": \"https://abcdefghjk.cloudfront.net/assets/waveforms/montage/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"LibraryLogoUrl\": \"https://abcdefghjk.cloudfront.net/assets/librarylogo/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"PlaylistArtUrl\": \"https://abcdefghjk.cloudfront.net/assets/playlistart/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"PlaylistCategoryArtUrl\": \"https://abcdefghjk.cloudfront.net/assets/playlistcategoryart/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"RightHolderProfileUrl\": \"https://abcdefghjk.cloudfront.net/assets/rightholderprofile/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"WaveformDataPointUrl\": \"https://abcdefghjk.cloudfront.net/assets/waveform_data/123459a832ceb64d32f261c763d4f632244qwert/{id}/{dataformat}\",\n \"StyleArtUrl\": \"https://abcdefghjk.cloudfront.net/assets/styleart/widfubwpiuqbfie32764jdhwfbsoliw32788/{id}/{width}/{height}\",\n \"MemberGroupLogoUrl\": \"https://abcdefghjk.cloudfront.net/assets/membergrouplogo/123459a832ceb64d32f261c763d4f632244qwert/{id}/{width}/{height}\",\n \"MemberGroupArtUrl\": \"https://abcdefghjk.cloudfront.net/assets/membergroupart/123459a832ceb64d32f261c763d4f632244qwert/{id}/{width}/{height}\",\n \"MemberGroupProductionArtUrl\": \"https://abcdefghjk.cloudfront.net/assets/membergroupproductionart/123459a832ceb64d32f261c763d4f632244qwert/{id}/{width}/{height}\"\n },\n \"LanguageCode\": \"EN\",\n \"Salutation\": \"\",\n \"MemberTypeID\": \"\",\n \"FileFormats\": [\n {\n \"ID\": \"d0b8ba294711234bf\",\n \"FileExtension\": \"wav\",\n \"BitRate\": 1411200,\n \"SampleRate\": 44.1,\n \"SampleSize\": 16,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": true\n },\n {\n \"ID\": \"bce3cac31bcb1234\",\n \"FileExtension\": \"aif\",\n \"BitRate\": 1411200,\n \"SampleRate\": 44.1,\n \"SampleSize\": 16,\n \"Isdefaultdownload\": true,\n \"isdefaultdownloadfortype\": true\n },\n {\n \"ID\": \"a949ea2c90c123e2\",\n \"FileExtension\": \"mp3\",\n \"BitRate\": 128000,\n \"SampleRate\": 48,\n \"SampleSize\": 0,\n \"Isdefaultdownload\": false,\n \"isdefaultdownloadfortype\": true\n }\n ],\n \"HasProfileImage\": false,\n \"PrivacyAccept\": \"true\",\n \"DownloadEnabled\": \"true\",\n \"DownloadsRemaining\": \"0\",\n \"DownloadEnabledType\": \"MemberGroup\",\n \"DownloadLimit\": \"0\",\n \"DownloadsUsed\": \"0\",\n \"DownloadStem\": true,\n \"MemberGroups\": [\n {\n \"ID\": \"d93b07e20008a123\",\n \"Name\": \"Test Group\",\n \"AssignedRegionID\": \"88f8791e732f12e3\",\n \"AssignedRegionChangeEnabled\": false,\n \"Type\": \"Primary\",\n \"ProductionsCount\": 0,\n \"ProductionsTitle\": \"\",\n \"HasLogoArtWork\": false,\n \"HasArtWork\": false,\n \"HasSearchRankExpression\": false\n }\n ],\n \"PositionType\": \"Position Type\",\n \"Freelancer\": \"true\",\n \"ManagedBy\": {\n \"Name\": \"\",\n \"Email\": \"\",\n \"Phone\": \"\"\n },\n \"Attributes\": []\n },\n \"MemberChannels\": []\n}"},{"id":"3a8cb283-e0ef-444a-afcf-3043ada3f465","name":"Register Member (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Accept","value":"application/xml-dtd"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"This method should be used to validate whether a username is available or not.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nThere are two possible responses;
\nOK\nThis method should be used to validate whether a email address is available or not.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nThere are two possible responses;
\nOK\nSend a verify member email to the provided email address. An email will be sent if the email address belongs to a member on the account. This email will contain a link that the member will click on in order to verify their account. Once verified, their account is moved to the Approved status and at that point has full member permissions (login, download, etc).
\nPlease note that this is intended for members whom are in a pending state. Members who are already approved will not benefit from this method.
\nWill return an error response if the email address does not exist or is not valid.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["sendmemberverifylinkemail","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"72fdc342-6900-481a-a4be-0f6873b2351d","name":"Send Verify Member Link Email (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Email\":\"first.last@company.net\",\r\n \"ExternalVerifyToken\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendmemberverifylinkemail/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Oct 2020 06:35:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"f27803af-4d31-43a1-9f06-786b95c6e599","name":"Send Verify Member Link Email (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nThis method should be used to validate a member verification token.
\nRequest Elements
\nResponse Notes
\nA successful response means that the token is valid and available for use in verifying a member. A failed response could either indicate that the token has already been used or that it has since expired. Both failed scenarios will require that the user regenerate a new token via the \"Send Verify Member Link Email\" process.
\n","urlObject":{"path":["validateverifymembertoken","{{HM_ServiceAPI_Token}}","{VerifyMemberToken}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d87fd72b-60ad-4785-ab36-a3958bff3af3","name":"Validate Verify Member Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/validateverifymembertoken/{{HM_ServiceAPI_Token}}/9c44b914d14eacff0c18bhaf76b0b23276193d4abe207492bac18bfcd3be00e185"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 28 Oct 2020 04:51:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Token\": {\n \"Value\": \"9c44b914d14eacff0c18bhaf76b0b23276193d4abe207492bac18bfcd3be00e185\",\n \"Expiry\": \"9999-12-31T23:59:59.9999999\",\n \"UTCOffset\": 11,\n \"IsOfSingleUse\": false\n }\n}"},{"id":"dd66fd7b-9fc0-4fa3-aba0-7691b5350ed7","name":"Validate Verify Member Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json","disabled":true},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/validateverifymembertoken/{{HM_ServiceAPI_Token}}/9c44b914d14eacff0c18bhaf76b0b23276193d4abe207492bac18bfcd3be00e185"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 28 Oct 2020 04:51:42 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nActivate a member who had previously registered by needed to be verified by email first. Returns an error message/code if the Token is invalid.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["verifymember","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"176831f3-5871-4dc0-9c7c-c4eea38ff164","name":"Verify Member (POST) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Token\":\"46dh91db279b64a1b10ac1b43f45a2d127fca6c78fc84ed1ef130cha40f12j3973\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/verifymember/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Mar 2021 03:30:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"e1db1ba4-b673-4e5b-9f01-dac3d7d43369","name":"Verify Member (POST) (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nThe following method should be used for member login.
\nIt will return a member token as well as a persistent login token if requested by passing \"PersistentLogin\": true in the request body.
The persistent login token can be saved to member's cookie for reuse in future site accesses.
\nRequest Elements
\nA temporary password can be set up for a user via the Harvest Admin.
\nWhen a user is in this state, the following can be observed.
\n{\n \"MemberToken\": {\n \"Value\": \"9abc1ca21c3c987d31b520fb0b5f1234\",\n \"Expiry\": \"2024-12-12T08:11:07.4\",\n \"UTCOffset\": 11.0,\n \"TemporaryPassword\": \"true\",\n \"Type\": \"MemberToken\",\n \"IsOfSingleUse\": false\n },\n ...\n\nNotice the TemporaryPassword property here.
This property will only appear if the user is using a temporary password.
You can use this property on login to determine whether to show the user the “set a new password for your account” modal.
\n","urlObject":{"path":["getmembertoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e64bd068-c9af-491f-a59d-8bc966875574","name":"Authenticate Member & Generate Persistent Member Token (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"UserName\":\"UserName\",\r\n\t\"Password\":\"Password\",\r\n\t\"PersistentLogin\":true,\r\n\t\"ReturnMemberDetails\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getmembertoken/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 04:29:52 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"298"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Token\": {\n \"Value\": \"2f30cde70021a012fc1f575w3471eam7\",\n \"Expiry\": \"2019-08-21T14:29:38\",\n \"UTCOffset\": 10,\n \"Type\": \"MemberToken\",\n \"IsOfSingleUse\": false\n },\n \"PersistentLoginToken\": {\n \"Value\": \"2f30cde70021a012fc1f575w3471eam7\",\n \"Expiry\": \"2019-08-21T14:29:38\",\n \"UTCOffset\": 10,\n }\n}"},{"id":"be79a6cd-2743-4045-948d-07cc7a135eea","name":"Authenticate Member & Generate Persistent Member Token (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"This operation will return the details of the member token, notably the expiry date and the creation date.
\nDate format will be UTC+10 or UTC+11 and shown as YYYY-MM-DDTHH:MM:SS:SSS.
\nReturns Member Token details which include:
\nRequest Elements
\n","urlObject":{"path":["getservicetokeninfo","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d547bcbf-5f61-41ee-a3bb-7ce411ea619d","name":"Validate Member Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getservicetokeninfo/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Thu, 08 Aug 2019 01:42:43 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"343"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis operation will expire the provided Member Token immediately.
\nAny subsequent calls to the API using the provided Member Token will result in an error response.
\nRequest Elements
\n","urlObject":{"path":["expiretoken","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8f431737-4590-45fa-bcfe-698129626916","name":"Expire Member Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/expiretoken/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 02:02:42 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nThis method should be used to check the login token if the persistent token is found in the user cookie.
\nThe renewexpiry & generatememberToken need to be set to true to generate another member token as well as refresh the persistent login token expiry.
Request elements
\n","urlObject":{"path":["validatepersistentlogintoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"83338d6c-827e-4146-a713-3a69cf4dab30","name":"Validate Persistent Member Token (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"This method should be called if a member logouts. It will expire the persistent login token.
\nNote: If a member or administrator changes a password, all related persistent login tokens will expire automatically.
\nRequest Elements
\n","urlObject":{"path":["expirepersistentlogintoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cb8e7545-bf14-44e6-8f9e-76975e9f7fe2","name":"Expire Persistent Member Token (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"OK\nReturns a SingleSignOnToken. Returns an error message/code if the token provided is not a MemberToken or if the MemberToken is invalid.
\nThe Member Token cannot be a guest member token. It must be the Member Token of an authenticated member
\nRequest Elements
\n","urlObject":{"path":["getssotoken","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cf0c0d0c-17db-4dfd-88c7-da8383e79b74","name":"Get Single Sign-on Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getssotoken/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Aug 2021 04:58:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Token\": {\n \"Value\": \"4ef47f971858745c48ef4858b88dbde6cb\",\n \"Expiry\": \"2021-11-09T14:58:56.227\",\n \"UTCOffset\": 10,\n \"Type\": \"SSOToken\",\n \"IsOfSingleUse\": true,\n \"ForcePasswordReset\": false\n }\n}"},{"id":"3d5adfe7-e47f-4e45-ae29-8e150643ce01","name":"Get Single Sign-on Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getssotoken/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 11 Aug 2021 04:59:47 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nThis method should be used to validate & consume the Single Sign-on Token.
\nRequest elements
\nRequest Notes
\n","urlObject":{"path":["validatessotoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0c458d6d-bd6e-4d83-8ea7-dd2ddd5776bb","name":"Validate Single Sign-on Token (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Token\":\"4ef47f971858745c48ef4858b88dbde6cb\",\r\n\t\"GenerateMemberToken\":true,\r\n\t\"ReturnMemberDetails\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/validatessotoken/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Aug 2021 05:22:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"MemberToken\": {\n \"Value\": \"3f4949db634c1b14b1a329471e78a03b99\",\n \"Expiry\": \"2021-08-12T15:22:08.2\",\n \"UTCOffset\": 10,\n \"Type\": \"MemberToken\",\n \"IsOfSingleUse\": false,\n \"ForcePasswordReset\": false\n },\n \"SSOToken\": {\n \"Token\": \"4ef47f971858745c48ef4858b88dbde6cb\",\n \"Expiry\": \"2021-11-09T15:09:27.72\",\n \"UTCOffset\": 10\n },\n \"MemberAccount\": {\n \"HasProfileImage\": false,\n \"DownloadEnabledType\": \"Member\"\n }\n}"},{"id":"2578f265-71af-40d5-bdce-496d79cf8968","name":"Validate Single Sign-on Token (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Returns the member details if a valid MemberToken is provided. Returns an error message/code if the MemberToken is invalid.
\nMember tokens can retrieved via either:
\nRequest Elements
\n","urlObject":{"path":["getmember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"fa75423a-e711-4d70-a59a-1229d3af9cf2","name":"Get Member Details (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmember/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 06:02:42 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"3803"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Member\": {\n \"ID\": \"z7fa7d1f4d30g6d1ab\",\n \"AccessID\": \"5a03ae02b048b3dbab731b29f7e4ab54484e1b29ec218d83\",\n \"FirstName\": \"First\",\n \"LastName\": \"Last\",\n \"Email\": \"first.last@company.net\",\n \"Company\": \"HarvestCompany\",\n \"Production\": \"Production\",\n \"SubProduction\": \"Sub Production\",\n \"Position\": \"Position\",\n \"Address1\": \"Address Line 1\",\n \"Address2\": \"Address Line 2\",\n \"Suburb\": \"Suburb\",\n \"State\": \"State\",\n \"Postcode\": \"Postcode\",\n \"Country\": \"AU\",\n \"Phone\": \"Phone\",\n \"Username\": \"Username\",\n \"TermsAccept\": \"true\",\n \"PrivacyAccept\": \"true\",\n \"Subscribe\": \"false\",\n \"FileFormat\": \"0cd2dbhf8c4cd66e21\",\n \"SearchFormat\": \"track\",\n \"SearchSort\": \"fav\",\n \"SampleEnabled\": \"true\",\n \"DownloadEnabled\": \"false\",\n \"DownloadEnabledType\": \"Member\",\n \"DownloadLimit\": \"\",\n \"DownloadsUsed\": \"\",\n \"DownloadsRemaining\": \"\",\n \"DownloadStem\": false,\n \"MemberGroups\": [],\n \"Status\": \"active\",\n \"RegionID\": \"betcc9d0555atb0r83\",\n \"PasswordType\": \"cleartext\",\n \"ServiceInfoURLs\": {\n \"DirectDownloadURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/downloads/{downloadtoken}\",\n \"TrackStreamURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/21adae2ca240224eh484f1572592fa27678we397cb/{id}\",\n \"ProfileImageURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/memberprofile/21adae2ca240224eh484f1572592fa27678we397cb/{id}/{width}/{height}\",\n \"AlbumMontageDownloadURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/montage/21adae2ca240224eh484f1572592fa27678we397cb/{id}\",\n \"AlbumArtURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/albumart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"WaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MontageWaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/montage/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"LibraryLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/librarylogo/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"PlaylistArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"PlaylistCategoryArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistcategoryart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"RightHolderProfileUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/rightholderprofile/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"WaveformDataPointUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveform_data/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{samplesperpixel}/{dataformat}\",\n \"StyleArtUrl\": \"https://elb-beta.harvestmedia.net/assets/styleart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MemberGroupLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergrouplogo/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MemberGroupArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MemberGroupProductionArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupproductionart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\"\n },\n \"FileFormats\": [\n {\n \"ID\": \"07a14f7a3be91ffff1\"\n },\n {\n \"ID\": \"47jec14817133v69m9\"\n },\n {\n \"ID\": \"4c3ddcd36de8eef645\"\n }\n ],\n \"HasProfileImage\": false,\n \"PositionType\": \"Manager\",\n \"Freelancer\": \"false\",\n \"ManagedBy\": {\n \"Name\": \"John Doe\",\n \"Email\": \"John.Doe@company.net\",\n \"Phone\": \"\"\n },\n \"Attributes\": []\n }\n}"},{"id":"2ccb2692-0227-44fb-884d-aebfddb83c11","name":"Get Member Details (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmember/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Tue, 20 Aug 2019 06:07:04 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"3089"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a temporary MemberToken for member with the associated email address. If no member exists with that email address a temporary member is created with it.
\nReturns an error message/code if the MemberToken is invalid.
\nRequest elements
\nRequest Notes
\n","urlObject":{"path":["getinvitedmembertoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"99cb2f34-b0fb-40fa-a58c-66a9eea4d858","name":"Get Member Details (Invited) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Updates an existing member account.
\nWill return an error if the request data is not valid.
\nUpon a successful update, no email notifications will be sent to the Member or Administrator.
\nRequest Elements
\nRequest Notes
\nThese parameters will be shared between “first search” and “search within results”.
\n","urlObject":{"path":["updatemember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c3dfe95e-8cd5-46c8-8e76-f6b99b8aabb7","name":"Update Member (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"MemberAccount\":{\r\n\t\t\"ID\":\"z7fa7d1f4d30g6d1ab\",\r\n\t\t\"FirstName\":\"First\",\r\n\t\t\"LastName\":\"Last\",\r\n\t\t\"Email\":\"first.last@company.net\",\r\n\t\t\"Company\":\"Company\",\r\n\t\t\"Production\":\"Production\",\r\n \"SubProduction\":\"Sub Production\",\r\n\t\t\"Position\":\"Position\",\r\n\t\t\"Address1\":\"Address Line 1\",\r\n\t\t\"Address2\":\"Address Line 2\",\r\n\t\t\"Suburb\":\"Suburb\",\r\n\t\t\"State\":\"State\",\r\n\t\t\"Postcode\":\"Postcode\",\r\n\t\t\"Country\":\"AU\",\r\n\t\t\"Phone\":\"Phone\",\r\n\t\t\"Username\":\"Username\",\r\n\t\t\"Password\":\"Password\",\r\n\t\t\"TermsAccept\":\"true\",\r\n\t\t\"PrivacyAccept\":\"true\",\r\n\t\t\"Subscribe\":\"true\",\r\n \"Locked\":\"\",\r\n \"LockedType\":\"\",\r\n\t\t\"FileFormat\":\"0cd2dbhf8c4cd66e21\",\r\n\t\t\"SearchFormat\":\"Track\",\r\n\t\t\"SearchSort\":\"New\",\r\n \"Attributes\": [],\r\n\t\t\"Status\":\"Active\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemember/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 05:53:02 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"3651"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"MemberAccount\": {\n \"ID\": \"z7fa7d1f4d30g6d1ab\",\n \"FirstName\": \"First\",\n \"LastName\": \"Last\",\n \"Email\": \"first.last@company.net\",\n \"Company\": \"HarvestCompany\",\n \"Production\": \"Production\",\n \"SubProduction\": \"SubProduction\",\n \"Position\": \"Position\",\n \"Address1\": \"Address Line 1\",\n \"Address2\": \"Address Line 2\",\n \"Suburb\": \"Suburb\",\n \"State\": \"State\",\n \"Postcode\": \"Postcode\",\n \"Country\": \"AU\",\n \"Phone\": \"Phone\",\n \"Username\": \"Username\",\n \"TermsAccept\": \"true\",\n \"PrivacyAccept\": \"true\",\n \"Subscribe\": \"false\",\n \"FileFormat\": \"0cd2dbhf8c4cd66e21\",\n \"SearchFormat\": \"track\",\n \"SearchSort\": \"fav\",\n \"SampleEnabled\": \"true\",\n \"DownloadEnabled\": \"false\",\n \"DownloadEnabledType\": \"Member\",\n \"DownloadLimit\": \"\",\n \"DownloadsUsed\": \"\",\n \"DownloadsRemaining\": \"\",\n \"DownloadStem\": false,\n \"MemberGroups\": [],\n \"Status\": \"active\",\n \"RegionID\": \"betcc9d0555atb0r83\",\n \"ServiceInfoURLs\": {\n \"DirectDownloadURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/downloads/{downloadtoken}\",\n \"TrackStreamURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/21adae2ca240224eh484f1572592fa27678we397cb/{id}\",\n \"ProfileImageURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/memberprofile/21adae2ca240224eh484f1572592fa27678we397cb/{id}/{width}/{height}\",\n \"AlbumMontageDownloadURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/montage/21adae2ca240224eh484f1572592fa27678we397cb/{id}\",\n \"AlbumArtURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/albumart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"WaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MontageWaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/montage/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"LibraryLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/librarylogo/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"PlaylistArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"PlaylistCategoryArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistcategoryart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"RightHolderProfileUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/rightholderprofile/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"WaveformDataPointUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveform_data/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{samplesperpixel}/{dataformat}\",\n \"StyleArtUrl\": \"https://elb-beta.harvestmedia.net/assets/styleart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MemberGroupLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergrouplogo/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MemberGroupArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\",\n \"MemberGroupProductionArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupproductionart/d3s22e900704dd54450c48d660e0b6cu5da89072e3/{id}/{width}/{height}\"\n },\n \"LanguageCode\": \"\",\n \"Salutation\": \"\",\n \"MemberTypeID\": \"\",\n \"FileFormats\": [],\n \"HasProfileImage\": false,\n \"Attributes\": []\n }\n}"},{"id":"b6687858-b30f-4109-b753-45e885dca67f","name":"Update Member (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns a URL for which an asset file can be uploaded to.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getpresigneduploadurl","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f6d3a448-22b6-4551-8e56-18b5c51eed90","name":"Get Member Image Upload URL (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"MemberProfileImage\",\r\n\t\"FileName\":\"test.jpg\",\r\n\t\"ContentType\":\"image/jpeg\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:50:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PresignedUploadUrl\": \"https://{domain}/test.jpg?X-Amz-Expires=120&X-Amz-Algorithm=&X-Amz-Credential=&X-Amz-Date=&X-Amz-SignedHeaders=\",\n \"ResourceUrl\": \"https://{domain}/test.jpg\"\n}"},{"id":"a25067e6-1400-4142-8c73-f5a4c3fd4caa","name":"Get Member Image Upload URL (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Finalises an asset upload.
\nPlease note that this is the final step in uploading a member image. Prior to performing this you should;
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["confirmpresignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"07621ed2-1c29-4c39-9abc-13aa5d1045c5","name":"Confirm Member Image Upload Complete (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Removes a previously uploaded asset from the member profile.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["removeassignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c32eec7c-2b91-4fb1-aa63-eb03186deba1","name":"Remove Member Image (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ImportAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"MemberProfileImage\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/removeassignedupload/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:51:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"b0952ed9-3300-4b02-89ce-a2c51401febf","name":"Remove Member Image (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Removes the member if a valid MemberToken is provided. Returns an error message/code if the MemberToken is invalid.
\nRequest Elements
\n","urlObject":{"path":["removemember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"85ab393a-ca35-4aca-9531-5f1342c1f151","name":"Remove Member (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removemember/90341d29147bd70b0dd31407d9t55e15aa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 31 Mar 2021 04:33:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"074a6501-6561-49c2-924f-5b28e458ba91","name":"Remove Member (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removemember/90341d29147bd70b0dd31407d9t55e15aa"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 31 Mar 2021 04:34:52 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nOK\nSend a reset password email to the stored email address if either the request username or email address is valid for the account. This email will contain a link to reset the users password.
\nWill return an error response if the username or email address does not exist or is not valid.
\nRequest Elements
\nRequest Notes
\nThe reset password email will contain the link as defined in the request parameter \"ResetLink\". You should set this to be the path to your reset password page. Note as well that the reset link will contain a single-use token that will later be used to validate and ultimately perform a reset of the member's password. That token will also have an expiration date attached to it, and it is possible to define that date by using the \"ResetTokenExpiryHours\" parameter.
\n","urlObject":{"path":["sendpasswordresetemail","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"747717e6-f335-4ea1-87d7-c3e702b5eb09","name":"Send Reset Password Email (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"Username\":\"\",\r\n\t\"Email\":\"email@yourdomain.com\",\r\n\t\"ExternalResetToken\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendpasswordresetemail/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 06:32:50 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"6b4d3c46-9b1a-44df-b094-bcd4255dc4d2","name":"Send Reset Password Email (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nThis method should be used to validate a member reset password token.
\nRequest Elements
\nResponse Notes
\nA successful response means that the token is valid and available for use in resetting a members password. A failed response could either indicate that the token has already been used or that it has since expired. Both failed scenarios will require that the user regenerate a new token via the Send Reset Password Email process.
\n","urlObject":{"path":["validatepasswordresettoken","{{HM_ServiceAPI_Token}}","{ResetToken}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"74393e29-39ba-46ad-a4bd-b1a42a361a84","name":"Validate Reset Password Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/validatepasswordresettoken/{{HM_ServiceAPI_Token}}/ecba8050518298555653376c3e3d21j202"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Tue, 10 Sep 2019 02:05:30 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"300"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis method should be used to reset a members password using a password reset token.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nA successful response means that the token was valid and the members password has been reset. A failed response could either indicate that the token had already been used or that it had since expired. Both scenarios will require that the user regenerate a new token via the \"Send Reset Password Email\" process.
\n","urlObject":{"path":["updatepasswordusingtoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b67cb15e-c580-45d9-8352-1b121a9ecf99","name":"Update Member Password (Reset) (POST) (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"OK\nManage the subscriber flag on a member. Returns an error message/code if the MemberToken is invalid.
\nTo subscribe guest members please use the guest membertoken.
\nRequest Elements
\nRequest Notes
\nEmail is mandatory.
\nEither firstname or last name must be present.
\n","urlObject":{"path":["membersubscribe","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"540338ee-a9bb-45f8-a679-bb71d33120b2","name":"Subscribe Member (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"OK\nThis method should be used to validate a member group member approval verification token.
\nRequest Elements
\nResponse Notes
\nA successful response means that the token is valid and available for use in approving or decling a member into the member group. A failed response could either indicate that the token has already been used or that it has since expired.
\nThe Action element in the response indicates the action that the token corresponds to. It will either be \"Approve\" if the user clicked the approval link or \"Decline\" if the user clicked the decline link. This can be used to inform the user of their action if they proceed.
Approve or Decline a member into a Member Group who had previously registered. Returns an error message/code if the Token is invalid.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nA successful response means that the token was valid and has been used to process an approval or decline into member group. A failed response could either indicate that the token has already been used or that it has since expired.
\nThe Action element in the response indicates the action that the token corresponds to. It will either be \"Approve\" if the user clicked the approval link or \"Decline\" if the user clicked the decline link. This can be used to inform the user of their action if they proceed.
The Status element in the response indiciates what the outcome was on the member. This can either be VerifyEmail, Approved or Declined.
OK\n Returns a list of regions that are associated to this Member Group, which are available to this Member.
\nWill return errors when:
\nRequest Elements
\n","urlObject":{"path":["getmembergroupregions","{{HM_ServiceAPI_MemberToken}}","{MemberGroupID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"34047900-7cb3-4aac-8603-0555d3285afe","name":"Get Member Group Regions (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupregions/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Feb 2022 06:30:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Regions\": [\n {\n \"ID\": \"2cc127ac79723d7f8c\",\n \"Name\": \"Region 1\",\n \"SubscribeDefault\": false,\n \"LicensingModel\": \"None\",\n \"Blocked\": false\n },\n {\n \"ID\": \"1af0a17d955dbcd0cf\",\n \"Name\": \"Region 2\",\n \"SubscribeDefault\": false,\n \"LicensingModel\": \"None\",\n \"Blocked\": false\n }\n ]\n}"},{"id":"1295c079-ab95-4883-979f-d54fb21d7dfc","name":"Get Member Group Regions (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupregions/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 10 Feb 2022 06:34:33 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nUpdates an existing member account associated with a Member Group, by assigning a regional context for use within that Member Group.
\nWill return errors when:
\nRequest Elements
\nRequest Notes
\nThese parameters will be shared between “first search” and “search within results”.
\n","urlObject":{"path":["updatemembergroupregion","{{HM_ServiceAPI_MemberToken}}","{MemberGroupID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0a3f5fc0-f7c4-4ca6-81de-64c22164d21d","name":"Update Member Group Region (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"RegionID\":\"2cc127ac79723d7f8c\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemembergroupregion/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Feb 2022 04:44:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"f6cf0d72-8a58-4d58-bde6-eb1405b3f655","name":"Update Member Group Region (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nReturns a list of productions that are associated to this Member Group.
\nWill return errors when:
\nRequest Elements
\nRequest Notes: Sort
\nSort is optional and defaults to Alphabetic_Asc if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Custom_Asc, Custom_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc
\n","urlObject":{"path":["getmembergroupproductions","{{HM_ServiceAPI_MemberToken}}","{MemberGroupID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"5a577e93-2632-4ee8-80a0-abbb1cc081a9","name":"Get Member Group Productions (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductions/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28?sort=Name_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductions","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28"],"query":[{"key":"sort","value":"Name_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Mar 2022 09:59:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Productions\": [\n {\n \"ID\": \"4d4dddcd6da8jeeda5\",\n \"Name\": \"Creative\",\n \"Description\": \"A description\",\n \"CreatedDate\": \"2/22/2022 1:21:16 PM\",\n \"Featured\": false,\n \"HasArtwork\": false\n },\n {\n \"ID\": \"7ca7f153h0fd7e64c1\",\n \"Name\": \"Crime Stories\",\n \"Description\": \"A description\",\n \"CreatedDate\": \"2/22/2022 1:21:55 PM\",\n \"LastUpdatedDate\": \"2/22/2022 1:26:15 PM\",\n \"Featured\": true,\n \"HasArtwork\": true\n }\n ],\n \"TotalProductionsCount\": \"2\"\n}"},{"id":"c8372bfd-9e1d-4074-95aa-ba3391213017","name":"Get Member Group Productions (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductions/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28?sort=Name_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductions","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28"],"query":[{"key":"sort","value":"Name_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 08 Mar 2022 10:06:57 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns a list of categories that are associated with the production in this Member Group.
\nWill return errors when:
\nRequest Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Alphabetic_Asc if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Custom_Asc, Custom_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc
\n","urlObject":{"path":["getmembergroupproductioncategories","{{HM_ServiceAPI_MemberToken}}","{MemberGroupID}","{MemberGroupProductionID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"{ReturnPlaylistCount}"},{"key":"skip","value":"{Skip}"},{"key":"limit","value":"{Limit}"},{"key":"sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"7f12f612-6cd2-49f9-877f-44c833af2faf","name":"Get Member Group Production Categories (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductioncategories/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28/4d4dddcd6da8jeeda5?returnplaylistcount=true&skip=0&limit=10&sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductioncategories","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28","4d4dddcd6da8jeeda5"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Mar 2022 10:37:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ProductionCategories\": [\n {\n \"ID\": \"1a30b74ba01eecb48b\",\n \"Name\": \"Action\",\n \"CreatedDate\": \"2/22/2022 1:34:38 PM\",\n \"Playlists\": [],\n \"PlaylistCount\": \"2\"\n },\n {\n \"ID\": \"fd97a88da43e2e60e9\",\n \"Name\": \"Beachside\",\n \"CreatedDate\": \"2/22/2022 1:22:39 PM\",\n \"Playlists\": [],\n \"PlaylistCount\": \"2\"\n }\n ],\n \"TotalProductionCategoriesCount\": \"12\"\n}"},{"id":"3ac9f8f2-6644-4f66-89b0-6b868ae1fa01","name":"Get Member Group Production Categories (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductioncategories/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28/4d4dddcd6da8jeeda5?returnplaylistcount=true&skip=0&limit=10&sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductioncategories","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28","4d4dddcd6da8jeeda5"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 08 Mar 2022 10:41:17 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns a list of categories & playlists that are associated with the production in this Member Group.
\nWill return errors when:
\n* The member does not belong to the member group
\nRequest Elements
\nRequest Notes: ProductionCategoryID
\nWhen set to a value this will return those playlists that are within that category. This is to be used when retrieving content for a production category. It's important to note that when this attribute has a value, Skip and Limit will work to page the contents of the category as opposed to the contents on the root level.
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Alphabetic_Asc if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc, Custom_Asc and Custom_Desc
\n","urlObject":{"path":["getmembergroupproductioncategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}","{MemberGroupID}","{MemberGroupProductionID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"{ReturnPlaylistCount}"},{"key":"returntrackcount","value":"{ReturnTrackCount}"},{"key":"returnrootobjectsonly","value":"{ReturnRootObjectsOnly}"},{"key":"productioncategoryid","value":"{ProductionCategoryID}"},{"key":"skip","value":"{Skip}"},{"key":"limit","value":"{Limit}"},{"key":"sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"74d8f603-cacd-4578-b335-1a1be44679e7","name":"Get Member Group Production Categories & Playlists (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductioncategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28/4d4dddcd6da8jeeda5?returnplaylistcount=true&returntrackcount=false&returnrootobjectsonly=false&productioncategoryid=&skip=0&limit=10&sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductioncategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28","4d4dddcd6da8jeeda5"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"returntrackcount","value":"false"},{"key":"returnrootobjectsonly","value":"false"},{"key":"productioncategoryid","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Mar 2022 10:53:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ProductionCategories\": [\n {\n \"ID\": \"1a30b74ba01eecb48b\",\n \"Name\": \"Action\",\n \"CreatedDate\": \"2/22/2022 1:34:38 PM\",\n \"Playlists\": [\n {\n \"Name\": \"MOMENTS IN TIME\",\n \"ID\": \"8aede9fa29a737bffz\",\n \"Description\": \"\",\n \"CreatedDate\": \"1/31/2018 10:45:54 AM\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"Tags\": \"\",\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ObjectType\": \"Playlist\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false\n }\n ],\n \"PlaylistCount\": \"1\"\n }\n ],\n \"TotalProductionCategoriesCount\": \"1\"\n}"},{"id":"e5897a93-230f-4ff1-8ac4-168d8d5892c6","name":"Get Member Group Production Categories & Playlists","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductioncategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28/4d4dddcd6da8jeeda5?returnplaylistcount=true&returntrackcount=false&returnrootobjectsonly=false&productioncategoryid=&skip=0&limit=10&sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductioncategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28","4d4dddcd6da8jeeda5"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"returntrackcount","value":"false"},{"key":"returnrootobjectsonly","value":"false"},{"key":"productioncategoryid","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 08 Mar 2022 10:57:41 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"\nReturns a playlist and it's tracks, if they are associated with the production in this Member Group.
\nWill return errors when:
\nRequest Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_Asc if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Released_Asc, Released_Desc
\n","urlObject":{"path":["getmembergroupproductionplaylistandtracks","{{HM_ServiceAPI_MemberToken}}","{MemberGroupID}","{MemberGroupProductionID}","{FeaturedPlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returntracks","value":"{ReturnTracks}"},{"key":"includeinactive","value":"{IncludeInactive}"},{"key":"languagecode","value":"{LanguageCode}"},{"key":"skip","value":"{Skip}"},{"key":"limit","value":"{Limit}"},{"key":"sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"33973178-2f29-4c74-b07b-77c037ad76d1","name":"Get Member Group Production Playlist & Tracks (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductionplaylistandtracks/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28/4d4dddcd6da8jeeda5/8aede9fa29a737bffz?returntracks=true&includeinactive=false&languagecode=&skip=0&limit=10&sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductionplaylistandtracks","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28","4d4dddcd6da8jeeda5","8aede9fa29a737bffz"],"query":[{"key":"returntracks","value":"true"},{"key":"includeinactive","value":"false"},{"key":"languagecode","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Mar 2022 11:27:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"MOMENTS IN TIME\",\n \"ID\": \"8aede9fa29a737bffz\",\n \"Description\": \"\",\n \"CreatedDate\": \"2018-01-31 10:45:54\",\n \"TrackCount\": \"21\",\n \"Tracks\": [\n {\n \"LibraryFeatured\": false,\n \"TrackNumber\": \"002\",\n \"Time\": \"02:17\",\n \"LengthSeconds\": \"137\",\n \"Comment\": \"Hip and weighty with funk elements featuring female lead vocals and horns to creates an engaging and secure mood.\",\n \"Composer\": \"Stephan M. Sechi, Janice C. Dempsey\",\n \"Publisher\": \"One Revolution Music, Revolution 1 Music\",\n \"Name\": \"Da Funk Is Here To Stay\",\n \"AlbumID\": \"fb462c1e5c8ec6685c\",\n \"LibraryID\": \"8ed50d352f83f4ba31\",\n \"ID\": \"951a46o6286e714860\",\n \"Keywords\": \"FUNK, FUNKY, SLY, ACTION, GOOD TIMES, Drama, Positive, Feel-good, Proud, Energetic, Determined, Bold, Confident, Heavy, Groovy, Party, Retro, Vintage, Strut, Blaxploitation, Fast, Songs, Female, Wah Wah Guitar, Organ, Congas, Drum Kit, Female Lead Vocals, Horns\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Da Funk Is Here To Stay\",\n \"Genre\": \"Funk\",\n \"Tempo\": \"\",\n \"Instrumentation\": \"Wah Wah Guitar, Organ, Congas, Drum Kit, Female Lead Vocals, Horns\",\n \"Bpm\": \"0\",\n \"Mixout\": \"\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"Version\": \"Main\",\n \"Album\": {\n \"LibraryFeatured\": false,\n \"Code\": \"1RM075\",\n \"Detail\": \"Male and Female Vocals, 70's retro soul, Funky, jazzy, rhythm and blues, B-exploitation film, gritty, bad ass attitude, swagger, positive, cool, fun, sexy action, uplifting, disco, punchy horns, electric bass riff, wah wah guitar, tight drum grooves, percussion.\",\n \"Name\": \"Retro Funky 3\",\n \"ID\": \"fb462c1e5c8ec6685c\"\n },\n \"AlternateTracks\": [],\n \"RelatedTracks\": [],\n \"Categories\": [],\n \"LastUpdated\": \"2022-01-20 16:42:41\",\n \"CDCode\": \"1RM075\",\n \"Composers\": [],\n \"AlbumName\": \"1RM075 | Retro Funky 3\",\n \"LibraryName\": \"1 Revolution Music\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"6\",\n \"Mood\": \"\",\n \"MusicFor\": \"\",\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"IsCached\": false,\n \"StemCount\": \"5\",\n \"Stems\": [],\n \"LanguageItems\": []\n }\n ],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"Tags\": \"\",\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"HighlightTracks\": false\n }\n ],\n \"Total\": \"1\"\n}"},{"id":"1b909aeb-1d39-4ad7-8d12-f350e4256f4d","name":"Get Member Group Production Playlist & Tracks (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembergroupproductionplaylistandtracks/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28/4d4dddcd6da8jeeda5/8aede9fa29a737bffz?returntracks=true&includeinactive=false&languagecode=&skip=0&limit=10&sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembergroupproductionplaylistandtracks","{{HM_ServiceAPI_MemberToken}}","0556f9dac3b3852d28","4d4dddcd6da8jeeda5","8aede9fa29a737bffz"],"query":[{"key":"returntracks","value":"true"},{"key":"includeinactive","value":"false"},{"key":"languagecode","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 08 Mar 2022 11:31:04 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nSearches tracks on a specific member group production playlist.
\nIt is possible to define which field(s) are searched on.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Title_Asc, Title_Desc, ReleaseDate_Asc, ReleaseDate_Desc, DateAdded_Asc, DateAdded_Desc, Duration_Asc, Duration_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track dispaly title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["searchmembergroupproductionplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberGroupID}}","{{HM_ServiceAPI_MemberGroupProductionID}}","{{HM_ServiceAPI_FeaturedPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"bc958d15-dbf5-4a8d-a089-21cf2776760d","name":"Search Member Group Production Playlist Tracks (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Ty","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Keyword\": \"Rock\",\r\n \"Fields\": \"TrackDisplayTitle,TrackDescription\",\r\n \"ReturnTrackCount\": true,\r\n \"Skip\": 0,\r\n \"Limit\": 10,\r\n \"OrderBy\": \"Custom_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchmembergroupproductionplaylisttracks/{{HM_ServiceAPI_MemberToken}}/0556f9dac3b3852d28/4d4dddcd6da8jeeda5/8aede9fa29a737bffz"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2024 02:35:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"TrackNumber\": \"005\",\n \"Time\": \"03:09\",\n \"LengthSeconds\": \"189\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"Comment\": \"Medium. Driving Rock tune with distorted guitars.\",\n \"Composer\": \"Claude Engel\",\n \"Publisher\": \"BMG Production Works (France) (SACEM) 100%\",\n \"Name\": \"French Rock\",\n \"AlbumID\": \"bfb2bc47h7u73359ec\",\n \"LibraryID\": \"mgaa2444n1da891521\",\n \"ID\": \"as2634a2e843346jp7\",\n \"Keywords\": \"Heavy, Retro, Vintage, Instrumental, Driving, Drive, Determined, Pushing, Urging, Thrusting, Cool, Chic, Attitude, Hip, Slick, Smooth, Suave, Stylish, Swagger, Confident, Positive, Upbeat, Cheerful, Joyful, Joyous, Feel Good, Friendly, Happiness, Optimistic, Happy, Exciting, Action, Activity, Adrenaline, Excitement, Bustling, Busy, Energy, Lively, Thrilling, Energetic, Adventurous, Adventure, Discovery, Open Road, Road Trip, Travel, Wilderness, Wild, Brave, Courageous, Free,\",\n \"Lyrics\": \"N\",\n \"DisplayTitle\": \"French Rock\",\n \"Genre\": \"Rock\",\n \"Tempo\": \"Medium\",\n \"Instrumentation\": \"Drum Kit, Bass Guitar, Electric Guitar\",\n \"Bpm\": \"108\",\n \"Mixout\": \"Main\",\n \"Filesize\": \"\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"DateIngested\": \"2016-10-13 00:08:16\",\n \"Version\": \"main\",\n \"AlternateTracks\": [],\n \"RelatedTracks\": [],\n \"Categories\": [],\n \"ISRC\": \"\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2020-05-27 03:07:44\",\n \"CDCode\": \"TM3026\",\n \"Composers\": [],\n \"AlbumName\": \"TM3026 99% Pop\",\n \"LibraryName\": \"Tele Music Classic Vaults\",\n \"LibraryFeatured\": false,\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"IsCached\": false\n }\n ],\n \"TotalTracks\": \"1\"\n}"},{"id":"1dac10c4-96b7-45cf-b494-4fc8dd5c3bdd","name":"Search Member Group Production Playlist Tracks (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml-dtd"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows a new playlist category to be created for a member, returning the new playlist category element.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["addmemberplaylistcategory","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6761f2b6-f297-4704-8780-aac461a195dd","name":"Create Member Playlist Category (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"PlaylistCategoryName\": \"Folder Name\",\r\n\t\"PlaylistCategoryDescription\": \"Folder Description\",\r\n\t\"ColorHex\": \"#000\",\r\n\t\"AddToTop\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addmemberplaylistcategory/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 02:52:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistCategories\": [\n {\n \"ID\": \"20a6b7a3040hp1fa0a\",\n \"Name\": \"Folder Name\",\n \"Description\": \"Folder Description\",\n \"CreatedDate\": \"5/8/2020 12:52:31 PM\",\n \"ColorHex\": \"000\",\n \"Playlists\": []\n }\n ]\n}"},{"id":"b41e7e57-d14c-4fa8-beb2-0330ef43a04b","name":"Create Member Playlist Category (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Updates the details of a member playlist category.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["updatememberplaylistcategory","{{HM_ServiceAPI_MemberToken}}","{PlaylistCategoryID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8e87ed37-18a9-44b1-bfad-8b3771ec64bd","name":"Update Member Playlist Category (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"PlaylistCategoryName\": \"Folder Name (updated)\",\r\n \"PlaylistCategoryDescription\": \"Folder Description (updated)\",\r\n \"ColorHex\": \"#fff\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatememberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/20a6b7a3040hp1fa0a"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 02:59:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistCategories\": [\n {\n \"ID\": \"20a6b7a3040hp1fa0a\",\n \"Name\": \"Folder Name (updated)\",\n \"Description\": \"Folder Description (updated)\",\n \"CreatedDate\": \"5/8/2020 12:52:31 PM\",\n \"ColorHex\": \"fff\",\n \"Playlists\": []\n }\n ]\n}"},{"id":"ddb708c8-f347-4eac-b83f-51c2873779dd","name":"Update Member Playlist Category (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns playlist categories associated with a member.
\nRequest Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Name_ASC if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc, Custom_Asc, Custom_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\n","urlObject":{"path":["getmemberplaylistcategories","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"{ReturnPlaylistCount}"},{"key":"skip","value":"{Skip}"},{"key":"limit","value":"{Limit}"},{"key":"sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"2385d779-8445-463b-8608-e3532916a79e","name":"Get Member Playlist Categories (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistcategories/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&skip=0&limit=1&sort=Alphabetic_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistcategories","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"skip","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"Alphabetic_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 03:04:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistCategories\": [\n {\n \"ID\": \"20a6b7a3040hp1fa0a\",\n \"Name\": \"Folder Name (updated)\",\n \"Description\": \"Folder Description (updated)\",\n \"CreatedDate\": \"5/8/2020 12:52:31 PM\",\n \"ColorHex\": \"fff\",\n \"Playlists\": [],\n \"PlaylistCount\": \"0\"\n }\n ],\n \"TotalPlaylistsCount\": \"0\",\n \"TotalPlaylistCategoriesCount\": \"1\"\n}"},{"id":"500717ff-9b19-4947-b22c-63b5fee425fb","name":"Get Member Playlist Categories (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistcategories/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&skip=0&limit=1&sort=Alphabetic_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistcategories","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"skip","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"Alphabetic_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 08 May 2020 03:06:19 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns root level playlist categories & playlists along with all associated playlists per playlist category associated with a member.
\nRequest Elements
\nRequest Notes: ReturnAutoSaveOnly
\nWhen set to \"true\" this will only return playlists marked as auto save.
\nRequest Notes: ReturnFirstAutoSave
\nWhen set to \"true\" this will return the first auto save playlist, ordered by LastUpdateDate.
\nRequest Notes: ReturnHighlightOnly
\nWhen set to \"true\" this will return only return those playlists that are marked as Highlight = true.
Request Notes: PlaylistCategoryID
\nWhen set to a value this will return those playlists that are within that folder. This is to be used when retrieving content for a folder. It's important to note that when this attribute has a value, Skip and Limit will work to page the contents of the folder as opposed to the contents on the root level.
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Name_ASC if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc, Custom_Asc, Custom_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nResponse Notes: MaxOrderID
\nThis will appear in the response as a string-integer for playlist objects, if that playlist has tracks. It denotes the maximum orderid that exists on the playlist. This is useful when trying to ascertain the position of the bottom-most track in the playlist, if not all content can be shown in the current region.
\n","urlObject":{"path":["getmemberplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"{ReturnPlaylistCount}"},{"key":"returntrackcount","value":"{ReturnTrackCount}"},{"key":"returnrootobjectsonly","value":"{RootObjectsOnly}"},{"key":"returnautosaveonly","value":"{AutoSaveOnly}"},{"key":"returnfirstautosave","value":"{FirstAutoSaveOnly}"},{"key":"returnhighlightonly","value":"{ReturnHighlightOnly}"},{"key":"playlistcategoryid","value":"{PlaylistCategoryID}"},{"key":"skip","value":"{Skip}"},{"key":"limit","value":"{Limit}"},{"key":"sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"8a803e76-b82a-4e29-af22-c45701411355","name":"Get Member Playlist Categories & Playlists (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&returntrackcount=true&returnautosaveonly=false&returnrootobjectsonly=false&returnfirstautosave=false&returnhighlightonly=false&playlistcategoryid=&skip=0&limit=1&sort=Alphabetic_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"returntrackcount","value":"true"},{"key":"returnautosaveonly","value":"false"},{"key":"returnrootobjectsonly","value":"false"},{"key":"returnfirstautosave","value":"false"},{"key":"returnhighlightonly","value":"false"},{"key":"playlistcategoryid","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"Alphabetic_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 03:08:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistObjects\": [\n {\n \"ID\": \"20a6b7a3040hp1fa0a\",\n \"Name\": \"Folder Name (updated)\",\n \"Description\": \"Folder Description (updated)\",\n \"ObjectType\": \"PlaylistCategory\",\n \"CreatedDate\": \"5/8/2020 12:52:31 PM\",\n \"PlaylistsCount\": \"1\",\n \"ColorHex\": \"fff\",\n \"Playlists\": [\n {\n \"Name\": \"Playlist Name\",\n \"ID\": \"bk02609081lb6ha25c\",\n \"Description\": \"Playlist Description\",\n \"Tags\": \"Playlist Tags\",\n \"CreatedDate\": \"5/7/2020 3:07:36 PM\",\n \"TrackCount\": \"0\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \"AutoSave\": true,\n \"Type\": \"Curated\",\n \"ObjectType\": \"Playlist\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"MaxOrderID\": \"\"\n }\n ]\n }\n ],\n \"TotalPlaylistsCount\": \"1\",\n \"TotalPlaylistCategoriesCount\": \"1\",\n \"TotalCount\": \"1\"\n}"},{"id":"ac5d6e22-db1c-42ee-bc11-627ee53c9cb5","name":"Get Member Playlist Categories & Playlists (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&returntrackcount=true&returnrootobjectsonly=false&returnautosaveonly=false&returnfirstautosave=false&returnhighlightonly=false&playlistcategoryid=&skip=0&limit=1&sort=Alphabetic_ASC","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"returntrackcount","value":"true"},{"key":"returnrootobjectsonly","value":"false"},{"key":"returnautosaveonly","value":"false"},{"key":"returnfirstautosave","value":"false"},{"key":"returnhighlightonly","value":"false"},{"key":"playlistcategoryid","value":""},{"key":"skip","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"Alphabetic_ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 08 May 2020 03:14:20 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns root level playlist categories & playlists along with all associated playlists per playlist category associated with a member.
\nThe results returned must contain the provided keyword in the playlist category/playlist data. Track metadata is not searched.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Name_ASC if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc, Custom_Asc, Custom_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nResponse Notes: MaxOrderID
\nThis will appear in the response as a string-integer for playlist objects, if that playlist has tracks. It denotes the maximum orderid that exists on the playlist. This is useful when trying to ascertain the position of the bottom-most track in the playlist, if not all content can be shown in the current region.
\n","urlObject":{"path":["searchmemberplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d3db4c82-9e7d-446f-8683-2c53e1932711","name":"Search Member Playlist Categories & Playlists (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Length","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Keywords\": \"Folder\",\r\n \"Fields\": \"PlaylistName,PlaylistDescription\",\r\n \"ReturnPlaylistCount\": true,\r\n \"ReturnTrackCount\": true,\r\n \"ReturnContentsOnCategoryMatch\": false,\r\n \"Skip\": 0,\r\n \"Limit\": 10,\r\n \"Sort\": \"Created_ASC\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchmemberplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 18 Nov 2020 04:09:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistObjects\": [\n {\n \"ID\": \"20a6b7a3040hp1fa0a\",\n \"Name\": \"Folder Name (updated)\",\n \"Description\": \"Folder Description (updated)\",\n \"ObjectType\": \"PlaylistCategory\",\n \"CreatedDate\": \"5/8/2020 12:52:31 PM\",\n \"PlaylistsCount\": \"1\",\n \"ColorHex\": \"fff\",\n \"MatchedFields\": \"PlaylistCategoryName\",\n \"Playlists\": [\n {\n \"Name\": \"Playlist Name\",\n \"ID\": \"bk02609081lb6ha25c\",\n \"Description\": \"Playlist Description\",\n \"Tags\": \"Playlist Tags\",\n \"CreatedDate\": \"5/7/2020 3:07:36 PM\",\n \"TrackCount\": \"0\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \"AutoSave\": true,\n \"Type\": \"Curated\",\n \"ObjectType\": \"Playlist\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"MaxOrderID\": \"\",\n \"MatchedFields\": \"PlaylistName\"\n }\n ]\n }\n ],\n \"TotalPlaylistsCount\": \"1\",\n \"TotalPlaylistCategoriesCount\": \"1\",\n \"TotalCount\": \"1\"\n}"},{"id":"870a704f-08d9-4665-a881-3a625ec765d7","name":"Search Member Playlist Categories & Playlists (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows the reordering of a member playlist category.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["reordermemberplaylistcategory","{{HM_ServiceAPI_MemberToken}}","{PlaylistCategoryID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"OrderID","value":"{OrderID}"}],"variable":[]}},"response":[{"id":"166eef9f-ae5b-427d-8af1-18b2ce305c05","name":"Reorder Member Playlist Category (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/reordermemberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/20a6b7a3040hp1fa0a?OrderID=0","host":["{{HM_ServiceAPI_URL}}"],"path":["reordermemberplaylistcategory","{{HM_ServiceAPI_MemberToken}}","20a6b7a3040hp1fa0a"],"query":[{"key":"OrderID","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 03:32:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"8ec733a5-bac2-4d33-ac1b-e7f37f4bcc20","name":"Reorder Member Playlist Category (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/reordermemberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/20a6b7a3040hp1fa0a?OrderID=0","host":["{{HM_ServiceAPI_URL}}"],"path":["reordermemberplaylistcategory","{{HM_ServiceAPI_MemberToken}}","20a6b7a3040hp1fa0a"],"query":[{"key":"OrderID","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 08 May 2020 03:33:39 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nOK\nRemoves an entire playlist category from a members account.
\nRequest elements
\nRequest Notes: KeepChildren
\nOptional, value requires boolean when set. Default value is false. When false, playlists contained with the folder will be deleted. When true, playlsits contained within the folder will be moved to the bottom of the top-level playlist structure.
\nRequest Notes: GiveShareCopy
\nFor use within collaboration processes only. Both recipients and owner can utilize this.
\nOptional, value requires boolean when set. Default value is false. When false, playlists contained with the folder will not be copied to the recipient(s). When true, playlsits contained within the folder will be copied to the recipient(s) to the bottom of the top-level playlist structure. The copies are point-in-time copies, and are unbound for all references to the original collaboration.
\n","urlObject":{"path":["removememberplaylistcategory","{{HM_ServiceAPI_MemberToken}}","{PlaylistCategoryID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"keepChildren","value":"{keepChildren}"},{"key":"giveShareCopy","value":"{giveShareCopy}"}],"variable":[]}},"response":[{"id":"24749553-eb12-4d58-9c40-d66d010d928a","name":"Remove Member Playlist Category (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removememberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/20a6b7a3040hp1fa0a"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 08 May 2020 03:20:15 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows a new playlist to be created for a member, returning the new playlist element.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Title_Asc, Title_Desc, ReleaseDate_Asc, ReleaseDate_Desc, DateAdded_Asc, DateAdded_Desc, Duration_Asc, Duration_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track dispaly title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["addmemberplaylist","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2de99bbf-ec28-4943-bb02-82675a657a14","name":"Create Member Playlist (POST) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"requestaddupdateplaylist\":{\r\n \"playlistname\":\"My Playlist 3\",\r\n \"playlistdescription\":\"A description\",\r\n \"playlisttags\":\"tagname1, tagname2\",\r\n \"highlighttracks\":false,\r\n \"autosave\":false,\r\n \"autosavelimit\":0,\r\n \"autosaveapplytohighlighttracks\": false,\r\n \"playlistcategoryid\":\"\",\r\n \"externalplaylistimageurl\": \"\",\r\n \"orderby\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addmemberplaylist/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 03:24:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"623"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"My Playlist 3\",\n \"ID\": \"e78815sb88bd7kcr1e\",\n \"Description\": \"A description\",\n \"Tags\": \"tagname1, tagname2\",\n \"CreatedDate\": \"2019-08-21 13:24:29\",\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \t\t\"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n }\n ]\n}"},{"id":"79145ae0-ef9d-4bee-bfbd-fdd3c87d5097","name":"Create Member Playlist (POST) (XML)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Updates the details of a member playlist.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Title_Asc, Title_Desc, ReleaseDate_Asc, ReleaseDate_Desc, DateAdded_Asc, DateAdded_Desc, Duration_Asc, Duration_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track dispaly title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["updateplaylist","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"360f5e27-3fba-4c34-a3e8-b22f07800dd5","name":"Update Member Playlist (MT) (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"playlistname\":\"Updated Playlist Name 3\",\n\t\"playlistdescription\":\"Updated Playlist Description\",\n \"playlisttags\": \"tagname1, tagname2, tagname3\",\n \"highlighttracks\": false,\n \"autosave\":false,\n \"autosavelimit\":0,\n \"autosaveapplytohighlighttracks\": false,\n \"playlistcategoryid\":\"\",\n \"externalplaylistimageurl\": \"\",\n \"orderby\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateplaylist/{{HM_ServiceAPI_MemberToken}}/e78815sb88bd7kcr1e"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 03:35:09 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"665"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"Updated Playlist Name 3\",\n \"ID\": \"e78815sb88bd7kcr1e\",\n \"Description\": \"Updated Playlist Description\",\n \"Tags\": \"tagname1, tagname2, tagname3\",\n \"CreatedDate\": \"2019-08-21 13:24:29\",\n \"LastUpdateDate\": \"2019-08-21 13:34:51\",\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \t\t\"LanguageItems\": [],\n \t\t\"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n }\n ]\n}"},{"id":"6a02e8c1-069f-498d-a86c-0186c6ac7e6a","name":"Update Member Playlist (MT) (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Provides the ability to set the HighlightTracks flag for one or more playlists.
Request Elements
\nRequest Notes
\n","urlObject":{"path":["highlightplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6a3421a5-461b-4767-aa71-e730c934e880","name":"Highlight Member Playlists (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"Playlists\": [\n \"c8e91f04a918be2645\",\n \"79a3cac9b746cb51ba\"\n ],\n \"HighlightTracks\": true,\n \"HighlightReturnTracks\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/highlightplaylists/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 31 May 2022 02:28:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\",\n \"Playlists\": []\n}"},{"id":"e40350ec-075e-4573-bfdc-10ec8029c57f","name":"Highlight Member Playlists (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\n Provides the ability to set the AutoSave flag for one or more playlists.
Request Elements
\nRequest Notes
\n","urlObject":{"path":["autosaveplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"082663ae-d173-458f-813f-28d517df4033","name":"AutoSave Member Playlists (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"Playlists\": [\n \"f209ce0fa4f154d30e\"\n ],\n \"AutoSave\": true,\n \"AutoSaveLimit\": 1,\n \"AutoSaveApplyToHighlightTracks\": false,\n \"AutoSaveReturnTracks\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/autosaveplaylists/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 29 Nov 2022 05:58:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\",\n \"Playlists\": []\n}"},{"id":"37c6e79a-fe2b-40f5-9c01-43cbf92ed050","name":"AutoSave Member Playlists (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\n Returns a URL for which an asset file can be uploaded to.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getpresigneduploadurl","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"bca38525-c76e-4da6-a4c5-fbbb46c2d60d","name":"Get Member Playlist Image Upload URL (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"PlayListImage\",\r\n\t\"FileName\":\"test.jpg\",\r\n\t\"ContentType\":\"image/jpeg\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectID\":\"0ldgb89163605k15ef\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:50:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PresignedUploadUrl\": \"https://{domain}/test.mp3?X-Amz-Expires=120&X-Amz-Algorithm=&X-Amz-Credential=&X-Amz-Date=&X-Amz-SignedHeaders=\",\n \"ResourceUrl\": \"https://{domain}/test.mp3\"\n}"},{"id":"3a30a23d-0c44-4ae0-a1b8-6f3241a0ca84","name":"Get Member Playlist Image Upload URL (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Finalises an asset upload.
\nPlease note that this is the final step in uploading a member playlist image. Prior to performing this you should;
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["confirmpresignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3f8e7e6e-5d75-4c4b-9c1f-53211e865435","name":"Confirm Member Playlist Image Upload Complete (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ImportAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"PlayListImage\",\r\n\t\"FileName\":\"test.jpg\",\r\n\t\"ObjectID\":\"0ldgb89163605k15ef\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/confirmpresignedupload/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:51:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"94e32fa4-62e3-41b6-8e46-b37a0baa8b63","name":"Confirm Member Playlist Image Upload Complete (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Removes a previously uploaded asset from a member playlist.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["removeassignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"12cf18bf-d6fc-40e3-b43f-c7229224fdab","name":"Remove Member Playlist Image (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ImportAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"PlayListImage\",\r\n\t\"ObjectID\":\"0ldgb89163605k15ef\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/removeassignedupload/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:51:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"5392338c-7e2b-4936-9973-b315bb827f25","name":"Remove Member Playlist Image (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns playlists associated with a member.
\nRequest Elements
\nRequest Notes
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\n","urlObject":{"path":["getmemberplaylistsnotracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"{Skip}"},{"key":"Limit","value":"{Limit}"}],"variable":[]}},"response":[{"id":"c30b2b3b-4e07-46ea-a6db-b3be0a57fde4","name":"Get Member Playlists (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistsnotracks/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=20","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistsnotracks","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 02:10:33 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"10967"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"My Playlist 1\",\n \"ID\": \"ac3efc4f6dd9ufj817\",\n \"Description\": \"A description\",\n \"Tags\": \"tagname1, tagname2\",\n \"CreatedDate\": \"2019-08-12 13:30:12\",\n \"LastUpdateDate\": \"2020-05-07 16:29:03\",\n \"TrackCount\": \"0\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \t\t\"AutoSave\": true,\n \"Type\": \"Curated\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"Featured\": null,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n },\n {\n \"Name\": \"My Playlist 2\",\n \"ID\": \"0ldgb89163605k15ef\",\n \"Description\": \"A description\",\n \"Tags\": \"tagname1, tagname2\",\n \"CreatedDate\": \"2017-10-25 14:54:50\",\n \"LastUpdateDate\": \"2020-05-07 16:29:03\",\n \"TrackCount\": \"8\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \t\t\"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"Featured\": null,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n }\n ],\n \"Total\": \"0\"\n}"},{"id":"7067d919-3584-40da-9340-df211930d4df","name":"Get Member Playlists (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistsnotracks/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=20","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistsnotracks","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 02:12:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"4398"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns playlists associated with a member.
\nRequest Elements
\nRequest Notes
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\n","urlObject":{"path":["getmemberplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"{Skip}"},{"key":"Limit","value":"{Limit}"}],"variable":[]}},"response":[{"id":"d1ea16c6-6072-4d10-b18e-8740ca839a64","name":"Get Member Playlists (Include Tracks) (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylists/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=20","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylists","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 02:19:06 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"30998"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"My Playlist 1\",\n \"ID\": \"ac3efc4f6dd9ufj817\",\n \"Description\": \"A description\",\n \"Tags\": \"tagname1, tagname2\",\n \"CreatedDate\": \"2019-08-12 13:30:12\",\n \"LastUpdateDate\": \"2020-05-07 16:29:03\",\n \"TrackCount\": \"0\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \t\t\"AutoSave\": true,\n \"Type\": \"Curated\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"Featured\": null,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n },\n {\n \"Name\": \"My Playlist 2\",\n \"ID\": \"0ldgb89163605k15ef\",\n \"Description\": \"A description\",\n \"Tags\": \"tagname1, tagname2\",\n \"CreatedDate\": \"2017-10-25 14:54:50\",\n \"LastUpdateDate\": \"2020-05-07 16:29:03\",\n \"TrackCount\": \"8\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \t\t\"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"Featured\": null,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n }\n ],\n \"Total\": \"0\"\n}"},{"id":"bcf8a5f8-a90e-4587-b641-bf1a8ff44f4a","name":"Get Member Playlists (Include Tracks) (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylists/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=20","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylists","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 02:24:20 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"14510"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a specific member playlist including tracks.
\nRequest Elements
\nRequest Notes
\nSet returntracks to false in order to return a playlist without it's associated tracks. Default is true, so tracks will be returned if the parameter is not provided.
Set returnpublicationlocations to true to return the list of locations where the playlist has been published to as a featured playlist.
Response Notes: MaxOrderID
\nThis will appear in the response as a string-integer, if the playlist has tracks. It denotes the maximum orderid that exists on the playlist. This is useful when trying to ascertain the position of the bottom-most track in the playlist, if not all content can be shown in the current region.
\n","urlObject":{"path":["getmemberplaylist","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returntracks","value":"true"},{"key":"returnpublishlocations","value":"false"}],"variable":[]}},"response":[{"id":"0eb218c6-8924-4c7f-a0ee-8824b081bf18","name":"Get Member Playlist (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmemberplaylist/{{HM_ServiceAPI_MemberToken}}/0ldgb89163605k15ef"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 02:29:51 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"19140"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"My Playlist 2\",\n \"ID\": \"0ldgb89163605k15ef\",\n \"Description\": \"A description\",\n \"Tags\": \"tagname1, tagname2\",\n \"CreatedDate\": \"2017-10-25 14:54:50\",\n \"LastUpdateDate\": \"2020-05-07 16:28:34\",\n \"TrackCount\": \"1\",\n \"Tracks\": [\n {\n \"InsertionType\": \"Manual\",\n \"TrackNumber\": \"014\",\n \"Time\": \"02:01\",\n \"LengthSeconds\": \"121\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"Comment\": \"High energy dancehall banger.\",\n \"Composer\": \"George Taylor\",\n \"Publisher\": \"No Sheet Music\",\n \"Name\": \"Titans\",\n \"AlbumID\": \"fz8e1f434gcy9b5ad8\",\n \"LibraryID\": \"888ffadee59r1f56a7\",\n \"ID\": \"badcf057u195fdr36r\",\n \"Keywords\": \"Energetic, Uplifting, Positive, Edgy, Busy, Erratic, Sexy, Cool, Advertising-Branded Content, Entertainment, Lifestyle, Sport, Gaming, Radio, Technology\",\n \"DisplayTitle\": \"Titans\",\n \"Genre\": \"Electronic, Dance, Trap, Trip Hop\",\n \"Tempo\": \"C Minor\",\n \"Instrumentation\": \"Energetic, Uplifting, Positive, Edgy, Busy, Erratic, Sexy, Cool, Advertising-Branded Content, Entertainment, Lifestyle, Sport, Gaming, Radio, Technology\",\n \"Bpm\": \"140\",\n \"Mixout\": \"Lite Mix Full\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"Version\": \"Alternate\",\n \"LastUpdated\": \"2017-10-13 01:46:23\",\n \"CDCode\": \"NSM130\",\n \"Composers\": [],\n \"AlbumName\": \"NSM130 Energy\",\n \"LibraryName\": \"No Sheet Music\",\n \"LibraryFeatured\": false,\n \"IsAlternate\": \"true\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"25938e97hebyaa713f\"\n }\n ],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n\t\t \"LanguageItems\": [],\n\t\t \"AutoSave\": true,\n \"Type\": \"Curated\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"MaxOrderID\": \"\",\n \"Featured\": null,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n }\n ],\n \"Total\": \"1\"\n}"},{"id":"f7b06ab1-d940-4829-95d5-cd481d75ff04","name":"Get Member Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmemberplaylist/{{HM_ServiceAPI_MemberToken}}/0ldgb89163605k15ef"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 02:32:18 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"9752"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nAllows for the reordering of a member playlist either on the root level, within a playlist category or within a different playlist category
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["reordermemberplaylist","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"movetoplaylistcategoryid","value":"{PlaylistCategoryID}"},{"key":"orderid","value":"{OrderID}"}],"variable":[]}},"response":[{"id":"76d4e4a6-adee-4e3a-b663-8c71c6486f38","name":"Reorder Member Playlist (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/reordermemberplaylist/{{HM_ServiceAPI_MemberToken}}/bk02609081lb6ha25c?movetoplaylistcategoryid=20a6b7a3040hp1fa0a&orderid=2","host":["{{HM_ServiceAPI_URL}}"],"path":["reordermemberplaylist","{{HM_ServiceAPI_MemberToken}}","bk02609081lb6ha25c"],"query":[{"key":"movetoplaylistcategoryid","value":"20a6b7a3040hp1fa0a"},{"key":"orderid","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 06:11:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"9ce57993-3f7a-42b1-8932-5e26820c1fd9","name":"Reorder Member Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/reordermemberplaylist/{{HM_ServiceAPI_MemberToken}}/bk02609081lb6ha25c?movetoplaylistcategoryid=20a6b7a3040hp1fa0a&orderid=2","host":["{{HM_ServiceAPI_URL}}"],"path":["reordermemberplaylist","{{HM_ServiceAPI_MemberToken}}","bk02609081lb6ha25c"],"query":[{"key":"movetoplaylistcategoryid","value":"20a6b7a3040hp1fa0a"},{"key":"orderid","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 08 May 2020 06:12:41 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows the reordering of multiple playlists.
\nRequest Elements
\n","urlObject":{"path":["reorderplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0a9f9194-7fc1-4295-80cf-95d376e31043","name":"Reorder Multiple Member Playlists (XML)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"OK\nRemoves an entire playlist from a members account.
\nRequest elements
\n","urlObject":{"path":["removeplaylist","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3016663c-874d-49f7-850d-854fa15eb906","name":"Remove Member Playlist (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removeplaylist/{{HM_ServiceAPI_MemberToken}}/e78815sb88bd7kcr1e"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 03:56:56 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"9ea8a115-d788-476d-9086-4ed89faaabdf","name":"Remove Member Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removeplaylist/{{HM_ServiceAPI_MemberToken}}/e78815sb88bd7kcr1e"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 03:56:56 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows the archiving of a member playlist.
\nRequest Elements
\n","urlObject":{"path":["archiveplaylist","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2562fdcc-3ec5-4791-a181-ad763252c472","name":"Archive Member Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/archiveplaylist/{{HM_ServiceAPI_MemberToken}}/f8fc1ahh63f17299aa"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 04:03:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows an archived member playlist to be restored.
\nRequest Elements
\n","urlObject":{"path":["restorearchiveplaylist","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cd109824-657f-438d-8754-c38f018dc9ba","name":"Restore Archived Member Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/restorearchiveplaylist/{{HM_ServiceAPI_MemberToken}}/f8fc1ahh63f17299aa"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 04:09:24 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nDuplicates a playlist using a source playlist. This will duplicate the playlist and it's tracks.
\nThe values in AutoSave and HighlightTracks from the sourced playlist will not carry over to the duplicate.
Request Elements
\nRequest Notes
\n","urlObject":{"path":["duplicatememberplaylist","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c3fd028d-3507-472d-8817-4218aa4748e7","name":"Duplicate Member Playlist (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SourcePlaylistID\": \"13b5dd4eac2134afe0\",\r\n \"DuplicatePlaylistName\": \"Duplicate playlist name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/duplicatememberplaylist/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 04:28:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"Duplicate playlist name\",\n \"ID\": \"13b5dd4eac2134afe0\",\n \"Description\": \"Description\",\n \"CreatedDate\": \"2022-04-04 14:28:03\",\n \"LastUpdateDate\": \"2022-04-04 14:28:03\",\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"Tags\": \"tagname1, tagname2, tagname3\",\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"OrderBy\": \"\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"HighlightTracks\": false,\n \"MaxOrderID\": \"\",\n \"Featured\": null,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n }\n ]\n}"},{"id":"fb470a05-1340-42a9-9132-dba0b4f9e03f","name":"Duplicate Member Playlist (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Copies a featured playlist into a member playlist.
\nIf the featured playlist has artwork this too will come across to the member playlist.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nThe response will contain a playlist entity of the new playlist that was created.
\n","urlObject":{"path":["copytomemberplaylist","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e2b33dd8-11e0-4d7f-9959-18fa69c86c5e","name":"Copy Featured Playlist to Member Playlist (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"PlaylistID\": \"f588f10e40a9f7ed21\",\r\n \"PlaylistName\": \"\",\r\n \"CopyTracks\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/copytomemberplaylist/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Dec 2022 01:05:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Playlists\": [\n {\n \"Name\": \"Psychedelic Rock\",\n \"ID\": \"f588f10e40a9f7ed21\",\n \"Description\": \"\",\n \"CreatedDate\": \"2022-12-09 12:05:49\",\n \"LastUpdateDate\": \"2022-12-09 12:05:49\",\n \"RelatedPlaylists\": [],\n \"HasImage\": true,\n \"Tags\": \"psychedelic,rock,psychedelic rock\",\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"OrderBy\": \"\",\n \"HighlightTracks\": false,\n \"MaxOrderID\": \"\",\n \"Featured\": null,\n \"IsEditable\": true,\n \"IsCollaboration\": false,\n \"HasCollaborator\": false,\n \"CollaboratingDate\": \"\",\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false,\n \"LastPublishDate\": \"\",\n \"HasSchedule\": false,\n \"IsActiveSchedule\": false,\n \"EnableSchedule\": false\n }\n ]\n}"},{"id":"8500c095-357a-488c-8efb-36fa6b320550","name":"Copy Featured Playlist to Member Playlist (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Publishes a member playlist by taking a copy of the playlist and converting it into a featured playlist, for inclusion in either a Style or ProductionCategory structure.
\nIt is also possible to create a schedule. Creating a schedule will allow you to specify how often this playlist should refresh itself using previously performed search criteria, and whether or not that refresh should automatically publish this changes to the publication locations.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Locations
\nRequest Notes: Schedule
\n","urlObject":{"path":["publishmemberplaylist","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7386133b-3641-4ded-ab51-919c9e8b6813","name":"Publish Member Playlist (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"\",\r\n \"Status\": \"Publish\",\r\n \"CopyTracks\": true,\r\n \"Locations\": [\r\n {\r\n \"Type\": \"Style\",\r\n \"ID\": \"7417d2511565bd9eb7\",\r\n \"Status\": \"Publish\"\r\n },\r\n {\r\n \"Type\": \"MemberGroupProductionCategory\",\r\n \"ID\": \"7417d2511565bd9eb7\",\r\n \"Status\": \"Publish\"\r\n }\r\n ],\r\n \"Schedule\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/publishmemberplaylist/{{HM_ServiceAPI_MemberToken}}/fc3ec1a6ee01f0f179"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 17 May 2022 05:39:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\",\n \"Identity\": \"ae0ce3035fe7feea1a\"\n}"},{"id":"7d83b5aa-abf8-4549-8aa5-3f7a4a58ffc7","name":"Publish Member Playlist (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\n Searches tracks on a specific member playlist.
\nIt is possible to define which field(s) are searched on.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Title_Asc, Title_Desc, ReleaseDate_Asc, ReleaseDate_Desc, DateAdded_Asc, DateAdded_Desc, Duration_Asc, Duration_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track dispaly title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["searchmemberplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"82cca6af-ce9e-4974-b6a4-68aceaac0d43","name":"Search Member Playlist Tracks (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Keyword\": \"Rock\",\r\n \"Fields\": \"TrackDisplayTitle,TrackDescription\",\r\n \"ReturnTrackCount\": true,\r\n \"InsertionType\": \"\",\r\n \"Skip\": 0,\r\n \"Limit\": 10,\r\n \"OrderBy\": \"Custom_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchmemberplaylisttracks/{{HM_ServiceAPI_MemberToken}}/vfbf8fc96f7l4f38e5"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 03 Jul 2020 04:37:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"InsertionType\": \"Manual\",\n \"TrackNumber\": \"005\",\n \"Time\": \"03:09\",\n \"LengthSeconds\": \"189\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"Comment\": \"Medium. Driving Rock tune with distorted guitars.\",\n \"Composer\": \"Claude Engel\",\n \"Publisher\": \"BMG Production Works (France) (SACEM) 100%\",\n \"Name\": \"French Rock\",\n \"AlbumID\": \"bfb2bc47h7u73359ec\",\n \"LibraryID\": \"mgaa2444n1da891521\",\n \"ID\": \"as2634a2e843346jp7\",\n \"Keywords\": \"Heavy, Retro, Vintage, Instrumental, Driving, Drive, Determined, Pushing, Urging, Thrusting, Cool, Chic, Attitude, Hip, Slick, Smooth, Suave, Stylish, Swagger, Confident, Positive, Upbeat, Cheerful, Joyful, Joyous, Feel Good, Friendly, Happiness, Optimistic, Happy, Exciting, Action, Activity, Adrenaline, Excitement, Bustling, Busy, Energy, Lively, Thrilling, Energetic, Adventurous, Adventure, Discovery, Open Road, Road Trip, Travel, Wilderness, Wild, Brave, Courageous, Free,\",\n \"Lyrics\": \"N\",\n \"DisplayTitle\": \"French Rock\",\n \"Genre\": \"Rock\",\n \"Tempo\": \"Medium\",\n \"Instrumentation\": \"Drum Kit, Bass Guitar, Electric Guitar\",\n \"Bpm\": \"108\",\n \"Mixout\": \"Main\",\n \"Filesize\": \"\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"DateIngested\": \"2016-10-13 00:08:16\",\n \"Version\": \"main\",\n \"AlternateTracks\": [],\n \"RelatedTracks\": [],\n \"Categories\": [],\n \"ISRC\": \"\",\n \"Status\": \"active\",\n \"LastUpdated\": \"2020-05-27 03:07:44\",\n \"CDCode\": \"TM3026\",\n \"Composers\": [],\n \"AlbumName\": \"TM3026 99% Pop\",\n \"LibraryName\": \"Tele Music Classic Vaults\",\n \"LibraryFeatured\": false,\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"IsCached\": false\n }\n ],\n \"TotalTracks\": \"1\"\n}"},{"id":"fa6ef205-df8a-4603-a38c-1cc2a3f6a08f","name":"Search Member Playlist Tracks (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows a comparison of tracks between a source playlist and one or more playlists.
\nRequest Elements
\nRequest Notes
\nRequest Notes: FilterBy
\nThere are two options available; Except and Intersect.
Use Except when you want to return all tracks from the source playlist that do not appear in any of the Playlists.
Use Intersect when you want to return all tracks from the source playlist that do appear in all of the Playlists.
Request Notes: FilterAction
\nThere are two options available; FilterOnly and FilterAndSave
Use FilterOnly when you want to perform the comparison and not actually alter the source playlist.
Use FilterAndSave when you want to perform the comparison and alter the tracks on the source playlist by the result.
Request Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Title_Asc, Title_Desc, ReleaseDate_Asc, ReleaseDate_Desc, DateAdded_Asc, DateAdded_Desc, Duration_Asc, Duration_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track dispaly title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["filtermemberplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cfb59d75-cca2-4e04-94a7-9b443bcbbe82","name":"Compare Member Playlist Tracks (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Playlists\": [\r\n \"1ce438b737cbeae6b7c\"\r\n ],\r\n \"FilterBy\": \"Except\",\r\n \"FilterAction\": \"FilterOnly\",\r\n \"Skip\": 0,\r\n \"Limit\": 10,\r\n \"OrderBy\": \"Custom_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/filtermemberplaylisttracks/{{HM_ServiceAPI_MemberToken}}/6e204a35b3013e0f01"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 10 Aug 2022 02:03:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tracks\": [\n {\n \"InsertionType\": \"Manual\",\n \"LibraryFeatured\": false,\n \"Highlighted\": false,\n \"EvokeSegments\": [],\n \"HighlightedInPlaylists\": [],\n \"TrackNumber\": \"1\",\n \"Time\": \"04:29\",\n \"LengthSeconds\": \"269\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"Comment\": \"Traditional style Chinese music\",\n \"Composer\": \"Graham Philip D'Ancey (PRS/MCPS)\",\n \"Publisher\": \"Cavendish Music Co. Ltd. (PRS)\",\n \"Artist\": \"\",\n \"Name\": \"THE DRAGON & THE PHOENIX\",\n \"AlbumID\": \"898508aa5a17afcec2\",\n \"LibraryID\": \"741de54cb7284214d\",\n \"ID\": \"c23e1b7d5f70cd9d4de\",\n \"Keywords\": \"China, Ethnospheres, Asia, Far East, Asian, Asian, Chinese, Expedition, Global, Third World, Ethnic\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"THE DRAGON & THE PHOENIX\",\n \"alternatetitle\": \"\",\n \"Genre\": \"National Music / Countries\",\n \"Tempo\": \"Medium\",\n \"Instrumentation\": \"\",\n \"Bpm\": \"110\",\n \"Mixout\": \"\",\n \"Frequency\": \"0\",\n \"Bitrate\": \"0\",\n \"DateIngested\": \"2021-10-31 00:11:47\",\n \"Version\": \"Main\",\n \"AlternateTracks\": [],\n \"RelatedTracks\": [],\n \"Categories\": [],\n \"Status\": \"active\",\n \"CDCode\": \"CAVC0030\",\n \"Composers\": [],\n \"AlbumName\": \"CAVC0030 National Music Chinese/indian\",\n \"LibraryName\": \"Cavendish Music\",\n \"FileName\": \"BMGPMCAVC0030001THE_DRAGON_&_THE_PHOENIX[version]__D'Ancey.wav\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"0\",\n \"Mood\": \"\",\n \"MusicFor\": \"\",\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\",\n \"IsCached\": false,\n \"StemCount\": \"0\",\n \"Stems\": [],\n \"LanguageItems\": [],\n \"OrderID\": \"0\"\n }\n ],\n \"TotalTracks\": \"1\"\n}"},{"id":"cbe51f18-7f27-4227-a1b5-038621b2a355","name":"Compare Member Playlist Tracks (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows the addition of multiple objects to one or more member playlists. The objects being added must all be of the same type.
\nResponse will include which tracks were added and which were existing.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nRequest Notes: ObjectTrimStart and ObjectTrimEnd
\nPlease note that these are references only and will not automatically restrict downloads or sampling to these positions. It will be up to your integration to utilize the stored values and either pass them through when requesting a download or to use them in your waveform player.
\nWhen it comes to downloading, there are a couple of ways that this gets used;
\nImportant - note that should you use a ObjectTrimStart and/or ObjectTrimEnd when using ObjectType: Album/Playlist then all tracks within that collection will have the ObjectTrimStart and ObjectTrimEnd applied.
ObjectTrimStart and ObjectTrimEnd will appear in the following API endpoint track responses, as LengthSecondsTrimStart and LengthSecondsTrimEnd:
\nObjectTrimStart and ObjectTrimEnd will be copied to newly created playlists in the following API endpoints:
\nAllows the addition of multiple tracks to all autosave playlists.
\nNo duplicate tracks will be added to the playlist.
\nRequest Elements
\n","urlObject":{"path":["addtrackstoautosaveplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7949cccf-779c-4af0-83fc-d8d05a6e516a","name":"Add Multiple Tracks to AutoSave Member Playlists (XML)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"OK\nAllows the reordering of multiple tracks within a playlist, to move to a new playlist or to move to the root level.
\nRequest Elements
\nRequest Notes
\nPrecedingTrackID, SucceedingTrackID or OrderID
\nOnly one of these can be used during a single request. The others must be set to null or not be provided.
\nIn general, we recommend always using PrecedingTrackID and SucceedingTrackID to move tracks within the list. These can be used to handle all track movements that may be needed, for example; moving a track within the list, moving a track to the start of the list, moving a track to the end of the list.
\nThe use case for using OrderID, is when the tracks are paged and you wish to move the track to the start or end of the playlist track list, but do not have the required preceding or succeeding trackid to do so.
\nPlease note that OrderID will only impact the order of results when combined with the sort-order Custom_ASC or Custom_DESC
\n","urlObject":{"path":["reordermemberplaylisttracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ce9f9e48-81f7-49bf-8f4d-966e19acb392","name":"Reorder Multiple Tracks in Member Playlist (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"FromPlaylistID\": \"0ldgb89163605k15ef\",\r\n \"ToPlaylistID\": \"0ldgb89163605k15ef\",\r\n \"TrackIDs\": \"badcf057u195fdr36r\",\r\n \"PrecedingTrackID\": null,\r\n \"SucceedingTrackID\": null,\r\n \"OrderID\": 0,\r\n \"Copy\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/reordermemberplaylisttracks/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 06:36:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"bf1b2796-c3d5-4df7-b37e-2a31851e5048","name":"Reorder Multiple Tracks in Member Playlist (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nAllows the removal of multiple tracks from a playlist.
\nRequest Elements
\n","urlObject":{"path":["removeplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"34d89c6b-8d66-4e06-9a42-62167af95885","name":"Remove Multiple Tracks from Member Playlist (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"track\":[{\r\n\t\t\"id\":\"d01ef9a3646501dpb9\"\r\n\t}, {\r\n\t\t\"id\":\"121epof3t46ujg1422\"\r\n\t}]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/removeplaylisttracks/{{HM_ServiceAPI_MemberToken}}/b221aeafh30yui7388"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 04:17:24 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"aea1c119-8ea3-43eb-b2fa-9370a9877d5a","name":"Remove Multiple Tracks from Member Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"OK\nThis is an endpoint for Smart Playlists, it provides an array of suggested tracks similar to those already within the Member's Playlist.
\nMax SeedLimit is 10
\nSeedDetermination can be Random, Created_Asc or Created_Desc.
\nCreated_Asc/Desc is based on the time the track was added to playlist.
\nSeedDetermination order determines where the seeds will be picked.
\nFor example, a SeedDetermination based on \"last 5 tracks\" added to the playlist
\nSeedLimit = 5
\nSeedDetermination = Created_Desc
\nReturns root level playlist categories & playlists along with all associated playlists per playlist category associated with a member.
\nRequest Elements
\nRequest Notes: ReturnAutoSaveOnly
\nWhen set to \"true\" this will only return playlists marked as auto save.
\nRequest Notes: ReturnFirstAutoSave
\nWhen set to \"true\" this will return the first auto save playlist, ordered by LastUpdateDate.
\nRequest Notes: ReturnHighlightOnly
\nWhen set to \"true\" this will return only return those playlists that are marked as Highlight = true.
Request Notes: PlaylistCategoryID
\nWhen set to a value this will return those playlists that are within that folder. This is to be used when retrieving content for a folder. It's important to note that when this attribute has a value, Skip and Limit will work to page the contents of the folder as opposed to the contents on the root level.
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Name_ASC if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc, Custom_Asc, Custom_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nResponse Notes: MaxOrderID
\nThis will appear in the response as a string-integer for playlist objects, if that playlist has tracks. It denotes the maximum orderid that exists on the playlist. This is useful when trying to ascertain the position of the bottom-most track in the playlist, if not all content can be shown in the current region.
\n","urlObject":{"path":["getmemberplaylistshares","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"skip","value":"{{HM_ServiceAPI_Skip}}"},{"key":"limit","value":"{{HM_ServiceAPI_Limit}}"},{"key":"sort","value":"{{HM_ServiceAPI_PlaylistSortOrder}}"}],"variable":[]}},"response":[],"_postman_id":"a8e83fce-301b-4e19-8f53-acefd78dd122"},{"name":"Update Member Playlist Share","id":"174e2541-3de1-400f-a7f7-bad2b03171db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatememberplaylistshare/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_MemberPlaylistShareID}}","description":"Updates the details of a member playlist.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Sort
\nSort is optional and defaults to Custom_ASC if not provided. Possible values include; Created_Asc, Created_Desc, Custom_Asc, Custom_Desc, Title_Asc, Title_Desc
\nRequest Notes: Sort - Custom_ASC & Custom_DESC
\nThese two sort options are the ascending & descending member defined order. This is a zero-based index and is the index as it may appear on a tree structure.
\nRequest Notes: Sort - Title_ASC & Title_DESC
\nThese two sort options are ascending & descending on the track title, not the track dispaly title. As part of the ordering, any album CD Code present is removed.
\n","urlObject":{"path":["updatememberplaylistshare","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberPlaylistShareID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"174e2541-3de1-400f-a7f7-bad2b03171db"},{"name":"Remove Member Playlist Share","id":"ff2fc84f-db79-4bd4-8575-ad2d82de0bb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removememberplaylistshare/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_MemberPlaylistShareID}}?giveShareCopy={giveShareCopy}","description":"Removes the member if a valid MemberToken is provided. Returns an error message/code if the MemberToken is invalid.
\nRequest Elements
\nGiveShareCopy
\nFor use within collaboration processes only. Both recipients and owner can utilize this.
\nOptional, value requires boolean when set. Default value is false. When false, playlists contained with the folder will not be copied to the recipient(s). When true, playlsits contained within the folder will be copied to the recipient(s) to the bottom of the top-level playlist structure. The copies are point-in-time copies, and are unbound for all references to the original collaboration.
\n","urlObject":{"path":["removememberplaylistshare","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberPlaylistShareID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"giveShareCopy","value":"{giveShareCopy}"}],"variable":[]}},"response":[],"_postman_id":"ff2fc84f-db79-4bd4-8575-ad2d82de0bb5"}],"id":"68ce95d5-bacd-4e32-9c42-5c70e1d927b6","_postman_id":"68ce95d5-bacd-4e32-9c42-5c70e1d927b6","description":""},{"name":"Playlist Search History","item":[{"name":"Get Member Playlist Search History","id":"93c2277d-cf76-4eaf-9b6e-2afe6d2146de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmemberplaylistsearches/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_NewMemberPlaylistID}}?skip={{HM_ServiceAPI_Skip}}&limit={{HM_ServiceAPI_Limit}}&sort={{HM_ServiceAPI_PlaylistSortOrder}}","description":"Returns all searches that were used to append tracks to the playlist.
\nRequest Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to CreateDate_Asc if not provided. Possible values include; CreateDate_Asc, CreateDate_Desc
\n","urlObject":{"path":["getmemberplaylistsearches","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"skip","value":"{{HM_ServiceAPI_Skip}}"},{"key":"limit","value":"{{HM_ServiceAPI_Limit}}"},{"key":"sort","value":"{{HM_ServiceAPI_PlaylistSortOrder}}"}],"variable":[]}},"response":[{"id":"9bb83b91-03ac-495f-8334-b5ee3a7661e8","name":"Get Member Playlist Search History (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistsearches/{{HM_ServiceAPI_MemberToken}}/vfbf8fc96f7l4f38e5?skip=0&limit=1&sort=","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistsearches","{{HM_ServiceAPI_MemberToken}}","vfbf8fc96f7l4f38e5"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Oct 2024 07:02:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ProjectSearches\": [\n {\n \"ID\": \"4a5101b8e68b5def01\",\n \"CreatedDate\": \"2024-10-03 16:41:53\",\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternateonly\": false,\n \"parentsearchhistoryid\": \"f265f37fad27fea597dcc8b1c20697e926\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"ReleaseDate_Asc\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false,\n \"facet_releaseyear\": false,\n \"view_style_album_count\": false,\n \"view_style_playlist_count\": false,\n \"view_track_categories\": false,\n \"evoke_prioritizebpm\": false,\n \"evoke_suppressvocals\": false,\n \"view_album_assigned_to_style\": false,\n \"view_playlist_assigned_to_style\": false,\n \"returnrates\": false\n },\n \"nearestduration\": false,\n \"nearestbpm\": false,\n \"nearestalternate\": false,\n \"LibraryType\": \"\",\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 139,\n \"st_keyword_aggregated\": {\n \"searchtermid\": 1,\n \"Keywords\": \"pop\",\n \"exactphrase\": false,\n \"oroperation\": false,\n \"wildcard\": false,\n \"disablekeywordgroup\": false,\n \"negative\": false\n }\n }\n ]\n }\n }\n ],\n \"TotalCount\": \"1\"\n}"},{"id":"a830b69d-2025-49a6-9c7a-f52765151774","name":"Get Member Playlist Search History (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistsearches/{{HM_ServiceAPI_MemberToken}}/vfbf8fc96f7l4f38e5?skip=0&limit=1&sort=","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistsearches","{{HM_ServiceAPI_MemberToken}}","vfbf8fc96f7l4f38e5"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Thu, 03 Oct 2024 07:03:13 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns a specific member playlists' schedule.
\nRequest Elements
\n","urlObject":{"path":["getmemberplaylistschedule","{{HM_ServiceAPI_MemberToken}}","33da591b784f4330"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"becbca54-b7fa-4889-89b9-dc9dbfb1f370","name":"Get Member Playlist Schedule (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmemberplaylistschedule/{{HM_ServiceAPI_MemberToken}}/0ldgb89163605k15ef"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Oct 2024 04:18:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistSchedule\": {\n \"ID\": \"5a2f7897f4ae2d5fa5\",\n \"ProjectID\": \"0ldgb89163605k15ef\",\n \"SearchHistoryID\": \"4a646b2adb64249e80049717a6e8ef8070\",\n \"Name\": \"Repeat every day\",\n \"Description\": \"\",\n \"Status\": \"Enabled\",\n \"RefreshType\": \"RefreshAndPublish\",\n \"GenerateType\": \"Clean\",\n \"GenerateCleanType\": \"CleanAutomated\",\n \"IntervalType\": \"Day\",\n \"IntervalValue\": 1,\n \"IntervalStartDate\": \"2024-10-03 00:00:00\",\n \"IntervalEndDate\": \"2024-10-05 00:00:00\",\n \"IntervalNextDate\": \"2024-10-04 00:00:00\",\n \"ContentCount\": 0,\n \"AttemptCount\": 0\n }\n}"},{"id":"793a1dd4-b531-4413-a038-51f262e5dbf9","name":"Get Member Playlist Schedule (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Content-Type","value":"application/xml"}],"url":"{{HM_ServiceAPI_URL}}/getmemberplaylistschedule/{{HM_ServiceAPI_MemberToken}}/0ldgb89163605k15ef"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 04 Oct 2024 04:22:49 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nUpdates a member playlists' schedule.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["updatememberplaylistschedule","{{HM_ServiceAPI_MemberToken}}","699cd3bbe22ff336"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4bdba476-beb6-470a-8f8d-6cc9620c542f","name":"Update Member Playlist Schedule (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"Repeat every day\",\r\n \"Description\": \"\",\r\n \"Status\": \"Enabled\",\r\n \"SearchHistoryID\": \"4a646b2adb64249e80049717a6e8ef8070\",\r\n \"RefreshType\": \"RefreshAndPublish\",\r\n \"GenerateType\": \"Clean\",\r\n \"GenerateCleanType\": \"CleanAutomated\",\r\n \"IntervalType\": \"Day\",\r\n \"IntervalValue\": \"1\",\r\n \"IntervalStartDate\": \"2024-10-03 00:00:00\",\r\n \"IntervalEndDate\": \"2024-10-05 00:00:00\",\r\n \"TrackCount\": \"10\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatememberplaylistschedule/{{HM_ServiceAPI_MemberToken}}/0ldgb89163605k15ef"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Oct 2024 04:28:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistSchedule\": {\n \"ID\": \"5a2f7897f4ae2d5fa5\",\n \"ProjectID\": \"0ldgb89163605k15ef\",\n \"SearchHistoryID\": \"4a646b2adb64249e80049717a6e8ef8070\",\n \"Name\": \"Repeat every day\",\n \"Description\": \"\",\n \"Status\": \"Enabled\",\n \"LastUpdateDate\": \"2024-10-04 14:28:05\",\n \"RefreshType\": \"RefreshAndPublish\",\n \"GenerateType\": \"Clean\",\n \"GenerateCleanType\": \"CleanAutomated\",\n \"IntervalType\": \"Day\",\n \"IntervalValue\": 1,\n \"IntervalStartDate\": \"2024-10-03 00:00:00\",\n \"IntervalEndDate\": \"2024-10-05 00:00:00\",\n \"IntervalNextDate\": \"2024-10-05 00:00:00\",\n \"ContentCount\": 0,\n \"AttemptCount\": 0\n }\n}"},{"id":"da5fec3a-28c1-4656-afd2-6e891da11bf1","name":"Update Member Playlist Schedule","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Removes an entire playlist from a members account.
\nRequest elements
\n","urlObject":{"path":["deletememberplaylistschedule","{{HM_ServiceAPI_MemberToken}}","33da591b784f4330"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"04e23229-72f8-4fed-bc39-c82caad71daf","name":"Remove Member Playlist (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removeplaylist/{{HM_ServiceAPI_Token}}/2077d2ad4566gfccdd/e78815sb88bd7kcr1e"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 03:56:56 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nReturns a specific member playlists scheduled runs. Each run is an auto-generation attempt to populate tracks on the playlist and have it published.
\nRequest Elements
\n","urlObject":{"path":["getmemberplaylistschedulerun","{{HM_ServiceAPI_MemberToken}}","{{PlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"skip","value":"{{HM_ServiceAPI_Skip}}"},{"key":"limit","value":"{{HM_ServiceAPI_Limit}}"}],"variable":[]}},"response":[{"id":"0ff57009-a251-4128-a1be-90dbecaae022","name":"Get Member Playlist Schedule Runs (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistschedulerun/{{HM_ServiceAPI_MemberToken}}/0ldgb89163605k15ef?skip=0&limit=10","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistschedulerun","{{HM_ServiceAPI_MemberToken}}","0ldgb89163605k15ef"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Oct 2024 06:20:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PlaylistScheduleRun\": [\n {\n \"ID\": \"0ldgb89163605k15ef\",\n \"ProjectScheduleID\": \"bce3cadc31b2f28576\",\n \"StartDate\": \"2024-10-04 15:34:19\",\n \"EndDate\": \"2024-10-04 15:34:20\",\n \"Result\": 1,\n \"ResultComment\": \"\",\n \"RunType\": \"Day\",\n \"RefreshType\": \"RefreshAndPublish\",\n \"GenerateType\": \"Clean\",\n \"GenerateCleanType\": \"CleanAutomated\",\n \"ContentCount\": 25961\n }\n ]\n}"},{"id":"060d4936-03cd-4d5b-8e44-c51858895788","name":"Get Member Playlist Schedule Runs (XML)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmemberplaylistschedulerun/{{HM_ServiceAPI_MemberToken}}/0ldgb89163605k15ef?skip=0&limit=10","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistschedulerun","{{HM_ServiceAPI_MemberToken}}","0ldgb89163605k15ef"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 04 Oct 2024 06:21:22 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nHarvest Media has an integration with Disco, where by members can send their playlists to Disco.
\nPlease note that this is a specialized service in Harvest Media and requires a Disco API key be configured for use on the account. As it is specialised, there may be costs associated with it's integration and use. Please contact us for more information.
\nGeneral flow
\nThe following steps outlines the process of sending a playlist to Disco:
\nA member playlist is chosen to be sent
\nDisco will return a URL
\nThe end user should navigate to the URL where they will be prompted to login to an account and accept the playlist transfer
\nOnce accepted, the playlist send will be queued to be sent. Please expect that this could take some time.
\nOnce the send has completed, the end user will receive an email notifying them that the playlist has been delivered
\nAdditional notes:
\nPlease note the following:
\nPlaylists of size greater than 100 tracks cannot be sent.
\nTracks can be sent in MP3, AIFF or WAV format
\nThe following details are sent to Disco;
\nPlaylist details
\nTrack details
\nHarvest TrackID
\nTrack display title
\nTrack artist (free-text)
\nTrack composer (free-text)
\nTrack genre
\nTrack bpm
\nTrack number
\nTrack lyrics
\nTrack audio URL
\nAlbum display title
\nAlbum release date
\nAlbum artwork URL
\nSends a member playlist to Disco.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["sendtodisco","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"fileformatid","value":"{FileFormatID}"}],"variable":[]}},"response":[{"id":"b158ae95-3a12-45f9-8983-747e8fbdebd7","name":"Send Member Playlist To Disco (JSON)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HM_ServiceAPI_URL}}/sendtodisco/{{HM_ServiceAPI_MemberToken}}/fc3ec1a6ee01f0f179?fileformatid=","host":["{{HM_ServiceAPI_URL}}"],"path":["sendtodisco","{{HM_ServiceAPI_MemberToken}}","fc3ec1a6ee01f0f179"],"query":[{"key":"fileformatid","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 18 Aug 2025 04:57:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"4bf6481f-1b20-4d34-954a-2fed50625c34\",\n \"url\": \"https://{disco-domain}/lib/add-to-disco/?token=4bf6481f-1b20-4d34-954a-2fed50625c34\"\n}"},{"id":"32775dd6-995d-41e6-8d8d-ab0e42f1ecac","name":"Send Member Playlist To Disco (XML)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HM_ServiceAPI_URL}}/sendtodisco/{{HM_ServiceAPI_MemberToken}}/fc3ec1a6ee01f0f179?fileformatid=","host":["{{HM_ServiceAPI_URL}}"],"path":["sendtodisco","{{HM_ServiceAPI_MemberToken}}","fc3ec1a6ee01f0f179"],"query":[{"key":"fileformatid","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 18 Aug 2025 04:58:23 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nRetrieves the history of sends to DIsco.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to DateAdded_Asc if not provided. Possible values include; DateAdded_Asc, DateAdded_Desc, UpdatedDate_Asc, UpdatedDate_Desc.
\n","urlObject":{"path":["getaccountserviceactivityhistory","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"974d5795-bbfd-4723-a9af-03348b35b8c7","name":"Get Member Playlist Disco Send History (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"RelationType\": \"Playlist\",\r\n \"RelationID\": \"d8ac9b4504297109a6\",\r\n \"Skip\": 0,\r\n \"Limit\": 10,\r\n \"Sort\": \"DateAdded_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getaccountserviceactivityhistory/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 18 Aug 2025 05:44:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"AccountServiceActivities\": [\n {\n \"ID\": \"19ecebe7bedcfaf625\",\n \"Type\": \"DISCO\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2025-08-05T15:00:16.517\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"d8ac9b4504297109a6\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"https://{disco-domain}/lib/add-to-disco/?token=000e353c-dbd2-4797-9b7c-46d3928e06ee\",\n \"LastUpdateDate\": \"2025-08-05T15:00:57.993\",\n \"Status\": \"Success\",\n \"ErrorMessage\": \"\"\n }\n ]\n}"},{"id":"56e5b2e8-3e38-47a8-ba2e-d9a438faaec3","name":"Get Member Playlist Disco Send History (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"The following section outlines the formats that are available for streaming as well as immediate downloads.
\nFormats are available for streaming;
\nTrack downloads will always be available immediately. Album, Playlist and Track Version bundles will download immediately only when the fileformat is available in the HarvestMedia repository.
\nFormats available for immediate download include:
\nThere are dozens of other formats available which can be dynamically trans-coded and delivered to members via email download links. This generally takes between 5-15 minutes to be delivered.
\nIf you have originator labels you can ingest your preferred WAV format (ie: WAV 16bit, 44.1kHz) which will be available for immediate download. We will automatically create a matching AIFF format with the same sample and bit rates behind the scenes for use.
\nIf you sub publish labels you can not control the WAV formats provided by the originators so we suggestion sticking to the above mentioned available formats.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"17622aaf-4009-42d0-9255-b97ab63be804"},{"name":"Implementation Guide - Stems","id":"66bdb612-3726-4a42-84be-91c4297dc1fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO:","header":[],"url":"","description":"The following section outlines the availability of stem downloads.
\nPresently, it is possible to request a download of stems as a ZIP package only. To do so, you request the type: \"stems\", the format:\"wav\" and the identifier: . The result will be a download token that when used will yield a ZIP that contains all of the stems only. It will not contain the main track.
It is not possible to download an individual stem or to be able to download a main track with the stems as well.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"66bdb612-3726-4a42-84be-91c4297dc1fd"},{"name":"Validate Music Download","id":"f771b555-1daf-43e4-93bd-7d3be99bf84f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/validatemusicdownloadrequest/{{HM_ServiceAPI_MemberToken}}","description":"Returns the availability of a download and whether this can be downloaded immediately.
\nDownloads that cannot be downloaded immediately will be emailed when requested.
\nRequest elements
\nRequest Notes
\nNotes regarding a successful response
\nGetDownload returns download tokens which can be downloaded immediately or sends a download link directly to specified email.
\nWhenever download tokens are returned use the AssetUrls.DirectDownloadUrl URL regardless of type of download (To access AssetURLs see getserviceinfo).
\nRequest Elements
\nRequest Notes
\nNotes regarding a Successful Response (isshare= “false” and forceemail= “false”)
\nThe responsedownload returns an array of token objects. In most cases, there will be just one token, but where the download contains many tracks (typically in WAV or AIFF formats), there will be multiple parts to the download. In these cases, the package is split into multiple ZIP archives (up to 2GB in size each), and each token represents one of these ZIP files, and the corresponding part represents the ZIP file’s order within the package set.
\nMerge each TokenValue from the response object with AssetUrls.DirectDownloadUrl and make a request to it. You will need to launch a download for each token/part pair in this array.
\nWhere multiple download tokens are returned, we recommend simultaneous requests to each link as these tokens have a very brief expiry time.
\nSuccessful Response (isshare= “true” or forceemail=\"true)
\nIf the response body returns “requestsent=true” then the download will be sent using the email process. The member will receive an email with a download link.
\n","urlObject":{"path":["getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2efe43e1-cf9f-4ad9-b13f-78dcdfe99d14","name":"Get Music Download (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Identifier\": \"1f9345scb3836e55c3\",\r\n \"DownloadType\": \"track\",\r\n \"Format\": \"mp3\",\r\n \"TrimStartSecs\": 0,\r\n \"TrimEndSecs\": 0,\r\n \"Email\": \"email@domain.com\",\r\n \"IsShare\": false,\r\n \"Message\": \"\",\r\n \"SenderEmail\": \"\",\r\n \"ForceEmail\": false,\r\n \"IncludeVersions\": false,\r\n \"VersionFolderName\": \"\",\r\n \"DownloadFileName\": \"\",\r\n \"CuesheetFileName\": \"\",\r\n \"IncludeCuesheetFile\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getmusicdownload/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 01:39:32 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"199"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"RequestSent\": false,\n \"DownloadTokens\": [\n {\n \"TokenValue\": \"37ecc842dac353708v941e8e09vf42c3l0\"\n }\n ],\n \"BlockedContentIDs\": []\n}"},{"id":"cf45b7d4-a7b2-4d3e-9845-b4eb9724ea4a","name":"Get Music Download (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns information on the current status of a download, including download links to each item contained within.
\nThere are two possible usages here; retrieving information on a singular download (album, playlist) or a grouped download (playlist categories).
\nRequest Elements
\nRequest Notes
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: DownloadID
\nDownloadID should be used for downloads of type Album or Playlist.
Request Notes: DownloadGroupID
\nDownloadID should be used for downloads of type Playlist Category.
Request Notes: DownloadID or DownloadGroupID
\nFrom a website implementation perspective, you can determine which request property to populate based on the URL that the user navigated to. The routes for each is configured in the Admin portal - we recommend making different routes to handle each scenario.
\nRequest Notes: DownloadGroupID
\nDownloadID should be used for downloads of type Playlist Category.
Response Notes: Status
\nThere are four possible states;
\nInProgess - you will receive this status if the download is still being prepared.
Prepared - you will receive this status if the download has finished being prepared and is now available for download.
Downloaded - you will receive this status if the particular item has been downloaded previously. It is still possible to download this again.
Expired - you will receive this status if the download is no longer available. This expiration time can vary based on account settings, but usually this is somewhere between 7-30 days.
Allows that addition of a track or a whole album to the member’s Favourites list, depending on which parameter type is supplied.
\nIf a track type add is requested then only the track identified will be added to the favourites list.
If an album type add is requested then all tracks in the album will be added to the favourites list.
No duplicate tracks will be added to the favourites list regardless of the request type.
\nRequest Elements
\n","urlObject":{"path":["addtofavourites","{{HM_ServiceAPI_MemberToken}}","{Type}","{ID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"17a4cc9f-ad22-453c-b66c-e4f6213f6cd8","name":"Add Track/Album to Member Favourites (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/addtofavourites/{{HM_ServiceAPI_MemberToken}}/track/ter25dd557fbadf278"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 04:37:39 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"b1122761-92b2-4144-b9cf-57395599dcb3","name":"Add Track/Album to Member Favourites (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/addtofavourites/{{HM_ServiceAPI_MemberToken}}/track/ter25dd557fbadf278"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 04:38:42 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nReturns a list of tracks that have been set to \"favourite\" by a member.
\nRequest elements
\nRequest Notes
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\n","urlObject":{"path":["getfavourites","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"{Skip}"},{"key":"Limit","value":"{Limit}"},{"key":"Sort","value":"Created_Desc"}],"variable":[]}},"response":[{"id":"0228ce85-6582-404d-843c-8a645e00381e","name":"Get Member Favourites (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getfavourites/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=10","host":["{{HM_ServiceAPI_URL}}"],"path":["getfavourites","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 04:26:40 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"15202"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Favourites\": {\n \"trackcount\": \"1\",\n \"Tracks\": [\n {\n \"TrackNumber\": \"001\",\n \"Time\": \"2019-03-27 12:17:08\",\n \"LengthSeconds\": \"143\",\n \"LengthSecondsTrimStart\": \"\",\n \"LengthSecondsTrimEnd\": \"\",\n \"AlbumID\": \"6fn20f65cbg9fune1a\",\n \"LibraryID\": \"8m16abeap08d62q50a\",\n \"LibraryFeatured\": false,\n \"ID\": \"28495i9id1dbc39ff2\",\n \"DisplayTitle\": \"Foot In My Mouth\",\n \"Composers\": [],\n \"IsAlternate\": \"false\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ]\n }\n}"},{"id":"86a7bb27-92d2-4850-b1de-2b60741629b7","name":"Get Member Favourites (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getfavourites/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=10","host":["{{HM_ServiceAPI_URL}}"],"path":["getfavourites","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 04:28:34 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2641"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nAllows the removal of a track from a member favourites.
\nRequest Elements
\n","urlObject":{"path":["removefavouritestrack","{{HM_ServiceAPI_MemberToken}}","{TrackID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"aba93df6-01f3-46d8-8b40-f4f2f8b4c646","name":"Remove Track from Member Favourites (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removefavouritestrack/{{HM_ServiceAPI_MemberToken}}/d3e027ty9ac1u5b501"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 04:33:21 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows the removal of all tracks from a member favourites.
\nRequest Elements
\n","urlObject":{"path":["removeallfavouritestracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4ef96fd2-cb05-4615-b140-e879e075a6a2","name":"Remove All Tracks from Member Favourites (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removeallfavouritestracks/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 21 Aug 2019 04:31:56 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"5f8b588f-d3d3-4ec4-9df0-f2aa90ca07af","name":"Remove All Tracks from Member Favourites (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removeallfavouritestracks/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 04:33:21 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nReturns a temporary MemberToken for a member with the associated email address. If no member exists with that email address then a temporary member is created with it.
\nReturns an error message/code if the MemberToken is invalid.
\nRequest elements
\nRequest Notes
\n","urlObject":{"path":["getinvitedmembertoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"10d7fa2a-740f-43d2-8d10-3aee6c3e0a08","name":"Authenticate Temporary Member (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Email\":\"email@yourcompany.com\",\r\n\t\"RegionID\":\"becc9d05155aygb083\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getinvitedmembertoken/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 23:22:54 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"301"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Token\": {\n \"Value\": \"25d3fa6a64cd593ffdb467e16f1chf7975\",\n \"Expiry\": \"2019-08-22T09:22:36.92\",\n \"UTCOffset\": 10,\n \"Type\": \"MemberToken\",\n \"IsOfSingleUse\": false\n }\n}"},{"id":"69a8bb79-624b-42de-b958-3959bbd5ebb0","name":"Authenticate Temporary Member (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Gets a Playlist Category share URL that can be shared to guests and other members alike.
\nRequest Elements
\nRequest Notes
\nIt's important to note that in order to utilise this feature you will need to obtain member tokens for both the sender and recipient.
\nOnce a share URL is obtained it is possible to send the URL to an email address;
\nGets a playlist share URL that can be shared to guests and other members alike.
\nRequest Elements
\nRequest Notes
\nIt's important to note that in order to utilise this feature you will need to obtain member tokens for both the sender and recipient.
\nOnce a share URL is obtained it is possible to send the URL to an email address;
\nAllows the sending of share music links.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["sendsharemusiclinkemail","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"78721db6-9feb-498e-be2f-f22ea378f5ee","name":"Send Share Music Email (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"FromEmail\":\"first.last@company.net\",\r\n\t\"ToEmail\":\"second.last@company.net\",\r\n\t\"Message\":\"A message\",\r\n\t\"Link\":\"https://{domain}/{website-share-path}/{share-token}\",\r\n\t\"ContentType\":\"PlaylistCategory\",\r\n\t\"ContentTitle\":\"My Folder Name\",\r\n\t\"SelectEmailTemplateByMemberRegion\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendsharemusiclinkemail/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Nov 2020 06:55:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"794736ed-9023-42e2-84dd-3526d33a9c5e","name":"Send Share Music Email (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nAllows the delivery of shared music into another members account.
\nThis process also includes the ability to send an email to the recipient of the shared music, which must be opted into.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["deliversharemusic","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d884b997-9531-4160-9d9d-6b2db8c76b88","name":"Deliver Share Music (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"ToUsername\":\"email@domain.com\",\r\n \"ObjectIdentifier\":\"e78815sb88bd7kcr1e\",\r\n \"ObjectType\": \"Playlist\",\r\n \"NotifyUser\": false,\r\n \"Message\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/deliversharemusic/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 17 May 2022 04:02:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"4c18319d-73f8-4995-82cd-9c985c318689","name":"Deliver Share Music (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Accept","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nReturns relevant token and Playlist Category and/or Playlist information.
\nRequest Elements
\nResponse Notes
\nThe response will contain the related Playlist Category and/or Playlist tree. The member token found in the response to this method should be used to get the shared playlist when it comes time to displaying it on screen. To get the shared playlist please call Get Shared Playlist.
\nPlease note that the response also contains attributes denoting whether the playlist can be downloaded, shared etc.
\nWhen \"allowdownload\" is true calls to Get Music Download can be made without the user needing to be logged in.
\n","urlObject":{"path":["getsharemusic","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_EnageAccessToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3cea73a1-c6cd-48e8-87f2-4609545e5138","name":"Get Playlist Folder & Playlist Share (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getsharemusic/{{HM_ServiceAPI_Token}}/09c6fd80eac680e8dcad7152cf0d88a0a0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Nov 2020 01:16:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"RequestEngageToken\": {\n \"Value\": \"09c6fd80eac680e8dcad7152cf0d88a0a0\",\n \"Expiry\": \"0001-01-01T00:00:00\",\n \"UTCOffset\": 11,\n \"Type\": \"EngageToken\",\n \"IsOfSingleUse\": false,\n \"TokenUsageState\": \"Open\"\n },\n \"ReferredPlaylistObject\": {\n \"ID\": \"20a6b7a3040hp1fa0a\",\n \"Name\": \"Folder Name 2\",\n \"Description\": \"Folder Description 2\",\n \"ObjectType\": \"PlaylistCategory\",\n \"HasImage\": false,\n \"AutoSave\": false,\n \"CreatedDate\": \"2020-11-11 16:43:24\",\n \"ColorHex\": \"000\",\n \"PlaylistsCount\": \"1\",\n \"Playlists\": [\n {\n \"Name\": \"Playlist Name\",\n \"ID\": \"bk02609081lb6ha25c\",\n \"Description\": \"Playlist Description\",\n \"CreatedDate\": \"11/11/2020 4:43:42 PM\",\n \"TrackCount\": 1,\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ObjectType\": \"Playlist\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"OrderBy\": \"\"\n }\n ]\n },\n \"ReferredPermission\": {\n \"AllowDownload\": false,\n \"AllowSave\": false,\n \"AllowFollow\": false,\n \"AllowShare\": false,\n \"AllowEdit\": false,\n \"AllowCollaboration\": false,\n \"AllowPublish\": false\n },\n \"Referrer\": {\n \"FirstName\": \"First\",\n \"LastName\": \"Last\"\n }\n}"},{"id":"a4b20d7d-02a2-410f-9c2e-2d7f8948632d","name":"Get Playlist Folder & Playlist Share (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getsharemusic/{{HM_ServiceAPI_Token}}/09c6fd80eac680e8dcad7152cf0d88a0a0"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Fri, 13 Nov 2020 01:26:15 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nAdds the shared PlaylistCategory or Playlist to your own Playlist collection.
\nIt's important to note that in order to utilise this feature you will need to receive a shared music token.
\nTo receive a Playlist Category share see
\n\nTo receive a Playlist share see
\n\nThe token present in the share URL will be required in order to accept the shared Playlist Category or Playlist.
\nRequest Elements
\nRequest Notes: AcceptType
\nAcceptType is used during playlist collaboration processes to denote how the end user is choosing to accept the playlist.
There are 2 options;
\nAsCopy (default)
\nAsCollaboration
\nWhen a playlist or folder is accepted AsCopy it means that the playlist/folder will be copied to the users account. There will be no direct correlation maintained between the original sender, the recipient, or the playlist/folder that was ultimately copied to the recipient. It is a point-in-time copy with no references attached.
When a playlist or folder is accepted AsCollaboration it means that the recipient would like to work in combination with the owner and other recipients of the playlist/folder. This can only occur, if the owner originally shared it in a manner that allowed forthis level of collaboration. If they had then the recipient, when accepting, will get an in-sync playlist/folderin their account to work within
OK\n Returns records associated with a member, based on their audition history.
\nThe response will not include the full track metadata, instead we recommend that you retrieve this using Get Tracks
Request Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
Skip is the number of results to skip.
Limit is the number of results to return.
An example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Start & End Dates
\nThe StartDate and EndDate parameters can be used to return downloads within a date range.
StartDate and EndDate must be supplied in UTC.
The date should be supplied in yyyy-mm-dd format.
There are a few ways this can be set:
\nStartDate set, with EndDate not set; this will return all results on or after the StartDate
EndDate set, with StartDate not set; this will return all results on or before the EndDate
StartDate and EndDate both set; this will return all results within the date range
StartDate and EndDate both not set; this is the default and will return all results regardless of date
Please Note: Audition history data is retained for a maximum of 18 months from the current date.
\n","urlObject":{"path":["gethistorybymembertoken","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"startdate","value":"{startDate}"},{"key":"enddate","value":"{endDate}"},{"key":"skip","value":"{Skip}"},{"key":"limit","value":"{Limit}"}],"variable":[]}},"response":[{"id":"40fdcf2e-cb5d-4c2b-8dfe-4bc80faef126","name":"Get Member Audition History (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/gethistorybymembertoken/{{HM_ServiceAPI_MemberToken}}?skip=0&limit=2","host":["{{HM_ServiceAPI_URL}}"],"path":["gethistorybymembertoken","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 20 Aug 2019 23:44:02 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"2957"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"History\": {\n \"Tracks\": [\n {\n \"TrackNumber\": \"1\",\n \"Time\": \"01:17\",\n \"LengthSeconds\": \"77\",\n \"Comment\": \"Promo - Contemporary. Chug some of this retro, indie-rock jungle juice featuring killer distorted guitars, slammin' drums and a gritty bass that lay down the attitude while retro transistor/computer efx and groovy tambourine show The Man who's boss... POI :41 hang ten with a sweet guitar solo as the party rages on with a kitshcy 60's organ and screaming guitar licks! Retro-Kremlin-Beach-Party-Blowout! Full Mix\",\n \"Composer\": \"Jamen Brooks (ASCAP) 100%\",\n \"Publisher\": \"Acoustitracks Obsessive Music (ASCAP) 100%\",\n \"Name\": \"Cosmonaut Hula Hooch\",\n \"AlbumID\": \"7faf73ff39044b941b\",\n \"ID\": \"08f6537012bc7ffc86\",\n \"Keywords\": \"Commercial, TV, Promo, Rock, Retro, Fun, Party, 60's, Indie, Punk, Alternative, Sports, Beach, Kitschy, Nostalgia, Happy, Classic Rock.\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Cosmonaut Hula Hooch\",\n \"Genre\": \"Promo\",\n \"Tempo\": \"\",\n \"Instrumentation\": \"\",\n \"Bpm\": \"152\",\n \"Mixout\": \"\",\n \"Frequency\": \"48000\",\n \"DateIngested\": \"2013-09-07 02:26:03\",\n \"Version\": \"Full Mix\",\n \"CdCode\": \"ATR004\",\n \"AlbumName\": \"ATR004 Promologic 1\",\n \"LibraryName\": \"Acoustitracks\",\n \"LibraryFeatured\": false,\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 09:24:55\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n },\n {\n \"TrackNumber\": \"2\",\n \"Time\": \"01:20\",\n \"LengthSeconds\": \"80\",\n \"Comment\": \"Promo - Contemporary. Tension slowly builds with hammered dulcimer, eerie backwards piano and stomped kick drum leading into POI :14 brutal, pounding toms, thick bass, heavy piano and ethereal vocals that light the track on fire with driving, aggressive power both mysterious and uplifting. POI :32 arpeggiated piano plays under majestic, chiming electric guitars and solid drums that lead this rocker into its exalted, emotional conclusion. Full Mix\",\n \"Composer\": \"Jamen Brooks (ASCAP) 100%\",\n \"Publisher\": \"Acoustitracks Obsessive Music (ASCAP) 100%\",\n \"Name\": \"Dulcimated\",\n \"AlbumID\": \"7faf73f39044zb94b9\",\n \"ID\": \"9ef5988bd84c807ac5\",\n \"Keywords\": \"Commercial, TV, Promo, Rock, Inspiring, Alternative, Driving, Indie, Sophisticated, Emotional, Positive Male Vocal.\",\n \"DisplayTitle\": \"Dulcimated\",\n \"Genre\": \"Promo\",\n \"Instrumentation\": \"\",\n \"Bpm\": \"132\",\n \"Frequency\": \"48000\",\n \"DateIngested\": \"2013-09-07 02:26:42\",\n \"Version\": \"Full Mix\",\n \"CdCode\": \"ATR004\",\n \"AlbumName\": \"ATR004 Promologic 1\",\n \"LibraryName\": \"Acoustitracks\",\n \"LibraryFeatured\": false,\n \"Status\": \"active\",\n \"LastUpdated\": \"2019-07-11 09:24:55\",\n \"IsAlternate\": \"false\",\n \"AlternateCount\": \"3\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": [],\n \"MainTrackID\": \"\"\n }\n ],\n \"HistoryItems\": [\n {\n \"TrackID\": \"08f6537012bc7ffc86\",\n \"DeliveryDate\": \"2025-08-05T18:22:45\",\n \"UTCOffset\": 10.0,\n \"ItemType\": \"Sample\",\n \"TrimStartSecs\": 0.0,\n \"TrimEndSecs\": 0.0\n },\n {\n \"TrackID\": \"9ef5988bd84c807ac5\",\n \"DeliveryDate\": \"2025-08-05T18:22:40\",\n \"UTCOffset\": 10.0,\n \"ItemType\": \"Sample\",\n \"TrimStartSecs\": 0.0,\n \"TrimEndSecs\": 0.0\n }\n ],\n \"TotalHistoryItems\": 5\n }\n}"},{"id":"e4f21f13-6635-4ff1-9a23-61b660ab4fc2","name":"Get Member Audition History (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/gethistorybymembertoken/{{HM_ServiceAPI_MemberToken}}?skip=0&limit=2","host":["{{HM_ServiceAPI_URL}}"],"path":["gethistorybymembertoken","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"skip","value":"0"},{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Tue, 20 Aug 2019 23:45:18 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"440"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns records associated with a member, based on their download history.
\nThe response will not include the full track metadata, instead we recommend that you retrieve this using Get Tracks
Request Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
Skip is the number of results to skip.
Limit is the number of results to return.
An example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Start & End Dates
\nThe StartDate and EndDate parameters can be used to return downloads within a date range..
StartDate and EndDate must be supplied in UTC.
The date should be supplied in yyyy-mm-dd format.
There are a few ways this can be set:
\nStartDate set, with EndDate not set; this will return all results on or after the StartDateEndDate set, with StartDate not set; this will return all results on or before the EndDateStartDate and EndDate both set; this will return all results within the date rangeStartDate and EndDate both not set; this is the default and will return all results regardless of dateReturns records associated with a member, based on their communication history.
\nRequest Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
Skip is the number of results to skip.
Limit is the number of results to return.
An example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Start & End Dates
\nThe StartDate and EndDate parameters can be used to return downloads within a date range.
StartDate and EndDate must be supplied in UTC.
The date should be supplied in yyyy-mm-dd format.
There are a few ways this can be set:
\nStartDate set, with EndDate not set; this will return all results on or after the StartDateEndDate set, with StartDate not set; this will return all results on or before the EndDateStartDate and EndDate both set; this will return all results within the date rangeStartDate and EndDate both not set; this is the default and will return all results regardless of dateAllows a new tag to be created for a member, returning the new tag element.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["addmembertag","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1f6c5666-be3a-40d1-bc75-4a12461461c1","name":"Create Member Tag (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"TagName\": \"Tag Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addmembertag/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jan 2023 05:04:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"TagID\": \"12e4039c7b5f68bcf0\",\n \"TagName\": \"Tag Name\",\n \"Type\": \"UnAttached\",\n \"CreateDate\": \"2023-01-04T16:04:52.183\",\n \"LastUpdateDate\": \"2023-01-04T16:04:52.183\"\n }\n ]\n}"},{"id":"8b2859ea-ab0e-4380-9a51-f149063bf12b","name":"Create Member Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows the update of a Tag.
\nRequest Elements
\n","urlObject":{"path":["updatemembertag","{{HM_ServiceAPI_MemberToken}}","12340397b5f68cf0"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b856122f-d9fb-4468-811e-be2af1c2514a","name":"Update Member Tag (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"TagName\":\"Tag Name updated\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemembertag/{{HM_ServiceAPI_MemberToken}}/12e4039c7b5f68bcf0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jan 2023 05:24:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"TagID\": \"12e4039c7b5f68bcf0\",\n \"TagName\": \"Tag Name updated\",\n \"Type\": \"UnAttached\",\n \"CreateDate\": \"2023-01-04T16:04:52.183\",\n \"LastUpdateDate\": \"2023-01-04T16:24:47.2\"\n }\n ]\n}"},{"id":"e0683a19-c6e8-45ef-b028-a8aa6e365d22","name":"Update Member Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows the addition of multiple objects to one or more member tags. The objects being added must all be of the same type.
\nResponse will include which tracks were added and which were existing.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\n","urlObject":{"path":["addtomembertags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2afd46c6-36c4-4136-9398-8da8d87a05c3","name":"Add to Member Tags (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"ObjectType\": \"Track\",\r\n \"ObjectIDs\": [\r\n \"c2ee59f610e5d3e626\",\r\n \"138b873c7f2fbee4f5\"\r\n ],\r\n \"AddToTagIDs\": [\r\n \"12e4039c7b5f68bcf0\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addtomembertags/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jan 2023 05:47:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"TagID\": \"12e4039c7b5f68bcf0\",\n \"TagName\": \"Tag Name updated\",\n \"Type\": \"Track\",\n \"AddedObjects\": [\n {\n \"ObjectID\": \"c2ee59f610e5d3e626\",\n \"ObjectType\": \"Track\"\n },\n {\n \"ObjectID\": \"138b873c7f2fbee4f5\",\n \"ObjectType\": \"Track\"\n }\n ]\n }\n ]\n}"},{"id":"d1be8b85-aab0-44ab-80c5-6aac1cade525","name":"Add to Member Tags (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns tags associated with a member.
\nRequest elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Created_Asc if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc
\n","urlObject":{"path":["getmembertags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"{Skip}"},{"key":"Limit","value":"{Limit}"},{"key":"Sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"02746944-f9cf-45bd-b944-5adbb99ee890","name":"Get Member Tags (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembertags/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=10&Sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembertags","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"10"},{"key":"Sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 04:06:12 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"TagID\": \"12e4039c7b5f68bcf0\",\n \"TagName\": \"Tag Name\",\n \"Type\": \"Track\",\n \"CreateDate\": \"2023-01-04T16:04:52.183\",\n \"LastUpdateDate\": \"2023-01-04T16:24:47.2\"\n },\n {\n \"TagID\": \"fe6493545c95f6agl2\",\n \"TagName\": \"Tag Name 2\",\n \"Type\": \"Track\",\n \"CreateDate\": \"2019-08-23T14:01:42.4\",\n \"LastUpdateDate\": \"2019-08-23T14:01:42.4\"\n }\n ],\n \"TotalTagsCount\": 2\n}"},{"id":"d387d9da-373f-4a74-a9b1-aad78894a7a6","name":"Get Member Tags (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getmembertags/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=10&Sort=Alphabetic_Asc","host":["{{HM_ServiceAPI_URL}}"],"path":["getmembertags","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"10"},{"key":"Sort","value":"Alphabetic_Asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 23 Aug 2019 04:07:12 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns tracks based on a member tag.
\nRequest Elements
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Created_Asc if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, ReleaseDate_Asc, ReleaseDate_Desc
\n","urlObject":{"path":["getmembertagtracks","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberTagID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"{Skip}"},{"key":"Limit","value":"{limit}"},{"key":"Sort","value":"{Sort}"}],"variable":[]}},"response":[{"id":"02e8d868-e531-43ee-81a9-68ee9c4b5724","name":"Get Member Tag Tracks (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembertagtracks/{{HM_ServiceAPI_MemberToken}}/12e4039c7b5f68bcf0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 04:08:36 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"TagID\": \"12e4039c7b5f68bcf0\",\n \"TagName\": \"Tag Name\",\n \"Type\": \"Track\",\n \"CreateDate\": \"2023-01-04T16:04:52.183\",\n \"LastUpdateDate\": \"2023-01-04T16:24:47.2\",\n \"Tracks\": [\n {\n \"TrackNumber\": \"046\",\n \"Time\": \"01:06\",\n \"LengthSeconds\": \"66\",\n \"Comment\": \"Pounding, oriental percussion.\",\n \"Composer\": \" John Gregory Knowles (PRS)\",\n \"Publisher\": \" The Scoring House\",\n \"Name\": \"Dragon Boat\",\n \"AlbumID\": \"211155341eb934j5ua\",\n \"LibraryID\": \"m9l2fte85eb44fedt4\",\n \"ID\": \"x57de47b6364cd16g1\",\n \"Keywords\": \"MAIN, DRAMATIC, ETHNIC, TAIKO DRUM, MOVIES, MARTIAL ARTS, ETHNIC STYLINGS, GLOBAL, ASIA, EAST ASIA, JAPAN, ASIA, SOUTHEASTERN ASIA, TEMPO, 120 - 168 FAST (ALLEGRO), TV, RADIO PROGRAM FORMATS, TRAVEL, DOCUMENTARY, BIOGRAPHICAL, HISTORICAL, THE ARTS, ASIA, EAST ASIA, CHINA (PEOPLES REPUBLIC OF CHINA)\",\n \"Lyrics\": \"\",\n \"DisplayTitle\": \"Dragon Boat (a)\",\n \"alternatetitle\": \"\",\n \"Genre\": \"Trailer\",\n \"Tempo\": \"TEMPO, 120 - 168 FAST (ALLEGRO)\",\n \"Instrumentation\": \"ETHNIC, TAIKO DRUM\",\n \"Bpm\": \"\",\n \"Mixout\": \"\",\n \"Frequency\": \"48000\",\n \"Bitrate\": \"1536\",\n \"DateIngested\": \"2011-11-07 20:58:35\",\n \"Version\": \"Main\",\n \"Status\": \"active\",\n \"CDCode\": \"TSH 032A\",\n \"AlbumName\": \"TSH 032A Big Bang Percussion\",\n \"LibraryName\": \"The Scoring House\",\n \"LibraryFeatured\": false,\n \"FileName\": \"WOM_TSH_0032_04601.wav\",\n \"AlternateCount\": \"3\",\n \"Mood\": \"\",\n \"MusicFor\": \"\",\n \"Highlighted\": false,\n \"HighlightedInPlaylists\": [],\n \"HasLyrics\": false,\n \"IsExplicit\": false,\n \"Tags\": []\n }\n ]\n }\n ]\n}"},{"id":"15601e09-d9e5-40d6-b0e9-324fe8afc101","name":"Get Member Tag Tracks (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembertagtracks/{{HM_ServiceAPI_MemberToken}}/12e4039c7b5f68bcf0"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 23 Aug 2019 04:11:01 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns tags for a specified track or tracks.
\nRequest elements
\n","urlObject":{"path":["getmembertagsbytrack","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_TrackID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"775f3bc4-3e6c-474e-88b8-7023f0c6a5bf","name":"Get Member Tags By Track (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembertagsbytrack/{{HM_ServiceAPI_MemberToken}}/x57de47b6364cd16g1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 04:13:34 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"TagID\": \"12e4039c7b5f68bcf0\",\n \"TagName\": \"Tag Name\",\n \"Type\": \"Track\",\n \"CreateDate\": \"2023-01-04T16:04:52.183\",\n \"LastUpdateDate\": \"2023-01-04T16:24:47.2\"\n },\n {\n \"TagID\": \"fe6493545c95f6agl2\",\n \"TagName\": \"Tag Name 2\",\n \"Type\": \"Track\",\n \"CreateDate\": \"2019-08-23T14:01:42.4\",\n \"LastUpdateDate\": \"2019-08-23T14:01:42.4\"\n }\n ]\n}"},{"id":"a4803fb3-7e2f-420a-bb98-0a7c78aa6fea","name":"Get Member Tags By Track (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembertagsbytrack/{{HM_ServiceAPI_MemberToken}}/x57de47b6364cd16g1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 23 Aug 2019 04:14:27 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nAllows the removal of a Tag from a specific Track.
\nRequest elements
\n","urlObject":{"path":["removetrackmembertag","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberTagID}}","{{HM_ServiceAPI_TrackID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"af20db92-880a-4122-b336-a09e0da01690","name":"Remove Track Tag (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removetrackmembertag/{{HM_ServiceAPI_MemberToken}}/12e4039c7b5f68bcf0/x57de47b6364cd16g1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 04:27:46 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"3a334f92-ced1-4ef9-9ed4-6c4321765baf","name":"Remove Track Tag (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removetrackmembertag/{{HM_ServiceAPI_MemberToken}}/12e4039c7b5f68bcf0/x57de47b6364cd16g1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 23 Aug 2019 04:28:51 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows the removal of a Tag from all tracks for a specified member.
\nRequest Elements
\n","urlObject":{"path":["removemembertag","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberTagID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"9d0af4d9-55b8-47a8-bc98-7bdb5145f167","name":"Remove Tag (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removemembertag/{{HM_ServiceAPI_MemberToken}}/12e4039c7b5f68bcf0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 03:44:00 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"5f088ac9-2216-423f-a1f7-6915ff789f02","name":"Remove Tag (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removemembertag/{{HM_ServiceAPI_MemberToken}}/12e4039c7b5f68bcf0"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 23 Aug 2019 03:46:31 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows the removal of all tags from all tracks for a specified member.
\nRequest Elements
\n","urlObject":{"path":["removemembertags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8d98c4d4-011f-48e1-858a-2f1f40baae32","name":"Remove All Tags (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removemembertags/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 03:48:48 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"8f2fac4c-397f-4f21-8186-69e05b0c49fe","name":"Remove All Tags (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removemembertags/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 23 Aug 2019 03:49:51 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows a Comment to be assigned to a Track. Will create a comment if it does not exist.
\nRequest Elements
\n","urlObject":{"path":["addtrackmembercomment","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6aa350bb-dd23-4f58-b044-fc5c1554f6bd","name":"Create & Assign Member Comment to Track (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"TrackID\":\"c57de47b664cd121\",\n\t\"TagName\":\"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addtrackmembercomment/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 04:00:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"type\": \"track\",\n \"tagid\": \"zc6f36713e411d571e\",\n \"tagname\": \"first comment\",\n \"CreateDate\": \"2019-08-23T14:00:29.207\",\n \"LastUpdateDate\": \"2019-08-23T14:00:29.207\"\n }\n ]\n}"},{"id":"e583fe07-de73-4fad-9ab7-02ec486f20f6","name":"Create & Assign Member Comment to Track (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Allows the update of a Comment including its name.
\nRequest Elements
\n","urlObject":{"path":["updatetrackmembercomment","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"07febd2d-5476-46e9-b27e-7080852e6455","name":"Update Member Comment (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"TrackID\":\"zc6f36713e411d571e\",\r\n\t\"TagName\":\"first comment (updated)\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatetrackmembercomment/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Aug 2019 04:19:29 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Tags\": [\n {\n \"type\": \"track\",\n \"tagid\": \"zc6f36713e411d571e\",\n \"tagname\": \"first comment (updated)\",\n \"CreateDate\": \"2019-08-23T14:00:29.207\",\n \"LastUpdateDate\": \"2019-08-23T14:00:29.207\"\n }\n ]\n}"},{"id":"a967f607-25b4-42bb-be2b-3b43f5c4bd62","name":"Update Member Comment (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Returns comments for a specified track or tracks.
\nRequest Elements
\nRequest Notes
\nIncludeAdmin is an optional parameter. Setting it's value to true will include any comments on the track that HM Admin users have appended, as well as the member comments. A track that is from a HM Admin user will have its managementuserid property set in the response.
Allows the removal of a Comment from all tracks for a specified member.
\nRequest Elements
\n","urlObject":{"path":["removetrackmembercomment","{{HM_ServiceAPI_MemberToken}}","{TagID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"aa9ca2c5-bd4d-403a-9c1a-b0739a6aa5d6","name":"Remove Comment (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removetrackmembercomment/{{HM_ServiceAPI_MemberToken}}/1ed562h65b055b6d40"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 23 Aug 2019 03:46:31 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nAllows a search to be saved for a member.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nThe ID in the response is the same SearchHistoryID that was provided in the request. This will be used as the reference for the saved search.
\n","urlObject":{"path":["addmembersavesearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f1e2369e-6765-4dda-bd9f-e8dbd02b237a","name":"Create Member Saved Search (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"My Search\",\r\n \"Description\": \"My Search Description\",\r\n \"SearchHistoryID\": \"191bdb90ab5cb077fba3e78656f118ce0b\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addmembersavesearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 01:25:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ID\": \"191bdb90ab5cb077fba3e78656f118ce0b\",\n \"Name\": \"My Search\",\n \"Description\": \"My Search Description\",\n \"CreatedDate\": \"2024-05-30T11:25:57.243\",\n \"LastUpdateDate\": \"\"\n}"},{"id":"f9b9ebc5-b102-4261-b1e1-62bcfcedc6af","name":"Create Member Saved Search (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows updating of the details for a saved search.
\nRequest Elements
\nRequest Notes
\nPlease Note
\nThe URL of the call must also contain the existing SearchHistoryID of the saved search, not that of the new search you want to update the Saved Search with.
\nResponse Notes
\nIf a new SearchHistoryID was provided in the request body, then the ID in the response will reflect the new SearchHistoryID. This ID should be used to reference this saved search going forward.
\n","urlObject":{"path":["updatemembersavesearch","{{HM_ServiceAPI_MemberToken}}","{SearchHistoryID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e556f37b-906c-4fd6-93af-81ceee58a694","name":"Update Member Saved Search (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"My Search - Updated\",\r\n \"Description\": \"My Search Description - Updated\",\r\n \"SearchHistoryID\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemembersavesearch/{{HM_ServiceAPI_MemberToken}}/191bdb90ab5cb077fba3e78656f118ce0b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 01:27:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ID\": \"191bdb90ab5cb077fba3e78656f118ce0b\",\n \"Name\": \"My Search - Updated\",\n \"Description\": \"My Search Description - Updated\",\n \"CreatedDate\": \"2024-05-30T11:25:57.243\",\n \"LastUpdateDate\": \"2024-05-30T11:27:22.363\"\n}"},{"id":"84febbd5-07da-446f-8162-4f60cc3f157c","name":"Update Member Saved Search (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Allows retrieval of saved searches for a member.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Skip & Limit
\nThe Skip and Limit parameters come together to allow for paging of results.
\nSkip is the number of results to skip.
\nLimit is the number of results to return.
\nAn example; if your page size is 10 and the user is on page 2 then Skip would be 10 and Limit would be 10.
\nRequest Notes: Sort
\nSort is optional and defaults to Alphabetic_Asc if not provided. Possible values include; Alphabetic_Asc, Alphabetic_Desc, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc
\n","urlObject":{"path":["searchmembersavesearches","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"81a4e0d8-53fd-4785-88b5-6c1bdc146ea9","name":"Search Member Saved Searches (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Keywords\": \"\",\r\n \"Skip\": 0,\r\n \"Limit\": 1,\r\n \"Sort\": \"Alphabetic_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchmembersavesearches/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 01:31:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"SavedSearches\": [\n {\n \"ID\": \"191bdb90ab5cb077fba3e78656f118ce0b\",\n \"Name\": \"My Search - Updated\",\n \"Description\": \"My Search Description - Updated\",\n \"CreatedDate\": \"2024-05-30T11:25:57.243\",\n \"LastUpdateDate\": \"2024-05-30T11:27:22.363\",\n \"SearchTermsCount\": \"1\",\n \"SearchParameters\": {\n \"searchtype\": \"Normal\",\n \"memberaccount\": \"f4dea818b96601a091\",\n \"region\": \"4dd1bc83cbf4e8ae83\",\n \"includeinactive\": false,\n \"mainonly\": true,\n \"alternativeonly\": false,\n \"parentsearchhistoryid\": \"191bdb90ab5cb077fba3e78656f118ce0b\",\n \"resultview\": {\n \"view\": \"Track\",\n \"sort_predefined\": \"ReleaseDate_Asc\",\n \"skip\": 0,\n \"limit\": 10,\n \"saved\": false,\n \"mincount\": 0,\n \"returntrackcategoryid\": false,\n \"facet_album\": false,\n \"facet_albumskip\": 0,\n \"facet_albumlimit\": 0,\n \"facet_library\": false,\n \"facet_libraryskip\": 0,\n \"facet_librarylimit\": 0,\n \"facet_style\": false,\n \"facet_styleskip\": 0,\n \"facet_stylelimit\": 0,\n \"facet_category\": false,\n \"facet_categoryskip\": 0,\n \"facet_categorylimit\": 0,\n \"facet_composer\": false,\n \"facet_composerskip\": 0,\n \"facet_composerlimit\": 0,\n \"bpm_range\": false,\n \"duration_range\": false,\n \"include_alternates\": false,\n \"include_rightholders\": false,\n \"include_lyrics\": false,\n \"include_keywords\": false,\n \"tracks_per_album\": 0,\n \"facet_bpm\": false,\n \"facet_duration\": false,\n \"facet_releaseyear\": false,\n \"view_style_album_count\": false,\n \"view_style_playlist_count\": false,\n \"view_track_categories\": false,\n \"evoke_prioritizebpm\": false,\n \"evoke_suppressvocals\": false,\n \"view_album_assigned_to_style\": false,\n \"view_playlist_assigned_to_style\": false,\n \"returnrates\": false\n },\n \"nearestduration\": false,\n \"nearestbpm\": false,\n \"nearestalternate\": false,\n \"LibraryType\": \"\",\n \"PreviousSearchTermBundles\": [\n {\n \"SearchHistoryID\": 77733610,\n \"SearchHistoryIDEnc\": \"928001ea740044f45937c3eebd0bdfa0a2\",\n \"st_keyword_aggregated\": {\n \"searchtermid\": 1,\n \"searchtermidenc\": \"272f1da66c91e967de\",\n \"Keywords\": \"house\",\n \"exactphrase\": false,\n \"oroperation\": false,\n \"wildcard\": false,\n \"disablekeywordgroup\": false,\n \"negative\": false\n }\n },\n {\n \"SearchHistoryID\": 77733611,\n \"SearchHistoryIDEnc\": \"36f1d0e1ad8aabfda974697524e64e9173\",\n \"st_keyword_aggregated\": {\n \"searchtermid\": 1,\n \"searchtermidenc\": \"272f1da66c91e967de\",\n \"Keywords\": \"rock\",\n \"exactphrase\": false,\n \"oroperation\": false,\n \"wildcard\": false,\n \"disablekeywordgroup\": false,\n \"negative\": false\n },\n \"st_removesearchterms\": [\n {\n \"searchhistoryid\": 77733611,\n \"searchtermid\": 1\n }\n ]\n }\n ]\n }\n }\n ],\n \"TotalCount\": \"10\"\n}"},{"id":"8164d870-19ca-407e-9adb-787dfaf17fe0","name":"Search Member Saved Searches (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Removes a single filter from a member saved search.
\nRequest elements
\nRequest Notes: SearchHistoryID and SearchTermID
\nIt is important to note that the SearchHistoryID here is not the ID of the saved search.
\nIn a typical Search response the following will be returned:
\nThe PreviousSearchTermBundle contains an array of SearchTermBundles that were used to create the search. Each SearchTermBundle in this array has it's own SearchHistoryID and SearchTermID.
\nTherefore, the SearchHistoryID and SearchTermID that are required here are those that are found within the PreviousSearchTermBundle. You should not use the ID of the member saved search as that will not be correct.
\nWhen using the Search Saved History endpoint, the PreviousSearchTermBundle in each saved search object contains the two properties that are needed:
\nSearchHistoryIDEnc
\nSearchTermIDEnc
\nOK\nRemoves a single member saved search.
\nRequest elements
\nRequest Notes:
\nSearchHistoryID is the ID of the saved search to be removed.
OK\nRemoves all saved member searches.
\nRequest elements
\n","urlObject":{"path":["removeallmembersavedsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"bea07759-5e33-4c4d-bb9a-804f8aa2c610","name":"Remove All Member Saved Searches (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removeallmembersavedsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 01:38:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"3dcb0f70-0a91-42f8-b80a-d3ce23e75c7d","name":"Remove All Member Saved Searches (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removeallmembersavedsearch/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 05 Jun 2024 01:29:14 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nOK\nReturns web content that is published and available on the account.
\nRequest Elements
\n","urlObject":{"path":["getwebcontent","{{HM_ServiceAPI_Token}}","{Code}","{RegionID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f4b92808-8d8d-4339-91ca-d0f9e2eab1a2","name":"Get Web Content (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getwebcontent/{{HM_ServiceAPI_Token}}/A-CODE/54adbeu82z3e7f6ebc"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 04:45:53 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"618"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nA-CONTENT\n Returns child/sub-level web content that is available and published on the account.
\nRequest Elements
\n","urlObject":{"path":["getchildwebcontent","{{HM_ServiceAPI_Token}}","{ParentCode}","{RegionID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8052ac72-c446-4171-9a51-2bf6a4d7ba95","name":"Get Web Content Children (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getchildwebcontent/{{HM_ServiceAPI_Token}}/A-CODE/54adbeu82z3e7f6ebc"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 05:07:49 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"766"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nCHILD-CONTENT\n Returns available rates as configured in the system.
\nRequest Elements
\nRequest Notes
\nPossible values for Style include; duration, flat and special. These styles are assigned to the rates created via the Harvest Media Admin.
\nCurrency Code is optional. When not provided the accounts default currency fee amounts will be returned. If a currency code is provided, and that currency has been configured on the account, then that currencies fee amounts will be returned.
\n","urlObject":{"path":["getrates","{{HM_ServiceAPI_Token}}","{Style}","{CurrencyCode}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"44a62936-a0b7-43a9-87ab-f70e36de68ab","name":"Get Rates (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getrates/{{HM_ServiceAPI_Token}}/flat"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 21 Aug 2019 05:30:35 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"54938"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nRate1\n Rate3\n Rate2\n Rate4\n Returns a special rate as configured in the system.
\nRequest Elements
\nRequest Notes
\nCurrency Code is optional. When not provided the accounts default currency fee amounts will be returned. If a currency code is provided, and that currency has been configured on the account, then that currencies fee amounts will be returned.
\nResponse Notes
\nSpecial rates are designed to work by overriding the fee amount for all rates in the users cart that share the same Pricing Group - this is the ParentRate in the response.
\nIf a special rate overrides the amount for a rate then when the Create Invoice API method is called the special rates' RateID should be used in replace of the overriden RateID.
\n","urlObject":{"path":["getspecialratebycode","{{HM_ServiceAPI_Token}}","{SpecialRateCode}","{CurrencyCode}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1e6dd06d-dafa-4158-a166-04a25e7712db","name":"Get Special Rate (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getspecialratebycode/{{HM_ServiceAPI_Token}}/Special1"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 02 Jun 2020 03:06:48 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nSpecial1\n The following section outlines the Ecommerce invoicing solution that is available through the Harvest Media Public API.
\nAt a top level, what this solution offers is as follows;
\nPlease note that the solution provided here does not aim to handle or manage the actual taking of payment for the invoice. As a result the process of taking payment via a Payment Gateway is one that will need to be handled externally to any Harvest Media process.
\nAll of the methods that return Region information will denote whether a region has an associated licensing model or not.
\nAs a result region responses should be relied on when deciding whether to display a licensing icon to your users or not.
\nIn general, the following steps should be taken when creating an invoice.
\nIdentify the currency with which to retrieve/display rates in
\nThere are two steps to this; first to retrieve a region based on the users location, and then secondly to retrieve rates based on the currency associated with that region.
\nIn order to do the first of these steps you will find that all methods that return Region information will contain a currency code field.
\nYou would then look to provide this currency code in the request object when retrieving Rate information, which would satisfy the second step.
\nAn example:
\nMethod
\n\nprovides property currency code as part of it's response
\nMethod
\n\nallows a currency code as part of it's request
\nRequest an unpaid invoice to be created
\nRequest creation of an unpaid invoice by utilising the \"Create Invoice\" method.
\nTake payment via a Payment Gateway
\nAs noted earlier this should be handled externally.
\nUpdate the previously created unpaid invoice to a paid status
\nRequest updating of the invoice to a paid state by utilising the \"Pay Invoice\" method.
\nRequest an email to be sent with associated PDF invoice
\nAs part of the \"Pay Invoice\" method, we have provided options that determine whether an email should be sent or not.
\nBoth members and guest members can submit invoices, though ultimately the decision as to whether to allow guests to be able to submit an invoice is up to your implementation.
\nWhen creating, paying, or retrieving invoices you will need a member token. This member token will be different depending on whether it is a member or guest submission.
\nMembers
\nFor members, this is quite straight forward as it is the members' Member Token that is to be used.
\nGuests
\nFor guests, this is a little more complicated. You must NOT use the guest Member Token for that region - instead a temporary member needs to be created. To do so, you will need to have the guest provide (at minimum) their email address. This will be used to create a temporary member and the associated Member Token which is to then be used when creating, paying or retrieving invoices for that guest.
\nAs an important aside, if that temporary member later comes to your site and registers using the same invoice then the invoice that they had purchased will appear on their account once they have been approved and are logged in.
\nYou can create a temporary member using the
\n\n.
\nThere are a number of ways to retrieve an invoice.
\nWhen the unique InvoiceID is known
\nWhen the InvoiceID is known, then method \"Get Invoice\" should be used to retrieve the invoice.
\nWhen the unique InvoiceID is not known
\nWhen no InvoiceID is known and you are looking to retrieve a listing of all invoices for a member then method \"Search Invoices\" should be used.
\nWhen choosing a Payment Provider you may like to ensure that you can associate custom fields alongside payment transactions.
\nThe aim here would be to store various Harvest Media identifiers alongside the transacton such that it would be possible to identify the corresponding Harvest Media Invoice from a transaction within the Payment Provider. We would recommend storing;
\nCreates an invoice based on the associated invoice line items.
\nRequest Elements
\nRequest Notes: Invoice
\nRequest Notes: Invoice Line Items
\nThere should be one of these for every unique item on the invoice.
\nRequest Notes: Invoice Line Items - References
\nEach unique item on the invoice will have 2 of these; one of type \"Track\" and another of type \"Rate\".
\nFor Subscription, it could either have only one reference line item of type \"Subscription\" or another type \"SubscriptionDiscount\" when voucher code applies.
\nRequest Notes: Production
\nOptional. This is not an array and will only ever be a single production. This does not need to be provided and should only be used when a production is to be specified as part of the invoice creation. If a production is provided then there are specific fields (listed below) that need to be provided as part of the production object.
\nResponse Notes
\nOn invoice creation success, the response will be the invoice that was created. This will contain the relevant InvoiceID that will be needed to mark the invoice as paid or to retrieve it.
\n","urlObject":{"path":["addinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0b0e37f0-1819-4215-8df9-3d138078480a","name":"Create Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Gets an invoice.
\nRequest Elements
\nRequest Notes
\nResponse Notes
\nInvoices of any status can be retrieved.
\n","urlObject":{"path":["getinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b175815c-8e77-4f4a-bb89-d4a2d0304565","name":"Get Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"XADTV 1\n Voids an invoice.
\nRequest Elements
\nRequest Notes
\nRequest Notes
\nOnly invoices of Pending status can be voided.
\n","urlObject":{"path":["voidinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"26a46b69-a809-4177-92b7-c1806c08dcf1","name":"Void Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"invoiceid\":\"1566j98a142a09625v\",\r\n\t\"reason\":\"Reason\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/voidinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Jun 2020 04:59:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"bc99167d-0c73-45e7-a72b-f80177cb5b0a","name":"Void Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"OK\nSearch invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["searchinvoices","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b70289cd-0de4-42d4-8dc4-0a285910832d","name":"Search Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Pays a pending state invoice.
\nRequest Elements
\nRequest Notes: Payment
\nRequest Notes: CardInfo (Required for Subscription)
\nRequest Notes: Misc
\nThere should be one of these for every unique item on the invoice.
\nResponse Notes
\nOn invoice creation success, the response will be the invoice that was paid. This will contain the relevant InvoiceID that will be needed to mark the invoice as paid or to retrieve it.
\n","urlObject":{"path":["payinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"26a2b7e5-7b1c-4e0b-b257-c0c0f632dd14","name":"Pay Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"invoicepayment\":{\r\n\t\t\"invoiceid\":\"1566j98a142a09625v\",\r\n\t\t\"amount\":1.00,\r\n\t\t\"contactname\":\"first.last@company.net\",\r\n\t\t\"date\":\"2020-01-07\",\r\n\t\t\"paymenttype\":\"Paypal\",\r\n\t\t\"paymentreferencenumber\":\"1a9-icp209329da\",\r\n\t\t\"paymentstatus\":\"Paid\"\r\n\t},\r\n\t\"sendemail\":\"true\",\r\n\t\"bccemail\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/2f30cde70021a012fc1f575w3471eam7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 10 Jan 2020 01:05:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"1566j98a142a09625v\",\n \"memberaccountid\": \"0ua1b339158cd76hy0\",\n \"issuedate\": \"2020-01-10T11:04:22.387\",\n \"duedate\": \"2020-02-09T11:04:22.387\",\n \"totaltax\": 0.09,\n \"subtotal\": 0.91,\n \"total\": 1,\n \"invoicenumber\": 6351,\n \"status\": \"Paid\",\n \"currencycode\": \"AUD\"\n }\n}"},{"id":"eb4f35fe-21d3-4260-995b-507d3b8c45c6","name":"Pay Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Returns a URL that can be used to download an invoice receipt.
\nRequest Elements
\n","urlObject":{"path":["getinvoicedownloadurl","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_InvoiceID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"984af795-0c76-482d-9d16-e7d7e50274ed","name":"Get Invoice Document (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getinvoicedownloadurl/2f30cde70021a012fc1f575w3471eam7/1566j98a142a09625v"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Sep 2020 01:45:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Url\": \"{domain}/INV001.pdf\"\n}"},{"id":"13b93ecb-a279-4b98-afc1-479e62c0d36c","name":"Get Invoice Document (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getinvoicedownloadurl/2f30cde70021a012fc1f575w3471eam7/1566j98a142a09625v"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 07 Sep 2020 01:49:30 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nThe following method should be used for admin login.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getmanagementtoken","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"08b2e46d-24f3-4c16-8f10-3cb3042c7983","name":"Authenticate Management Token (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"UserName\":\"adminusername\",\r\n\t\"Password\":\"adminpassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getmanagementtoken/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Mar 2022 23:36:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"ManagementToken\": {\n \"Value\": \"5ab274a543f7719111eb588400f5da9ac7\",\n \"Expiry\": \"2022-03-30T10:36:28.26\",\n \"UTCOffset\": 11,\n \"Type\": \"ManagementUserToken\",\n \"IsOfSingleUse\": false,\n \"ForcePasswordReset\": false\n }\n}"},{"id":"6bd19fff-b7c3-45d8-9fbb-23466890143f","name":"Authenticate Management Token (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"Updates an existing member group.
\nRequires elevated Admin permissions.
\nWill return an error if the request data is not valid.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["updatemembergroup","{{HM_ServiceAPI_ManagementToken}}","{MemberGroupID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f20d05f9-d830-4c76-bc9c-52da1edd9af0","name":"Update Member Group Details (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"MemberGroup\":{\r\n \"DownloadEnabled\":\"true\",\r\n \"DownloadStem\":\"true\",\r\n \"DownloadLimit\":\"\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemembergroup/{{HM_ServiceAPI_ManagementToken}}/86c599b15073d4ca2c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Apr 2022 23:56:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"MemberGroup\": {\n \"ID\": \"86c599b15073d4ca2c\",\n \"AssignedRegionChangeEnabled\": false,\n \"Type\": \"Primary\",\n \"ProductionsCount\": 0,\n \"DownloadEnabled\": \"true\",\n \"DownloadStem\": \"true\",\n \"DownloadLimit\": \"NULL\",\n \"DownloadsRemaining\": \"NULL\",\n \"DownloadsUsed\": \"NULL\"\n }\n}"},{"id":"b566ace6-4f0a-4114-8683-0e5f81360400","name":"Update Member Group Details (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/xml"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"The Harvest Media Public API allows clients to leverage off assets within the Harvest Media platform. It provides access to audio and metadata, transcoding, member management, download, sample and search functions.
\nSome great examples of outcomes delivered via this API include:
\nThe Harvest Media Public API is a RESTful webservice implemented as XML or JSON over HTTPS using GET & POST.
\nSecurity & oAuth 2.0
\nThe Harvest Media Public API utilises oAuth 2.0 for designated authorisation.
\nTo access the API you will need the following;
\nClient ID
\nClient Secret
\nAccess Key
\nAuthorization Endpoint
\nAPI Endpoint
\nTo request access to the API for your account you will need to contact us at
\n\n. Once access has been granted we will provide you with details on all five of the above elements so that you can begin integrating and consuming the API.
\nPlease note that the Client ID, Client Secret and Access Key act as gateways to unlocking access to your account and as such should be kept confidential and not provided to any third party, under any circumstance. For developers, these must be kept server side and are never to be made available (in any capacity) to a clients browser - including Javascript for AJAX if implementing using JSON requests.
\n","event":[{"listen":"prerequest","script":{"id":"423ad690-f323-460a-adee-02ea73071e7d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e72cf58-1499-4661-8a0d-da9df1369dbb","type":"text/javascript","exec":[""]}}],"_postman_id":"2ec2f286-b390-4b51-847b-685216d31ec6"},{"name":"Export API","item":[{"name":"Getting Started","item":[{"name":"Implementation Guide - Getting Started","id":"db603cfc-468b-4bc7-9e6c-9bcc4ae1db75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"Access Token
\nAuthorization is the first development step in integrating with the API. To do so you will need the Access key outlined in the Getting Access section above.
\nIn response to authorizing with the API you will be provisioned an Access Token.
\nService Token
\nThe second step is to obtain a Service Token using the provisioned Access Token. A Service Token represents a claim on the API, essentially acting as the means by which the API verifies access to specific methods.
\nToken Expirations
\nBoth Access & Service Tokens are expiration-based, which means they can, and will, expire. The expiration date is provided as part of the response and will help to determine when a renewal is required.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"db603cfc-468b-4bc7-9e6c-9bcc4ae1db75"},{"name":"Get Access Token","event":[{"listen":"test","script":{"id":"00464253-d03b-40a9-a88f-3c87bd0c7b31","exec":["var jsonData = xml2Json(responseBody);","console.log(jsonData.responseaccesstoken.token.$.value);","postman.setEnvironmentVariable(\"HM_ExportAPI_AccessToken\", jsonData.responseaccesstoken.token.$.value);"],"type":"text/javascript"}}],"id":"34d59c39-364b-4957-8182-57829588deeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HM_ExportAPI_URL}}/getaccesstoken/{{HM_ExportAPI_Key}}","description":"To access the Harvest Media Export API you will need to acquire a Access Token.
\nOnce a Access token has been issued, the user will have access to the API.
\nThe Access Token authenticates the AccessKey and issues access to the webservice.
\nRequest Elements
\n","urlObject":{"path":["getaccesstoken","{{HM_ExportAPI_Key}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ba09a8ba-713e-4f29-9675-81febb5d120c","name":"Get Access Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ExportAPI_URL}}/getaccesstoken/{{HM_ExportAPI_Key}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Date","value":"Mon, 26 Aug 2019 12:23:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"299"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns a list of available track download formats and the download URL.
\nRequest Elements
\n","urlObject":{"path":["getaccessinfo","{{HM_ExportAPI_AccessToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4a8783ea-835e-4836-81e8-83647519c911","name":"Get Access Info (Download formats & URL)","originalRequest":{"method":"GET","header":[],"url":"{{HM_ExportAPI_URL}}/getaccessinfo/{{HM_ExportAPI_AccessToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 29 Jul 2024 08:02:53 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"498"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nThis operation will return the details of all access accounts.
\nRequest Elements
\n","urlObject":{"path":["getaccessaccounts","{{HM_ExportAPI_AccessToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8195146c-0145-4d36-9523-ca0af76028a0","name":"Get Access Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ExportAPI_URL}}/getaccessaccounts/{{HM_ExportAPI_AccessToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Date","value":"Mon, 26 Aug 2019 12:23:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"299"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis operation will return the details of the service token.
\nDate format will be UTC+10 or UTC+11 and shown as YYYY-MM-DDTHH:MM:SS:SSS.
\nReturns Service Token details details which include:
\nRequest Elements
\n","urlObject":{"path":["getsessiontoken","{{HM_ExportAPI_AccessToken}}","{{Username}}","{{Password}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[{"key":"accessaccountid","value":"430f25d8e56cfadf"}],"variable":[]}},"response":[{"id":"79dedde1-13d7-4890-b290-d9a5a6f70afe","name":"Get Session Token (XML)","originalRequest":{"method":"GET","header":[],"url":"{{HM_ExportAPI_URL}}/getsessiontoken/{{HM_ExportAPI_AccessToken}}/username/password"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Date","value":"Thu, 29 Aug 2019 01:03:05 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"301"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis operation will expire the provided Session Token immediately.
\nAny subsequent calls to the API using the provided Service Token will result in an error response.
\nRequest Elements
\n","urlObject":{"path":["expiretoken","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"9f466fe1-ffd4-4bf7-8bcd-9ff3c9460ca4","name":"Expire Session Token (XML)","originalRequest":{"method":"GET","header":[],"url":"{{HM_ExportAPI_URL}}/expiretoken/{{HM_ExportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Date","value":"Thu, 29 Aug 2019 01:06:26 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nOK\nOK\nOK\nOK\nThe below mentioned methods will return a list of albums that are either new or have had recent metadata changes.
\nUtilise
\n\nto find Labels/Libraries that contain albums that are available for downloading to the workspace.
\nAlbums within the workspace can be in four different states; NeverCopied, InWorkspace, MetadataChanged, and PreviouslyCopied.
\nAn album will remain in the NeverCopied state until the album has been downloaded to the workspace. Once an album has met this condition it will move into the InWorkspace state.
\nUtilise
\nGet Albums By Workspace Status
\nto retrieve albums for a Label/Library that are available for downloading to the workspace.
\nUtilise
\n\nto download an album into the workspace.
\nUtilise
\n\nto set the provided tag on an album in the workspace.
\nUtilise
\n\nto remove the provided tag from an album in the workspace.
\nStep 1: Saving \"never copied\" albums to the workspace
\nCall getalbumsbyworkspacestatus with status=“NeverCopied” and notcontainstags=”Processed”
\nCall getmusicdownload for each album you want to save to the workspace
\nStep 2: Get workspace items and copy
\nCall getalbumsbyworkspacestatus with status=“InWorkspace” and notcontainstags=”Processed”
\nCall getworkspacealbumitems for each album and use the downloadtoken to download (see assetURL)
\nSave album metadata from the getalbumsbyworkspacestatus response
\nSave track audio and metadata using items in the getworkspacealbumitems response
\nConfirm you have successful extracted metadata and audio
\nCall setalbumtag tag =”Processed\"
\nStep 1: Re-save \"metadata changed\" albums to the workspace
\nCall getalbumsbyworkspacestatus with status=“MetadataChanged”
\nCall removealbumtag tag =”Processed” if it exists
\nCall getmusicdownload for each album you want to re-save to the workspace
\nStep 2: Get workspace items and copy
\nStep 1: Re-save \"previously copied\" albums to the workspace, items you didn't pick up in time
\nCall getalbumsbyworkspacestatus with status=“PreviouslyCopied” and notcontainstags=”Processed”
\nCall getmusicdownload for each album you want to save to the workspace
\nStep 2: Get workspace items and copy
\nThe below mentioned methods can be used to download track audio and metadata om receipt of messages delivered to an http endpoint.
\nA notification service can be established to send messages to an http endpoint providing a feed of audio and metadata changes. This feed can be utilised to download audio and metadata into
\nUtilise Get Workspace Items By Track to retrieve track audio and metadata from the work workspace.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"a9f64fed-b2be-4f45-9fe8-65172a769797"},{"name":"Download INFO","id":"10dad314-5e35-4103-8858-7aa747ce6871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"Option 1: Download tracks from URL
\nCall getalbumsbyworkspacestatus with status'; \"NeverCopied\", \"PreviouslyCopied\", and \"MetadataChanged\"
\nCall getmusicdownload to begin preparing the album for download
\nCall getalbumsbyworkspacestatus with status=\"InWorkspace\" to retrieve albums ready for download
\nCall getworkspacealbumitems to retrieve albums items, including track audio, album art and track metadata
\nUse the downloadtoken in the URL to request files
\nOption 2: Download tracks from s3
\nContact us to gain access to S3 workspace bucket. You will need to provide us with an IAM account so that we can configure access for your user
\nCall getaccessinfo, you will need the download format
\nCall getalbumsbyworkspacestatus with status'; \"NeverCopied\", \"PreviouslyCopied\", and \"MetadataChanged\"
\nCall getmusicdownload to begin preparing the album for download
\nCall getalbumsbyworkspacestatus with status=\"InWorkspace\" to retrieve albums ready for download
\nCall getworkspacealbumitems to retrieve albums items, including track audio, album art and track metadata
\nUse the S3Bucket and S3Key provided in the getworkspacealbumitems response to download or copy from the S3 workspace bucket
\n<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<responsetracks xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n <version>638556255987787178</version>\n <tracks>\n <track mood=\"\" musicfor=\"\" tracknumber=\"002\" lengthseconds=\"126\" comment=\"Like a Balkan 'Road Movie', this ballad explodes with carefree passion, featuring lone instruments of brass and piano.\" composer=\"Alexandros Bazanis\" publisher=\"Miles of Music\" artist=\"Alexandros Bazanis\" name=\"Romani Song\" id=\"b3a438536223139664a5d68a9ad930de\" keywords=\"Carefree, Quirky, Whimsical, Sincere, Passionate, Funny, Balkan, Romania, Serbia, Moldova\" lyrics=\"\" displaytitle=\"Romani Song\" genre=\"Ethnic, World, Folk, Mediterranean, Acoustic\" tempo=\"Slow\" instrumentation=\"Piano, Trumpet, Tuba\" bpm=\"80\" version=\"Main\" isalternate=\"False\" trackcode=\"\" trackidentity=\"807afeb4bf21297f88be10af61a87be56b6b4a5a\" iscached=\"false\" libraryfeatured=\"false\" highlighted=\"false\" originator=\"false\" haslyrics=\"false\" isexplicit=\"false\">\n <alternates/>\n <alternatetracks/>\n <relatedtracks/>\n <categories/>\n <relations/>\n <composers/>\n <codes>\n <code systemcode=\"ISRC\" name=\"ISRC\" value=\"IL7632401298\" comments=\"\"/>\n </codes>\n <rightholders/>\n <rightholder>\n <rightholder firstname=\"Alexandros\" middlename=\"\" lastname=\"Bazanis\" ipi=\"866163414\" capacity=\"WRITER\" ownerperformanceshare=\"100.00\" ownermechanicalshare=\"0.00\" territory=\"WORLD\" collectingsocietyname=\"BMI\" originalpublisher=\"Miles of Music\"/>\n <rightholder name=\"Miles of Music\" ipi=\"633301685\" capacity=\"PUBLISHER\" ownerperformanceshare=\"100.00\" ownermechanicalshare=\"100.00\" territory=\"WORLD\" collectingsocietyname=\"ACUM\"/></rightholder>\n <tags/>\n <stem/>\n <languageitems/>\n <evokesegments/>\n <highlightedinplaylists/>\n </track>\n </tracks>\n <album releasedate=\"4/4/2024 12:00:00 AM\" code=\"SHLM031\" detail=\"Beautifully melodic, nostalgic musical tracks from the Aegean Mediterranean and Middle East, featuring authentic instruments and audacious rhythms.\" name=\"Mediterranean Postcards\" displaytitle=\"SHLM031 Mediterranean Postcards\" keywords=\"Mediterranean, Aegean, Exotic, Drama, Documentary, History, Love, Emotion, Pride, Sentimental, Bouzouki, Accordion, Strings, Violin, Synthesizer, Piano, Electric Piano, Organ, Kanun, Duduk, Saz, Baglama, Lute, Kanun dulcimer, Kamance Violin, Rabab violin, Drum kit, Timpani, Hand Percussion, Moody, Sands, Culture, Ethnic, Eastern, Oriental, Global, World, Oud, Electric Guitar, Acoustic Guitar, Electronic Drums, Taiko, Daf drum, Tar drum, Darbuka drum, Riq drum, Incidental Percussion, Sagat bells, Tura finger cymbals, Tambourine, Shaker, Bells, Chimes, Italy, Greece, Turkey, Middle East, Palestine, Arab, Desert\" id=\"7cead1b9468ebca9\" tags=\"\" identity=\"0eb7ef69cc76dcc0e04a3eb429674346486335ec\" libraryfeatured=\"false\">\n <codes>\n <code systemcode=\"UPC\" name=\"UPC\" value=\"608539220458\" comments=\"\"/>\n </codes>\n <styles>\n <style>\n <id>eb4kjfb45cd8a2f8</id>\n <name>Drama</name>\n <languageitems/>\n <hasartwork>false</hasartwork>\n <trackscount>0</trackscount>\n <albumscount>0</albumscount>\n <playlistscount>0</playlistscount>\n </style>\n <style>\n <id>d7akj9627ab0dcdf</id>\n <name>Global</name>\n <languageitems/>\n <hasartwork>false</hasartwork>\n <trackscount>0</trackscount>\n <albumscount>0</albumscount>\n <playlistscount>0</playlistscount>\n </style>\n </styles>\n </album>\n <library name=\"Shallam\" id=\"804fc25b7ac591f0\" location=\"\" website=\"\" profile=\"\" featured=\"false\" displayname=\"\" description=\"Desert music, rich with culturally diversified offerings from and around the Middle East, Mediterranean, and Balkan.\" code=\"SHLM\" manufacturer=\"\">\n <libraryattributes/>\n <codes>\n <code systemcode=\"LC CODE\" name=\"LC Code\" value=\"101242\" comments=\"\"/>\n </codes>\n </library>\n</responsetracks>\n\nThe workflows below are optimised to help move metatdata and audio to a 3rd party platform.
\n","event":[{"listen":"prerequest","script":{"id":"2157b5c7-9359-4f92-835c-35b32e482add","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"18893247-c28b-4005-81d8-a63d5ac5c078","type":"text/javascript","exec":[""]}}],"_postman_id":"1fc28e2d-5b8d-4007-af27-085ad8ae52ba"},{"name":"Working within the Workspace","item":[{"name":"Get Labels/Libraries","id":"c22f3a41-af58-4ccc-b77b-6d5ff0f8c0ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HM_ExportAPI_URL}}/getlibraries/{{HM_ExportAPI_SessionToken}}","description":"Returns Labels/Libraries that contain albums that are available for downloading to the workspace.
\nRequest Elements
\n","urlObject":{"path":["getlibraries","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0f181c30-49db-4551-afce-39810f8a60a8","name":"Get Labels/Libraries (XML)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"}],"url":"{{HM_ExportAPI_URL}}/getlibraries/{{HM_ExportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Date","value":"Thu, 29 Aug 2019 01:16:35 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"188"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns Labels/Libraries in all statuses
\nRequest Elements
\n","urlObject":{"path":["getlibrariesallstates","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"dcc06923-359c-4eac-bf1a-600112809ddb","name":"Get Labels/Libraries All States","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{publicWcfUrlLive}}/ExportService.svc/getlibrariesallstates/{{ _.sessionToken }}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 11 Feb 2026 00:00:37 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"6437"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns albums that are available for downloading to the workspace based on a Label/Library, format, workspace status, and tag filter (contains and not contains).
\nRequest Elements
\nRequest Notes
\nRequest Notes: Workspace Status
\nAlbums within the workspace can be in four different states; NeverCopied, InWorkspace, MetadataChanged, PreviouslyCopied, Error, and Withdrawn:
\n\"NeverCopied\" - either never requested or hasn't successfully transferred to workspace (i.e. was requested but failed)
\n\"InWorkspace\" - currently available in workspace
\n\"MetadataChanged\" - metadata has changed on the album since it was last copied to workspace
\n\"PreviouslyCopied\" - has previously been transferred to workspace
\n\"Processing\" - has been requested, but it is not yet available in the workspace
\n\"Error\" - an error has occurred. Please, contact support
\n\"Withdrawn\" - a previously copied album that has been withdrawn from the Harvest Distributor account.
\nRequest Notes: Contains Tags
\nContainsTags can be a comma separated list of tags that ALL must be contained in the album's tags for the album to be returned in search results.
\nIf nothing is specified, search results won't be filtered by ContainsTags and will return results based on the other parameters in the request (i.e. library, format, workspace status etc)
\nRequest Notes: Not Contains Tags
\nNotContainsTags can be a comma separated list of tags that ALL must NOT be contained in the album's tags for the album to be returned in the search results.
\nIf nothing is specified, search results won't be filtered by NotContainsTags and will return results based on the other parameters in the request (i.e. library, format, workspace status etc)
\n","urlObject":{"path":["getalbumsbyworkspacestatus","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"51528199-0d81-42a1-a67b-ed05fe0a66c0","name":"Get Albums by Workspace Status (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"Returns all tracks, and other assets, for an album in the workspace. The response will also include the S3 bucket in which it resides and key for each.
\nRequest Elements
\nThe response includes properties [hashsum] and [version]. This can be used to determine if previously
downloaded itemtypes (TrackMetadata, TrackAudio) have been altered.
[hashsum] can be stored and compared in subsequent requests to confirm if the data has changed.
\nPlease note that the [version] field will increment for every request however [hashsum] will only change when the
actual data in the TrackAudio or TrackMetadata is different.
To get the metadata:
\nRunning getworkspacealbumitems will provide you with a very brief response of the album's tracks
Within , there'll be an itemtype=\"AlbumMetadata\" containing a downloadtoken that allows you to download the track metadata via direct download, similar to how you download tracks (https://dl.harvestmedia.net/downloads/{downloadtoken})
This will provide you with the tracks' metadata.xml
Returns all tracks, and other assets, for an album in the workspace. The response will also include the S3 bucket in which it resides and key for each.
\nRequest Elements
\nThe response includes properties [hashsum] and [version]. This can be used to determine if previously
downloaded itemtypes (TrackMetadata, TrackAudio) have been altered.
[hashsum] can be stored and compared in subsequent requests to confirm if the data has changed.
\nPlease note that the [version] field will increment for every request however [hashsum] will only change when the
actual data in the TrackAudio or TrackMetadata is different.
To get the metadata:
\nRunning getworkspacetrackitems will provide you with a very brief response of the album's tracks
Within , there'll be an itemtype=\"TrackMetadata\" containing a downloadtoken that allows you to download the track metadata via direct download, similar to how you download tracks (https://dl.harvestmedia.net/downloads/{downloadtoken})
This will provide you with the tracks' metadata.xml
EndFragment
\n","urlObject":{"path":["getworkspacetrackitems","{{HM_ExportAPI_SessionToken}}","{TrackID}","{Format}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a882fb26-2d2e-432f-b8f0-57b3f015573d","name":"Get Workspace Items By Track (XML)","originalRequest":{"method":"GET","header":[],"url":"{{HM_ExportAPI_URL}}/getworkspacetrackitems/{{HM_ExportAPI_SessionToken}}/{TrackID}/{Format}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private","description":"","type":"text"},{"key":"Content-Type","value":"application/xml","description":"","type":"text"},{"key":"Date","value":"Wed, 28 Aug 2019 05:19:32 GMT","description":"","type":"text"},{"key":"Server","value":"Microsoft-IIS/8.0","description":"","type":"text"},{"key":"X-AspNet-Version","value":"4.0.30319","description":"","type":"text"},{"key":"X-Powered-By","value":"ASP.NET","description":"","type":"text"},{"key":"transfer-encoding","value":"chunked","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nRequests an album or track gets moved to the Workspace in the desired format.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getmusicdownload","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4a50d3da-5648-43b8-8886-759e31f96dfd","name":"Get Workspace Download (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"Sets a tag on an album.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["setalbumtag","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6f2fb823-2f44-477b-8ea0-2ca929bde19d","name":"Set Album Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"OK\nRemoves a tag from an album.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["removealbumtag","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"257c93f9-2784-487f-9487-7aa1ffc85bc7","name":"Remove Album Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"OK\nManages category attributes and their assignments to tracks.
\nUsing this method, you can;
\nRequest Elements
\nRequest Notes: RequestExportTracksCategories
\nRequest Notes: RequestExportTracksCategories > TrackCategories > TrackCategory
\nNotes: DeleteAllCategories
\nThis option should be used if you do not wish to micro-manage the adding and deleting of individual categories.
\nNotes: Separator
\nIn the examples you will notice the following character, \":\", appear within the CategoryAttributeName element. This is to be used to create a parent/child tree structure. For example \"Pop:Pop Rock\" will create a category attribute Pop with a child element Pop Rock. It's important to note that when using the separator, the TrackIDs provided in the request are assigned to the child only. This means that in the \"Pop:Pop Rock\" example its actually \"Pop Rock\" that is bound to the tracks, whilst the parent element \"Pop\" only has a reference to the child category attribute and not to any tracks.
\nNotes: Deleting
\nThere are two ways in which the Delete element can be used;
\nWhen attempting to remove a specific category attribute, you must include the CategoryName and CategoryAttributeName Elements. When attempting to remove all category attributes, only the CategoryName is required and the CategoryAttributeName element should not be provided.
\n","urlObject":{"path":["bulkupserttrackcategories","{{HM_ExportAPI_SessionToken}}"],"host":["{{HM_ExportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d206acc2-a58d-425a-9261-ccb727a572f7","name":"Upsert Track Categories","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"OK\nUse the Export API to send your content to clients, networks, and third parties so that they can automate the deliver of audio and metadata into their systems instead of receiving deliveries to FTP.
\nWhen audio and metadata are changed in HarvestMedia, the workflows in the Export API know to resend this data automatically.
\nThe Export API allows clients to leverage off assets within the Harvest Media platform.
\nThe Export API is a RESTful webservice implemented as XML only.
\nEvery resource is assigned its own URL and is manipulated in isolation.
\nAccess Key & Service Endpoint
\nTo use the Harvest Media Export API you will need an Access Key and Service Endpoint. These are different credentials to those used by the Public API.
\nTo request an API Access Key for your account contact support@harvestmedia.net
\nYour webservice access key will look similar to this:
\n6h659845645644a1cgh5648be89cdfce7c9568648e546394e2b446284b4a8a133pl89
\nImportant
\nAs with any API, re-generating the Web Service Access Key will disable the previously displayed Access Key and access to the webservice by any application that has been built to access the webservice using this key.
\n","event":[{"listen":"prerequest","script":{"id":"47d81493-a796-416f-bb05-920142a3bb1d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1c65cfc9-dd10-4ffd-88b6-f0aff7b9d414","type":"text/javascript","exec":[""]}}],"_postman_id":"82ee8bb0-c7c7-4238-846f-0f52416d4f98"},{"name":"Import API","item":[{"name":"Getting Started","item":[{"name":"Implementation Guide - Getting Started","id":"59de363d-2135-41e9-8873-3016e1e281de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"Access Token
\nAuthorization is the first development step in integrating with the API. To do so you will need the Access key outlined in the Getting Access section above.
\nIn response to authorizing with the API you will be provisioned an Access Token.
\nService Token
\nThe second step is to obtain a Service Token using the provisioned Access Token. A Service Token represents a claim on the API, essentially acting as the means by which the API verifies access to specific methods.
\nToken Expirations
\nBoth Access & Service Tokens are expiration-based, which means they can, and will, expire. The expiration date is provided as part of the response and will help to determine when a renewal is required.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"59de363d-2135-41e9-8873-3016e1e281de"},{"name":"Get Access Token","event":[{"listen":"test","script":{"id":"00464253-d03b-40a9-a88f-3c87bd0c7b31","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataToken = \"\";","","jsonData = JSON.parse(responseBody)","jsonDataToken = jsonData.Token.Value;","","console.log(\"HM_ImportAPI_AccessToken set to \" + jsonDataToken);","","postman.setEnvironmentVariable(\"HM_ImportAPI_AccessToken\", jsonDataToken);","","postman.setNextRequest(\"Get Session Token\");"],"type":"text/javascript"}}],"id":"b27738e6-6d22-40c2-a169-f055d87e729d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"AccessKey","value":"{{HM_ImportAPI_Key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/getaccesstoken","description":"Request Elements
\n","urlObject":{"path":["getaccesstoken"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"752f36d5-a93e-478c-99a7-e30f82f98b99","name":"Get Access Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"AccessKey","value":"{{HM_ImportAPI_Key}}","type":"text"}],"url":"{{HM_ImportAPI_URL}}/getaccesstoken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 22 Nov 2019 01:44:02 GMT"},{"key":"Content-Length","value":"158"}],"cookie":[],"responseTime":null,"body":"{\n \"Token\": {\n \"Value\": \"0cf6c307392c3886b58juf7fef2na4c672\",\n \"Expiry\": \"2019-11-22T13:44:02.36\",\n \"UTCOffset\": 11,\n \"IsOfSingleUse\": false\n }\n}"}],"_postman_id":"b27738e6-6d22-40c2-a169-f055d87e729d"},{"name":"Get Session Token","event":[{"listen":"prerequest","script":{"id":"f610dad2-a35b-4643-96ef-80192be35e9c","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"99de3f64-cabe-44f6-ab0f-00f8d2c89a93","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataToken = \"\";","","jsonData = JSON.parse(responseBody)","jsonDataToken = jsonData.Token.Value;","","console.log(\"HM_ImportAPI_SessionToken set to \" + jsonDataToken);","","postman.setEnvironmentVariable(\"HM_ImportAPI_SessionToken\", jsonDataToken);","","postman.setNextRequest(\"Get Labels/Libraries\");"],"type":"text/javascript"}}],"id":"8cf4e7f2-e038-4dbf-8a7b-3340090657fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/getsessiontoken/{{HM_ImportAPI_AccessToken}}/{Username}/{Password}","description":"This operation will return the details of the service token.
\nDate format will be UTC+10 or UTC+11 and shown as YYYY-MM-DDTHH:MM:SS:SSS.
\nReturns Service Token details details which include:
\nRequest Elements
\n","urlObject":{"path":["getsessiontoken","{{HM_ImportAPI_AccessToken}}","{Username}","{Password}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f3cc8de5-5e0b-41cb-9cae-afd0aef4b10e","name":"Get Session Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/getsessiontoken/{{HM_ImportAPI_AccessToken}}/username/password"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 13 Jan 2020 03:34:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Token\": {\n \"Value\": \"0cfy6c30739c3886b5dacdabe6d787d7av\",\n \"Expiry\": \"2020-01-13T15:34:59.043\",\n \"UTCOffset\": 11,\n \"IsOfSingleUse\": false\n }\n}"}],"_postman_id":"8cf4e7f2-e038-4dbf-8a7b-3340090657fb"},{"name":"Expire Session Token","event":[{"listen":"test","script":{"id":"6d8e9a3b-65bc-4b0e-b8c9-78946e090c6e","exec":[""],"type":"text/javascript"}}],"id":"fadfd870-f8bf-4915-b6f6-cca7e80b2adb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/expiretoken/{{HM_ImportAPI_SessionToken}}","description":"This operation will expire the provided Service Token immediately.
\nAny subsequent calls to the API using the provided Service Token will result in an error response.
\nRequest Elements
\n","urlObject":{"path":["expiretoken","{{HM_ImportAPI_SessionToken}}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"00a587d1-1d92-43bd-b701-fa37beb1ad0e","name":"Expire Session Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/expiretoken/{{HM_ImportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 13 Jan 2020 03:35:26 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"fadfd870-f8bf-4915-b6f6-cca7e80b2adb"}],"id":"7ab1b437-3f40-48e1-a216-636808dd4265","event":[{"listen":"prerequest","script":{"id":"adff0ccc-5dbf-4b6f-99d0-cf40d36971b2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4e9df14-ea09-4e88-95ab-0bb6cddc9cfb","type":"text/javascript","exec":[""]}}],"_postman_id":"7ab1b437-3f40-48e1-a216-636808dd4265","description":""},{"name":"Process Steps","item":[{"name":"Primary Workflows","id":"500d2355-7d49-417b-88a6-d5585760cb66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"Utilise
\n\nto find existing libraries
\nUtilise
\n\nto import a new library
\nUtilise
\n\nto update an existing library
\nAlbums within the workspace can be in five different states; MissingAsset, Ready, Processing, Error, or Imported.
\nAn album will remain in the MissingAsset state until; the album has an AlbumArt asset, and all tracks within the album have a TrackAudio asset. Once an album has met this condition it will move into the Ready state.
\nUtilise
\n\nto import a new album. The album state after importing in the workspace will be MissingAsset.
\nUtilise
\n\nto update an existing album. This method is available to albums in state MissingAsset or Ready.
\nUtilise
\n\nto remove an existing album from the workspace.
\nAn album within the workspace can take two different assets; AlbumArt, and/or AlbumMontage.
\nAlbumMontage is optional and has no bearing on the state of an album or whether the album can be published or not.
\nThere are 2 paths available here for supplying abum assets to be stored in Harvest Media:
\n1. Upload the asset to Harvest Media direct
\nUtilise
\n\nto retrieve a URL in which to upload the asset to.
\nPerform a PUT request using the URL retrieved from
\n\nin order to upload a file.
\nUtilise
\n\nto confirm that the upload has completed. This should be called after the PUT request has completed.
\n2. Provide a URL for Harvest Media to retrieve the asset from
\nUtilise
\n\nto provide a URL where the asset resides. This asset will be copied to Harvest Media during publish.
\nTracks within the workspace can be in five different states; MissingAsset, Ready, Processing, Error, or Imported
\nA track will remain in the MissingAsset state until the track has an TrackAudio asset. Once a track has met this condition it will move into the Ready state.
\nNote further, that for albums in the MissingAsset state they will contintue to be held in that state until all tracks for that album have an TrackAudio asset uploaded.
\nUtilise
\n\nfor one or more tracks. Note that the track state after importing in the workspace will be MissingAsset.
\nUtilise
\n\nto update an existing track. This method is avaialble to tracks in state MissingAsset or Ready.
\nUtilise
\n\nto remove an existing track from the workspace.
\nA track within the workspace can take one asset; TrackAudio.
\nThere are 2 paths available here for supplying abum assets to be stored in Harvest Media:
\n1. Upload the asset to Harvest Media direct
\nUtilise
\n\nto retrieve a URL in which to upload the asset to.
\nPerform a PUT request using the URL retrieved from
\n\nin order to upload a file.
\nUtilise
\n\nto confirm that the upload has completed. This should be called after the PUT request has completed.
\n2. Provide a URL for Harvest Media to retrieve the asset from
\nUtilise
\n\nto provide a URL where the asset resides. This asset will be copied to Harvest Media during publish.
\nWe recommend checking the workspace regularly in order to pick up and publish albums that have moved into a Ready state.
\nUtilise
\nGet Albums By Workspace Status
\nto retrieve albums that are within the workspace.
\nUtilise
\nGet Tracks By Workspace Album & State
\nto retrieve tracks for an album that is within the workspace.
\nUtilise
\n\nwhen the album state is Ready in order to publish it and it's tracks.
\nUtilise
\n\nwhen the track state is Ready in order to publish it. This method should only be used when publishing a track to an existing album, where that album has been published previously and is already in the Imported state.
\nUtilise
\n\nwhen the track state is Imported in order to unpublish it. This method should only be used when unpublishing a track from an existing album, where that album has been published previously and is already in the Imported state.
\nPublishing new albums within the Workspace
\nWhen an album is in the Ready state and \"Publish Album\" is called;
\nPublishing new tracks for an existing album that is already in the Imported state
\nThis process is only required when publishing a track to an existing album, where that album has been published previously and is already in the Imported state.
\nWhen an album is already in the Imported state and \"Publish Track\" is called;
\nReturns all attribute types.
\nRequest Elements
\n","urlObject":{"path":["getattributetypes","{{HM_ImportAPI_SessionToken}}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"dd9c21f0-b0ad-4956-822e-c4451c240b5d","name":"Get Attribute Types","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/getattributetypes/{{HM_ImportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jun 2020 05:40:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"AttributeTypes\": [\n {\n \"ID\": \"1a795d5ba9cte21dc1\",\n \"AccountID\": 0,\n \"AttributeTypeName\": \"Date Of Copyright\",\n \"AttributeTypeStyle\": 3,\n \"AttributeTypeFormat\": 2,\n \"Mandatory\": true,\n \"OneOnly\": false,\n \"SystemCode\": \"DateOfCopyright\",\n \"ParentID\": \"1ccc5f23nre970aoef\",\n \"ParentType\": 3,\n \"CategoryId\": -1,\n \"AttributeTypeGroup\": 0,\n \"Length\": 0,\n \"Status\": 0,\n \"MaxIteration\": 0,\n \"Group\": 0,\n \"OwnerAccountCode\": \"\",\n \"FormatRegex\": \"\"\n },\n {\n \"ID\": \"91fcd50gd4c6e435e5\",\n \"AccountID\": 0,\n \"AttributeTypeName\": \"Album Discs\",\n \"AttributeTypeStyle\": 2,\n \"AttributeTypeFormat\": 2,\n \"Mandatory\": true,\n \"OneOnly\": false,\n \"SystemCode\": \"AlbumDiscs\",\n \"ParentID\": \"1pccf2350fea720aef\",\n \"ParentType\": 3,\n \"CategoryId\": -1,\n \"AttributeTypeGroup\": 0,\n \"Length\": 0,\n \"Status\": 0,\n \"MaxIteration\": 0,\n \"Group\": 0,\n \"OwnerAccountCode\": \"\",\n \"FormatRegex\": \"\"\n },\n {\n \"ID\": \"145596qe6816v8819f\",\n \"AccountID\": 0,\n \"AttributeTypeName\": \"ISRC\",\n \"AttributeTypeStyle\": 3,\n \"AttributeTypeFormat\": 2,\n \"Mandatory\": false,\n \"OneOnly\": true,\n \"SystemCode\": \"ISRC\",\n \"ParentID\": \"zcd0ibbf87c4d6621m\",\n \"ParentType\": 1,\n \"CategoryId\": -1,\n \"AttributeTypeGroup\": 0,\n \"Length\": 0,\n \"Status\": 0,\n \"MaxIteration\": 0,\n \"Group\": 1,\n \"OwnerAccountCode\": \"\",\n \"FormatRegex\": \"^([a-zA-Z]{2}-[0-9a-zA-Z]{3}-[0-9]{2}-[0-9]{5})|([a-zA-Z]{2}[0-9a-zA-Z]{3}[0-9]{7})$\"\n }\n ]\n}"}],"_postman_id":"22d85738-c140-4b94-abf1-c94e262f29d4"},{"name":"Get Labels/Libraries","event":[{"listen":"test","script":{"id":"5a094371-c66e-41bf-b014-9149ab275c49","exec":[""],"type":"text/javascript"}}],"id":"51f6b82c-cab8-4dad-b2fb-42224c1ca44d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/getlibraries/{{HM_ImportAPI_SessionToken}}","description":"Returns all labels/libraries.
\nRequest Elements
\n","urlObject":{"path":["getlibraries","{{HM_ImportAPI_SessionToken}}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6e20af9c-b86e-43d4-aa73-a21a3a2f63a1","name":"Get Labels/Libraries (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/getlibraries/{{HM_ImportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 15 Jan 2020 02:19:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Libraries\": [\r\n {\r\n \"LibraryIdentity\": \"492460494a2fdb51af9f1af240f90b1defc3a916te\",\r\n \"Name\": \"West One Music\",\r\n \"Codes\": [\r\n {\r\n \"SystemCode\": \"LC_Code\",\r\n \"AttributeTypeName\": \"LC Code\",\r\n \"Value\": \"\",\r\n \"Comments\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"LibraryIdentity\": \"4ubfb40608ca241a2247edd13d59j612e62af1e3d2\",\r\n \"Name\": \"Fired Earth Music\",\r\n \"Codes\": [\r\n {\r\n \"SystemCode\": \"LC_Code\",\r\n \"AttributeTypeName\": \"LC Code\",\r\n \"Value\": \"\",\r\n \"Comments\": \"\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"51f6b82c-cab8-4dad-b2fb-42224c1ca44d"},{"name":"Create Label/Library","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a5189202-0ea7-4bb8-9378-1cc625d882d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/library/{{HM_ImportAPI_SessionToken}}/insert","description":"Adds a new Label/Library to the workspace.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["library","{{HM_ImportAPI_SessionToken}}","insert"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cbaf698b-fb90-494e-b27b-f664e86dac31","name":"Create Label/Library (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"Name\",\r\n \"DisplayName\": \"Display Name\",\r\n \"Description\": \"Description\",\r\n \"Code\": \"CODE2\",\r\n \"Prefix\": \"\",\r\n \"Manufacturer\": \"\",\r\n \"Location\": \"\",\r\n \"Website\": \"\",\r\n \"Profile\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/library/{{HM_ImportAPI_SessionToken}}/insert"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Jan 2020 23:40:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\",\n \"LibraryIdentity\": \"4e02a54319fc102bd564dbd1ce644560d465a89451\"\n}"}],"_postman_id":"a5189202-0ea7-4bb8-9378-1cc625d882d5"},{"name":"Update Label/Library","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ec52488e-c378-494a-a716-d4c000bb61b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/library/{{HM_ImportAPI_SessionToken}}/update","description":"Updates an existing label/library.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["library","{{HM_ImportAPI_SessionToken}}","update"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7cbd7992-f5d0-4a71-8682-bb7c729ac4dd","name":"Update Label/Library (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"LibraryIdentity\": \"4e02a54319fc102bd564dbd1ce644560d465a89451\",\r\n \"Name\": \"Name3\",\r\n \"DisplayName\": \"Display Name3\",\r\n \"Description\": \"Description3\",\r\n \"Code\": \"CODE3\",\r\n \"Prefix\": \"\",\r\n \"Manufacturer\": \"\",\r\n \"Location\": \"\",\r\n \"Website\": \"\",\r\n \"Profile\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/library/{{HM_ImportAPI_SessionToken}}/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Jan 2020 23:53:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\",\n \"LibraryIdentity\": \"4e02a54319fc102bd564dbd1ce644560d465a89451\"\n}"}],"_postman_id":"ec52488e-c378-494a-a716-d4c000bb61b3"},{"name":"Create Album","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"be3d640a-e896-467e-baa7-fbf76db13a1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/album/{{HM_ImportAPI_SessionToken}}/insert","description":"Creates a new album in the workspace.
\nNew albums will move into the MissingAsset state by default.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["album","{{HM_ImportAPI_SessionToken}}","insert"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"63def6de-98bf-46a9-b831-1313b40aa048","name":"Create Album (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"LibraryIdentity\": \"4e02a54319fc102bd564dbd1ce644560d465a89451\",\r\n \"Title\": \"Title\",\r\n \"DisplayTitle\": \"Display Title\",\r\n \"Description\": \"Description\",\r\n \"AlbumCode\": \"ALBUM-CODE\",\r\n \"Keywords\": \"Keywords, Keyword\",\r\n \"Tags\": \"Tags, Tag\",\r\n \"Styles\": \"Styles, Style\",\r\n \"ReleaseDate\": \"2020-01-15\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/album/{{HM_ImportAPI_SessionToken}}/insert"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Jan 2020 23:58:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Code\": \"OK\",\n \"AlbumIdentity\": \"1d37650a71827c6ec4f868b4c6c7b304dfak73be41\"\n}"}],"_postman_id":"be3d640a-e896-467e-baa7-fbf76db13a1d"},{"name":"Update Album","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript"}}],"id":"29aec49a-b612-4215-b428-d9e84622229a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/album/{{HM_ImportAPI_SessionToken}}/update","description":"Updates an existing album in the workspace.
\nOnly albums that are in the state MissingAsset and Ready can be updated.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["album","{{HM_ImportAPI_SessionToken}}","update"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cacfbefb-e1fe-4480-98dd-30c58eca1744","name":"Update Album (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"LibraryIdentity\": \"4e02a54319fc102bd564dbd1ce644560d465a89451\",\r\n \"AlbumIdentity\": \"1d37650a71827c6ec4f868b4c6c7b304dfak73be41\",\r\n \"Title\": \"Title\",\r\n \"DisplayTitle\": \"Display Title\",\r\n \"Description\": \"Description\",\r\n \"AlbumCode\": \"ALBUM-CODE\",\r\n \"Keywords\": \"Keywords, Keyword\",\r\n \"Tags\": \"Tags, Tag\",\r\n \"Styles\": \"Styles, Style\",\r\n \"ReleaseDate\": \"2020-01-15\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/album/{{HM_ImportAPI_SessionToken}}/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2020 00:03:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Code\": \"OK\",\n \"AlbumIdentity\": \"1d37650a71827c6ec4f868b4c6c7b304dfak73be41\"\n}"}],"_postman_id":"29aec49a-b612-4215-b428-d9e84622229a"},{"name":"Remove Album","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript"}}],"id":"e3023470-2ecb-43ff-9f1c-8e328e27e0bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ImportAPI_URL}}/album/{{HM_ImportAPI_SessionToken}}/{AlbumIdentity}","description":"Removes an existing album in the workspace.
\nOnly albums that are in the state MissingAsset can be removed.
\nRequest Elements
\n","urlObject":{"path":["album","{{HM_ImportAPI_SessionToken}}","{AlbumIdentity}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1ed189b0-d231-4d18-a392-3648d1f5b492","name":"Remove Album (JSON)","originalRequest":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/album/{{HM_ImportAPI_SessionToken}}/1d37650a71827c6ec4f868b4c6c7b304dfak73be41"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2020 00:05:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"e3023470-2ecb-43ff-9f1c-8e328e27e0bd"},{"name":"Get Albums By Workspace State","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript"}}],"id":"5f25b918-d3c9-4b8a-aa81-6e8fc6a615a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ImportAPI_URL}}/getalbumsbyworkspacestate/{{HM_ImportAPI_SessionToken}}","description":"Returns albums based on a label/library and a workspace state.
\nRequest Elements
\nRequest Notes
\nWorkspaceState can be one of the following values:
\nPublishes an album in the workspace.
\nOnly albums that are in the Ready state can be published.
\nAfter being published the album and its tracks will be in the Imported state.
\nRequest Elements
\n","urlObject":{"path":["album","{{HM_ImportAPI_SessionToken}}","{AlbumIdentity}","publish"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"780bd943-8218-447b-a6f0-d8d1819e30d5","name":"Publish Album & Tracks (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/album/{{HM_ImportAPI_SessionToken}}/1d37650a71827c6ec4f868b4c6c7b304dfak73be41/publish"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 01:03:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"3a07ce5a-e625-4d0e-a82f-d92b3887b1c6"},{"name":"Create Track","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript"}}],"id":"a6c3ea4d-28a5-4a0d-9deb-af7ae51f15ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/insert","description":"Creates a new track with an album in the workspace.
\nNew tracks will move into the MissingAsset state by default.
\nRequest Elements
\nRequest Notes: Track
\nRequest Notes: Track > Writers
\nRequest Notes: Track > Publishers
\nRequest Notes: Track > Artists
\nRequest Notes: Track > CategoryAttributes
\nRequest Notes: Track > Codes
\n","urlObject":{"path":["track","{{HM_ImportAPI_SessionToken}}","insert"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5975b680-b4de-4784-babd-f6c81c873f7b","name":"Create Track (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"tracks\": [\r\n {\r\n \"AlbumIdentity\": \"1d37650a71827c6ec4f868b4c6c7b304dfak73be41\",\r\n \"Title\": \"Title 1\",\r\n \"DisplayTitle\": \"Display Title 1\",\r\n \"TrackNumber\": \"01\",\r\n \"Description\": \"Description 1\",\r\n \"Keywords\": \"\",\r\n \"Genre\": \"Pop\",\r\n \"Mixout\": \"\",\r\n \"Version\": \"Main\",\r\n \"Mood\": \"\",\r\n \"MusicFor\": \"\",\r\n \"AlternateTitle\": \"\",\r\n \"OriginalFileName\": \"\",\r\n \"Writer\": \"\",\r\n \"Publisher\": \"\",\r\n \"Artist\": \"\",\r\n \"BPM\": \"\",\r\n \"Tempo\": \"\",\r\n \"Instrumentation\": \"\",\r\n \"Lyrics\": \"\",\r\n \"CategoryCodes\": \"\",\r\n \"IsMain\": true,\r\n \"MainTrackNumber\": \"\",\r\n \"Writers\": [\r\n\t {\r\n\t\t \"FirstName\": \"Paul\",\r\n\t\t \"MiddleName\": \"David\",\r\n\t\t \"LastName\": \"Madvidal\",\r\n\t\t \"Capacity\": \"Composer/Author\",\r\n\t\t \"PublisherName\": \"West One Music Group\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"ASCAP\",\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50\r\n\t }\r\n\t ],\r\n \t \"Publishers\": [\r\n \t {\r\n\t\t \"Name\": \"West One Music Group\",\r\n\t\t \"Capacity\": \"Original Publisher\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"PRS\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50,\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"OriginalPublisherName\": \"\"\r\n \t\t}\r\n \t ],\r\n \t \"Artists\": [\r\n {\r\n \"FirstName\": \"First\",\r\n \"MiddleName\": \"\",\r\n \"LastName\": \"Last\",\r\n \"IPI\": \"1234\",\r\n \"CollectingSocietyName\": \"ASCAP\"\r\n }\r\n ],\r\n \t \"CategoryAttributes\": [\r\n \t\t{\r\n\t\t \"Name\": \"Value\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ],\r\n \t \"Codes\": [\r\n \t\t{\r\n \t\t \"AttributeTypeID\": \"z9f6d50bd4c6e2a3e5\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ]\r\n },\r\n {\r\n \"AlbumIdentity\": \"1d37650a71827c6ec4f868b4c6c7b304dfak73be41\",\r\n \"Title\": \"Title 2\",\r\n \"DisplayTitle\": \"Display Title 2\",\r\n \"TrackNumber\": \"02\",\r\n \"Description\": \"Description 2\",\r\n \"Keywords\": \"\",\r\n \"Genre\": \"Pop\",\r\n \"Mixout\": \"\",\r\n \"Version\": \"Main\",\r\n \"Mood\": \"\",\r\n \"MusicFor\": \"\",\r\n \"AlternateTitle\": \"\",\r\n \"OriginalFileName\": \"\",\r\n \"Writer\": \"\",\r\n \"Publisher\": \"\",\r\n \"Artist\": \"\",\r\n \"BPM\": \"\",\r\n \"Tempo\": \"\",\r\n \"Instrumentation\": \"\",\r\n \"Lyrics\": \"\",\r\n \"CategoryCodes\": \"\",\r\n \"IsMain\": true,\r\n \"MainTrackNumber\": \"\",\r\n \"Writers\": [\r\n\t {\r\n\t\t \"FirstName\": \"Paul\",\r\n\t\t \"MiddleName\": \"David\",\r\n\t\t \"LastName\": \"Madvidal\",\r\n\t\t \"Capacity\": \"Composer/Author\",\r\n\t\t \"PublisherName\": \"West One Music Group\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"ASCAP\",\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50\r\n\t }\r\n\t ],\r\n \t \"Publishers\": [\r\n \t {\r\n\t\t \"Name\": \"West One Music Group\",\r\n\t\t \"Capacity\": \"Original Publisher\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"PRS\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50,\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"OriginalPublisherName\": \"\"\r\n \t\t}\r\n \t ],\r\n \t \"Artists\": [\r\n {\r\n \"FirstName\": \"First\",\r\n \"MiddleName\": \"\",\r\n \"LastName\": \"Last\",\r\n \"IPI\": \"1234\",\r\n \"CollectingSocietyName\": \"ASCAP\"\r\n }\r\n ],\r\n \t \"CategoryAttributes\": [\r\n \t\t{\r\n\t\t \"Name\": \"Value\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ],\r\n \t \"Codes\": [\r\n \t\t{\r\n \t\t \"AttributeTypeID\": \"z9f6d50bd4c6e2a3e5\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/insert"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2020 00:28:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TrackIdentities\": [\n \"z49231a543a6d922caee3fd4bdeb0g353f26f77f61\",\n \"d097sb9973cr2176601330chf017b72d5fb10ca9d3\"\n ]\n}"}],"_postman_id":"a6c3ea4d-28a5-4a0d-9deb-af7ae51f15ad"},{"name":"Update Track","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript"}}],"id":"8bc2b6c3-1b27-452b-bac2-5ec418ceeb51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/update","description":"Updates an existing track, within an album, in the workspace.
\nTracks that are in the state MissingAsset and Ready can be updated.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Track > Writers
\nRequest Notes: Track > Publishers
\nRequest Notes: Track > Artists
\nRequest Notes: Track > CategoryAttributes
\nRequest Notes: Track > Codes
\n","urlObject":{"path":["track","{{HM_ImportAPI_SessionToken}}","update"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b2436389-2602-48ea-81e7-3bc04ce0fd62","name":"Update Track (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"tracks\": [\r\n {\r\n \"TrackIdentity\": \"z49231a543a6d922caee3fd4bdeb0g353f26f77f61\",\r\n \"AlbumIdentity\": \"fcfa2796c2931a1a050c893ad8ahjeb6731f06432e\",\r\n \"Title\": \"Title 1\",\r\n \"DisplayTitle\": \"Display Title 1\",\r\n \"TrackNumber\": \"01\",\r\n \"Description\": \"Description 1\",\r\n \"Keywords\": \"\",\r\n \"Genre\": \"Pop\",\r\n \"Mixout\": \"\",\r\n \"Version\": \"Main\",\r\n \"Mood\": \"\",\r\n \"MusicFor\": \"\",\r\n \"AlternateTitle\": \"\",\r\n \"OriginalFileName\": \"\",\r\n \"Writer\": \"\",\r\n \"Publisher\": \"\",\r\n \"Artist\": \"\",\r\n \"BPM\": \"\",\r\n \"Tempo\": \"\",\r\n \"Instrumentation\": \"\",\r\n \"Lyrics\": \"\",\r\n \"CategoryCodes\": \"\",\r\n \"IsMain\": true,\r\n \"MainTrackNumber\": \"\",\r\n \"Writers\": [\r\n\t {\r\n\t\t \"FirstName\": \"Paul\",\r\n\t\t \"MiddleName\": \"David\",\r\n\t\t \"LastName\": \"Madvidal\",\r\n\t\t \"Capacity\": \"Composer/Author\",\r\n\t\t \"PublisherName\": \"West One Music Group\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"ASCAP\",\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50\r\n\t }\r\n\t ],\r\n \t \"Publishers\": [\r\n \t {\r\n\t\t \"Name\": \"West One Music Group\",\r\n\t\t \"Capacity\": \"Original Publisher\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"PRS\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50,\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"OriginalPublisherName\": \"\"\r\n \t\t}\r\n \t ],\r\n \t \"Artists\": [\r\n {\r\n \"FirstName\": \"First\",\r\n \"MiddleName\": \"\",\r\n \"LastName\": \"Last\",\r\n \"IPI\": \"1234\",\r\n \"CollectingSocietyName\": \"ASCAP\"\r\n }\r\n ],\r\n \t \"CategoryAttributes\": [\r\n \t\t{\r\n\t\t \"Name\": \"Value\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ],\r\n \t \"Codes\": [\r\n \t\t{\r\n \t\t \"AttributeTypeID\": \"99fd50bd4c6e43e5\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ]\r\n },\r\n {\r\n \"TrackIdentity\": \"d097sb9973cr2176601330chf017b72d5fb10ca9d3\",\r\n \"AlbumIdentity\": \"fcfa2796c2931a1a050c893ad8ahjeb6731f06432e\",\r\n \"Title\": \"Title 2\",\r\n \"DisplayTitle\": \"Display Title 2\",\r\n \"TrackNumber\": \"02\",\r\n \"Description\": \"Description 2\",\r\n \"Keywords\": \"\",\r\n \"Genre\": \"Pop\",\r\n \"Mixout\": \"\",\r\n \"Version\": \"Main\",\r\n \"Mood\": \"\",\r\n \"MusicFor\": \"\",\r\n \"AlternateTitle\": \"\",\r\n \"OriginalFileName\": \"\",\r\n \"Writer\": \"\",\r\n \"Publisher\": \"\",\r\n \"Artist\": \"\",\r\n \"BPM\": \"\",\r\n \"Tempo\": \"\",\r\n \"Instrumentation\": \"\",\r\n \"Lyrics\": \"\",\r\n \"CategoryCodes\": \"\",\r\n \"IsMain\": true,\r\n \"MainTrackNumber\": \"\",\r\n \"Writers\": [\r\n\t {\r\n\t\t \"FirstName\": \"Paul\",\r\n\t\t \"MiddleName\": \"David\",\r\n\t\t \"LastName\": \"Madvidal\",\r\n\t\t \"Capacity\": \"Composer/Author\",\r\n\t\t \"PublisherName\": \"West One Music Group\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"ASCAP\",\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50\r\n\t }\r\n\t ],\r\n \t \"Publishers\": [\r\n \t {\r\n\t\t \"Name\": \"West One Music Group\",\r\n\t\t \"Capacity\": \"Original Publisher\",\r\n\t\t \"Code\": \"1234\",\r\n\t\t \"OwnerPerformanceShare\": 50,\r\n\t\t \"OwnerMechanicalShare\": 50,\r\n\t\t \"CollectingSocietyName\": \"PRS\",\r\n\t\t \"CollectionPerformanceShare\": 50,\r\n\t\t \"CollectionMechanicalShare\": 50,\r\n\t\t \"Territory\": \"WORLD\",\r\n\t\t \"OriginalPublisherName\": \"\"\r\n \t\t}\r\n \t ],\r\n \t \"Artists\": [\r\n {\r\n \"FirstName\": \"First\",\r\n \"MiddleName\": \"\",\r\n \"LastName\": \"Last\",\r\n \"IPI\": \"1234\",\r\n \"CollectingSocietyName\": \"ASCAP\"\r\n }\r\n ],\r\n \t \"CategoryAttributes\": [\r\n \t\t{\r\n\t\t \"Name\": \"Value\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ],\r\n \t \"Codes\": [\r\n \t\t{\r\n \t\t \"AttributeTypeID\": \"99fd530bd4c4ez3ae5\",\r\n\t\t \"Value\": \"Value\"\r\n \t\t}\r\n \t ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2020 00:31:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"TrackIdentities\": [\n \"z49231a543a6d922caee3fd4bdeb0g353f26f77f61\",\n \"d097sb9973cr2176601330chf017b72d5fb10ca9d3\"\n ]\n}"}],"_postman_id":"8bc2b6c3-1b27-452b-bac2-5ec418ceeb51"},{"name":"Remove Track","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript"}}],"id":"046ae3ba-67c2-478c-8ef1-fbae98575372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/{TrackIdentity}","description":"Removes an existing track from an album in the workspace.
\nTracks that are in the following states can not be removed:
\nTracks that are removed, will be removed from AI and Search services if they had been in a published album at any point.
\nRequest Elements
\n","urlObject":{"path":["track","{{HM_ImportAPI_SessionToken}}","{TrackIdentity}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"06258df6-c99d-4ee3-97b5-a3117c60d753","name":"Remove Track (JSON)","originalRequest":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/d097sb9973cr2176601330chf017b72d5fb10ca9d3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2020 00:33:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"046ae3ba-67c2-478c-8ef1-fbae98575372"},{"name":"Get Tracks By Workspace Album & State","event":[{"listen":"test","script":{"id":"b8b11ebf-7746-4dbf-881d-1c75344d5a1c","exec":[""],"type":"text/javascript"}}],"id":"2f6c7022-feb0-43a3-8df9-4aabfa6804c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/getalbumtracksbyworkspacestate/{{HM_ImportAPI_SessionToken}}","description":"Returns tracks based on an album and a workspace state.
\nRequest Elements
\nRequest Notes
\nWorkspaceState can be one of the following values:
\nPublishes a track in the workspace.
\nOnly tracks that are in the Ready state can be published.
\nAfter being published the track will be in the Imported state.
\nImportant: This process is only required when publishing a track to an existing album, where that album has been published previously and is already in the Imported state.
\nRequest Elements
\n","urlObject":{"path":["track","{{HM_ImportAPI_SessionToken}}","{TrackIdentity}","publish"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a082e033-4a07-4d2a-9f77-74987cfa649d","name":"Publish Track On Imported Album (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/f1418ee84998476c0be03365aa91252461d7f313/publish"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 01:24:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Code\": \"OK\"\r\n}"}],"_postman_id":"237d99c2-19df-48ce-9075-b9b40af3d163"},{"name":"Unpublish Track On Imported Album","event":[{"listen":"test","script":{"id":"b15b6f9d-83f1-4a18-9de3-53acdcda5ace","exec":[""],"type":"text/javascript"}}],"id":"ef8879a5-e374-4b87-9c00-5b0952ebeb1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/{{HM_ImportAPI_TrackID}}/unpublish","description":"Unpublishes a track back into the workspace.
\nOnly tracks that are in the Imported state can be unpublished.
\nAfter being unpublished the track will be in the ImportedInactive state.
\nRequest Elements
\n","urlObject":{"path":["track","{{HM_ImportAPI_SessionToken}}","{{HM_ImportAPI_TrackID}}","unpublish"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"de5ad5ea-dc9c-4ec2-9560-22172647ae89","name":"Unpublish Track On Imported Album (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/f1418ee84998476c0be03365aa91252461d7f313/unpublish"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 01:24:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Code\": \"OK\"\r\n}"}],"_postman_id":"ef8879a5-e374-4b87-9c00-5b0952ebeb1c"},{"name":"Move Tracks On Import Album","id":"06ffdadf-e8a4-442d-bb5f-01af152721f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{HM_ImportAPI_URL}}/track/{{HM_ImportAPI_SessionToken}}/move","description":"Allows moving of a track from one album to another album.
\nThe following rules should be followed:
\nThe destination album can be within any Library, it does not have to be in the Library as the moving track
\nThe moving track must be in the Imported or ImportedInactive workspace state
\nThe destination album must be in the Imported workspace state
\nThe destination album must be an Originator album
\nThe destination album must not be the same album that the moving track already resides within
\nThe moving track cannot be a version track. It must be a Main track
\nRequest Elements
\nRequest Notes: Tracks
\nResponse Notes:
\nThere are a variety of valid error responses to handle:
\nWhen the moving track is not in the Imported / ImportedInactive workspace state:
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Track identity f3ecae9f3b2b0633033bccf7d59c3b663d601877 is not in Imported / ImportedInactive state.\"\n }\n}\n\nWhen the destination album is not in the Imported workspace state:
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Album identity f3ecae9f3b2b0633033bccf7d59c3b663d601877 is not in Imported state.\"\n }\n}\n\nWhen the desintation album is not an Originator album:
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"AlbumIdentity cb41de91b47030e84e93163625ef5ca9deef45e8 is not an originator album.\"\n }\n}\n\nWhen destination album is the same album as the one the moving track resides within:
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"TrackIdentity 7967b8a0a17a04e04a7a152f75e7483f34b6e9aa is already in the destination album.\"\n }\n}\n\nWhen the moving track is not a Main version track:
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"TrackIdentity 7967b8a0a17a04e04a7a152f75e7483f34b6e9aa can not be moved. Only main tracks can be moved.\"\n }\n}\n\nReturns a URL for which an asset file can be uploaded to.
\nOnly albums or tracks in the MissingAsset or Ready state can retrieve a URL.
\nPlease note that, for audio, only WAV (content type audio/wave) files can be uploaded.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getpresigneduploadurl","{{HM_ImportAPI_SessionToken}}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6d641aa6-4151-4932-821e-a8084e2c0b06","name":"Get Track Audio Upload URL (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"trackaudio\",\r\n\t\"Key\":\"\",\r\n\t\"FileName\":\"audio.wav\",\r\n\t\"ContentType\":\"audio/wave\",\r\n\t\"ExpiresInSeconds\":\"120\",\r\n\t\"ObjectID\":\"d097sb9973cr2176601330chf017b72d5fb10ca9d3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/getpresigneduploadurl/{{HM_ImportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:50:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"PresignedUploadUrl\": \"https://Finalises an asset upload.
\nOnly albums or tracks in the MissingAsset or Ready state can finalise an asset upload.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["confirmpresignedupload","{{HM_ImportAPI_SessionToken}}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8e771190-565f-4dbc-b916-a585840dc565","name":"Confirm Album Art Upload Complete (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"albumart\",\r\n\t\"Key\":\"\",\r\n\t\"FileName\":\"artwork.jpg\",\r\n\t\"ObjectID\":\"1d37650a71827c6ec4f868b4c6c7b304dfak73be41\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/confirmpresignedupload/{{HM_ImportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2020 00:48:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"f157939a-1a6a-442b-9e46-180f218cae95","name":"Confirm Track Audio Upload Complete (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"trackaudio\",\r\n\t\"Key\":\"\",\r\n\t\"FileName\":\"audio.wav\",\r\n\t\"ObjectID\":\"d097sb9973cr2176601330chf017b72d5fb10ca9d3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ImportAPI_URL}}/confirmpresignedupload/{{HM_ImportAPI_SessionToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jan 2020 00:51:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"9b27a595-b263-4638-bdfc-bdea377f0155"},{"name":"Set External Asset (URL)","id":"078efaec-0abc-4ea8-8196-de8d38509f42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{HM_ImportAPI_URL}}/setasseturl/{{HM_ImportAPI_SessionToken}}","description":"Provides the ability to specify an external URL as the source of an asset - AlbumArt, TrackAudio or both.
\nOnly albums or tracks in the MissingAsset or Ready state can set an asset URL.
\nWhen a album or track that has an external URL as the source of their assets is published, the asset will be copied across to Harvest Media for internal use thereafter.
\nPlease ensure that the URL is allowed for public access during publish.
\nRequest Elements
\nRequest Notes
\nRequest Notes: URL
\nPlease note the following:
\nProvides a path for providing an external S3 path to be used in replace of having to upload an asset.
\nOnly albums or tracks in the MissingAsset or Ready state can set an external asset.
\nRequest Elements
\nRequest Notes
\nRequest Notes: Key
\nPlease note that for AssetType \"albumart\" the key provided MUST be albumart.jpg. The file must also be a valid jpg as the mimetype will be checked.
\n","urlObject":{"path":["setexternals3asset","{{HM_ImportAPI_SessionToken}}"],"host":["{{HM_ImportAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1c12d961-c689-42b9-91db-3c8149fabba4","name":"Set External Track Audio (Amazon S3) (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"AssetType\":\"trackaudio\",\r\n\t\"Key\":\"The Harvest Media Import API allows clients to import metadata and associated assets into the Harvest Media platform.
\nThe Harvest Media Import API is a RESTful webservice implemented as JSON over HTTPS using GET & POST.
\nGetting Access
\nTo access the API you will need the following;
\nTo request access to the API for your account you will need to contact us at support@harvestmedia.net. Once access has been granted we will provide you with details required above so that you can begin integrating and consuming the API.
\nPlease note that the Access Key acts as a gateway to unlocking access to your account and as such should be kept confidential and not provided to any third party, under any circumstance.
\n","event":[{"listen":"prerequest","script":{"id":"296f70a3-f879-4fe9-b277-dd8171fa5084","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8601075a-c8f8-4701-8758-2e3870036bf3","type":"text/javascript","exec":[""]}}],"_postman_id":"6d815da3-e7d4-4612-a8be-8c28260ab7a5"},{"name":"Agent API","item":[{"name":"Getting Started","item":[{"name":"Get Authorised","event":[{"listen":"test","script":{"id":"bc68800f-115c-4163-8bd7-5e5b1872c367","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataToken = \"\";","","/*if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataToken = jsonData.responseservicetoken.token.$.value;","} else {*/"," jsonData = JSON.parse(responseBody)"," jsonDataToken = jsonData.access_token;","/*}*/","","console.log(\"HM_ServiceAPI_AuthToken set to \" + jsonDataToken);","","postman.setEnvironmentVariable(\"HM_IntegrationAPI_AuthToken\", jsonDataToken);","","postman.setNextRequest(\"Get Service Token\");"],"type":"text/javascript"}}],"id":"46863988-6126-4a73-ac03-c5317f743a5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","type":"text","value":"{{HM_IntegrationAPI_AuthGrantType}}"},{"key":"client_id","type":"text","value":"{{HM_IntegrationAPI_AuthClientID}}"},{"key":"client_secret","type":"text","value":"{{HM_IntegrationAPI_AuthClientSecret}}"}]},"url":"{{HM_IntegrationAPI_AuthUrl}}","description":"Returns an Access Token that is required for access to all API methods. The Access Token must be included as an \"Authorization\" Header for all requests sent to the API. Without it, any request made to the API will be denied.
\nRequest Elements
\nRequest Notes
\nThe request form key \"grant_type\" must have it's value set to the string \"client_credentials\". Please see the example for reference.
\nResponse Notes
\nThe response value \"expires_in\" is a value in seconds and represents the expiration for this Access Token. A new Access Token must be requested within that expiration period or Access will be revoked.
\n","urlObject":{"host":["{{HM_IntegrationAPI_AuthUrl}}"],"query":[],"variable":[]}},"response":[{"id":"945b0753-c5af-4225-95ae-0ef87d44fbf6","name":"Get Authorised (JSON)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","type":"text","value":"client_credentials"},{"key":"client_id","type":"text","value":"222sfgt4l0iv85161ad0do4amqz2"},{"key":"client_secret","type":"text","value":"bbvdb2o99ocaph2e91plitc70nurs7frnotv39pe6kosnvaglaqs3"}]},"url":"{{HM_ServiceAPI_AuthUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 09 Oct 2019 04:39:57 GMT"},{"key":"x-amz-cognito-request-id","value":"f0c78623-16ec-40a0-b8cb-eda7f7357baa"},{"key":"X-Application-Context","value":"application:prod:8443"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Server","value":"Server"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 98c0260f137c498b550b5ea75d3bc892.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C2"},{"key":"X-Amz-Cf-Id","value":"nNj5wskdNAAXVpKmDBkvGZQiwylC0cYuXYsQEDpjXvzIFhX5WPHyNQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJraWQuiiOiJFenBSMDNxa0lLVnZmNlF4QldhRFlTYStVaHBzUm9zWnpFeDNqNUdObVprPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI3dHFzN21zNGwwaXY4MTYxYWRkbzRhbXFmMiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiSGFydmVzdE1lZGlhLVB1YmxpY1wvZ2V0c2VydmljZXRva2VuIGh0dHBzOlwvXC94b3R0MjF2dwjZqLmV4ZWN1dGUtYXBpdLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC9nZXRzZXJ2aWNldG9rZW4iLCaJhdXRoX3RpbWUiOjE1NzA1OTU5OTcsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC51cy1lYXN0LTEuYW1hem9uYXdzLmNvbVwvdXMtZWFzdC0xXv0RHaHZ4c2pYaiIsImsV4cCI6MTU3MDU5OTU5NywiaWF0IjoxNTcwNTk1OTk3LCJ2ZXJzaW9u-IjoyaLCJqdGkiOiI2YjAzMDYyNy0xNTJlLTQ1ODEtOTY0Zi02YmYxMzk5MjE4ZGMiLCJjbGllbnRfaWQiOiI3dHFzN21zNGwwaXY4MTYxYWRkbzRhbXFmMiJ9.lhAfpE7zVC0qagFOuzTcScnURqEdf7qUtVQ_Q9RKHIX4yFEPxZukma2RVuYZa65sTmz8PFNi1oYvi0oOlcuB1Bd465L5xMCfVYYilEL7rbhNMtUqGhANO3xSVMy-lLqPQc6XvE17RKZe9xW-MsrGymE29ZC7Xe2zukgkxyJ7VS3PP5aX_c8yEVAaMZ-hsQwQCC2sNrrS8adWwSU5t4x3nqIJmjYe-rEm0OMkUHTn6ekmGcXfPrenejzeewNn5KpG0V2nJR-ZBOkZ_jtJQ2d_fyPOURy7XXbg5VgcpGcW1_rgm_Kprwv1yauvVYfXBjSeF8rLP3jd3WiktzyCLr-TEhSHQZNT3A\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"46863988-6126-4a73-ac03-c5317f743a5c"},{"name":"Get Service Token","event":[{"listen":"test","script":{"id":"00464253-d03b-40a9-a88f-3c87bd0c7b31","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9dd3c374-c1f7-46d0-875c-e09ccde7d517","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"AccessKey","value":"{{HM_IntegrationAPI_Key}}","type":"text"}],"url":"{{HM_IntegrationAPI_URL}}/getservicetoken/{{HM_IntegrationAPI_Key}}","description":"To access the Harvest Media API you will need to acquire a Service Token.
\nOnce a service token has been issued, the user will have access to the API.
\nThe Service Token authenticates the AccessKey and issues access to the webservice.
\nRequest Elements
\n","urlObject":{"path":["getservicetoken","{{HM_IntegrationAPI_Key}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f157668d-7329-4ad4-b45e-fe80beab777b","name":"Get Service Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/getservicetoken/{{HM_IntegrationAPI_Key}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Token\": {\n \"Value\": \"850a6422a03de080ebcc8a3990a1428e62\",\n \"Expiry\": \"2019-08-08T15:53:25.977\",\n \"UTCOffset\": 10,\n \"Type\": \"ServiceToken\",\n \"IsOfSingleUse\": false\n }\n}"},{"id":"736e2c9e-5155-4291-b6b8-15e504697522","name":"Get Service Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/getservicetoken/{{HM_IntegrationAPI_Key}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"},{"key":"Date","value":"Thu, 08 Aug 2019 01:41:05 GMT","description":"","type":"text"},{"key":"Server","value":"Microsoft-IIS/8.0","description":"","type":"text"},{"key":"X-Powered-By","value":"ASP.NET","description":"","type":"text"},{"key":"Content-Length","value":"320","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nThis operation will return the details of the service token, notably the expiry date and the creation date.
\nDate format will be UTC+10 or UTC+11 and shown as YYYY-MM-DDTHH:MM:SS:SSS.
\nReturns Service Token details details which include:
\nRequest Elements
\n","urlObject":{"path":["getservicetokeninfo","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cf75ad73-47e3-427f-a5ba-c5f044631b8e","name":"Get Service Token Info (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/getservicetokeninfo/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"},{"key":"Date","value":"Thu, 08 Aug 2019 01:42:43 GMT","description":"","type":"text"},{"key":"Server","value":"Microsoft-IIS/8.0","description":"","type":"text"},{"key":"X-Powered-By","value":"ASP.NET","description":"","type":"text"},{"key":"Content-Length","value":"343","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nGetServiceInfo returns image, download and file format URL patterns that are required to access assets for members.
\nFor more details please see:
\nService AssetURLs
\nStreaming URL patterns
\nFile formats are also available. Included is a property isdefaultdownload=\"true\" which is the account default for downloads.
\nThere is also a property isdefaultdownloadfortype-\"true\" which is a default for the available types (WAV,AIFF,MP3).
\nThese can also be define for members (see Members).
\nRequest Elements
\nRequest Notes
\nResponse Notes
\n","urlObject":{"path":["getserviceinfo","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"75b46325-6341-4b26-9d7d-b62bcfd3a853","name":"Get Service Info (Service Asset URLs and File Formats) (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/getserviceinfo/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 04:28:55 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"3701"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis operation will expire the provided Service Token immediately.
\nAny subsequent calls to the API using the provided Service Token will result in an error response.
\nRequest Elements
\n","urlObject":{"path":["expiretoken","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"10a66a54-f3a3-4e13-90aa-3a37adf12ae2","name":"Expire Service Token (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/expiretoken/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2019 02:02:09 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"65454653-542e-4eee-b327-1b722d5aee00","name":"Expire Service Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/expiretoken/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"},{"key":"Date","value":"Fri, 16 Aug 2019 02:02:42 GMT","description":"","type":"text"},{"key":"Server","value":"Microsoft-IIS/8.0","description":"","type":"text"},{"key":"X-Powered-By","value":"ASP.NET","description":"","type":"text"},{"key":"Content-Length","value":"181","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nOK\nUtilise
\n\nto find Labels/Libraries that contain albums that are available for downloading to the workspace.
\nAlbums within the workspace can be in six different states; NeverCopied, InWorkspace, MetadataChanged, PreviouslyCopied, Processing and Error.
\nAn album will remain in the NeverCopied state until the album has been downloaded to the workspace. Once an album has met this condition it will move into the InWorkspace state. All albums will be in a NeverCopied state the first time you use the Agent API.
\nUtilise
\nGet Albums By Workspace Status
\nto retrieve albums for a Label/Library that are available for downloading to the workspace.
\nUtilise
\n\nto download an album into the workspace.
\nUtilise
\n\nto set the provided tag on an album in the workspace.
\nUtilise
\n\nto remove the provided tag from an album in the workspace.
\nUtilise
\n\nto retrieve all tracks for an album in the workspace.
\nUtilise
\n\nto retrieve full metadata for the provided tracks for an album in the workspace.
\nOption 1: Download tracks from URL
\nCall getmanagementusertoken with credentials to obtain an authorization token
\nCall getmanagementuserdownload to begin preparing the album for download
\nCall getaccessinfo, you will need the download format and URL
\nCall getalbumsbyworkspacestatus with status'; \"NeverCopied\", \"PreviouslyCopied\", and \"MetadataChanged\"
\nCall getalbumsbyworkspacestatus with status=\"InWorkspace\" to retrieve albums ready for download.
If you have already requested an album but it is still not in the workspace, you can check status as \"Processing\" or \"Error\". If it returns as \"Error\", please contact Support.
Call getworkspacealbumtracks to retrieve albums items
\nPass the \"downloadtoken\" in the URL obtained from getaccessinfo to download files
\nOption 2: Download tracks from s3
\nContact us to gain access to S3 workspace bucket. You will need to provide us with an IAM account so that we can configure access for your user
\nCall getalbumsbyworkspacestatus with status'; \"NeverCopied\", \"PreviouslyCopied\", and \"MetadataChanged\"
\nCall getmanagementuserdownload to begin preparing the album for download
\nCall getalbumsbyworkspacestatus with status=\"InWorkspace\" to retrieve albums ready for download
If you have already requested an album but it is still not in the workspace, you can check status as \"Processing\" or \"Error\". If it returns as \"Error\", please contact Support.
Use the S3Bucket and S3Key provided in the getworkspacealbumitems response to download or copy from the S3 workspace bucket
\nStep 1: Saving \"never copied\" albums to the workspace
\nCall getalbumsbyworkspacestatus with status=\"NeverCopied\" and notcontainstags=\"Copied\"
\nCall getmanagementuserdownload for each album you want to save to the workspace
\nStep 2: Get workspace items and copy
\nCall getalbumsbyworkspacestatus with status=“InWorkspace” and notcontainstags=\"Copied\"
\nCall getworkspacealbumtracks for each album and download (see above download options)
\nSave album metadata from the getalbumsbyworkspacestatus response
\nCall gettracks to save track metadata using items in the getworkspacealbumitems response
\nConfirm you have successful extracted metadata and audio
\nCall setalbumtag tag=\"Copied\"
\nThe Agent API will automatically set the status of a previously copied album to MetadataChanged if the metadata has changed.
\nPlease note: If the metadata is changed while the album is in a InWorkspace state, then you will need to wait for the album to expire from the workspace before the status is changed by the Agent API to MetadataChanged.
\nStep 1: Re-save \"metadata changed\" albums to the workspace
\nCall getalbumsbyworkspacestatus with status=\"MetadataChanged\"
\nCall removealbumtag tag=\"Copied\" if it exists
\nCall getmanagementuserdownload for each album you want to re-save to the workspace
\nStep 2: Get workspace items and copy
\nOnce albums are in your workspace you will have 30 days to pick them up. After that time they will expire from the workspace and be removed, their status will also be automatically changed by the Agent API from InWorkspace to PreviouslyCopied.
\nIf you missed the time window you can follow these steps to re-access them.
\nStep 1: Re-save \"previously copied\" albums to the workspace items you didn't pick up in time
\nCall getalbumsbyworkspacestatus with status=\"PreviouslyCopied\" and notcontainstags=\"Copied\"
\nCall getmanagementuserdownload for each album you want to re-save to the workspace
\nStep 2: Get workspace items and copy
\nThe following scenario can occur when albums are manually downloaded from ADMIN and not extracted via the Integration API. These albums can be found by calling getalbumsbyworkspacestatus with status=\"NeverCopied\" and containstags=\"Copied\"
\nIf you wish to re-process these albums using the Integration API, remove the \"Copied\" tag in the ADMIN >> Edit Album, so these appear in the \"Primary workflow for new albums\"
\nAlternatively,
\nStep 1: Saving \"never copied\" albums to the workspace
\nCall getalbumsbyworkspacestatus with status=\"NeverCopied\" and containstags=\"Copied\"
\nCall removealbumtag tag=\"Copied\"
\nCall getmanagementuserdownload for each album you want to save to the workspace
\nStep 2: Get workspace items and copy
\nThis function returns a list of labels/libraries for the account.
\nGetLibraries returns labels/libraries set to “active” in the admin.
\nRequest Elements
\n","urlObject":{"path":["getlibraries","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0ace9984-56be-409c-933d-9a1c02dc87f1","name":"Get Labels/Libraries (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/getlibraries/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2019 05:26:59 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"86413"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nThis function returns a list of labels/libraries for the account.
\nGetLibrariesByTag returns labels/libraries in all statuses in the admin, and also filtered by \"ContainTags\" or \"NotContainTags\", which can be set via \"SetLibraryTag/\" and removed by \"RemoveLibraryTag/\" endpoints.
\nRequest Elements
\n","urlObject":{"path":["getlibrariesbytag","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"342c50f5-ffe3-4537-b2fc-1a67f4f17968","name":"Get Labels/Libraries By Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"eyJraWQiOiJFenBSMDNxa0lLVnZmNlF4QldhRFlTYStVaHBzUm9zWnpFeDNqNUdObVprPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI2OWI3amlxNWNnOTRiMWU3YmhpcjVzczliZ..."},{"key":"AccessKey","value":"9a1533448300e3d9f1ab17ba11f6e7e2e3309eb654a8bdb99cfaf02117203c0e6a8281174dd2fec1","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ContainsTags\": \"withdrawn\",\r\n \"NotContainsTags\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://service-public.harvestmedia.net/IntegrationService.svc/getlibrariesbytag/2bcf65a68aa4560e70054d602f1e93cd"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 05 Dec 2025 02:02:44 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nReturns albums that are available for downloading to the workspace based on a Label/Library, format, workspace status, and tag filter (contains and not contains).
\nRequest Elements
\nRequest Notes
\nRequest Notes: Workspace Status
\nAlbums within the workspace can be in four different states; NeverCopied, InWorkspace, MetadataChanged, PreviouslyCopied, Processing, and Error:
\n\"NeverCopied\" - either never requested or hasn't successfully transferred to workspace (i.e. was requested but failed)
\n\"InWorkspace\" - currently available in workspace
\n\"MetadataChanged\" - metadata has changed on the album since it was last copied to workspace
\n\"PreviouslyCopied\" - has previously been transferred to workspace
\n\"Processing\" - has been requested, but it is not yet available in the workspace
\n\"Error\" - an error has occurred. Please, contact support.
\nRequest Notes: Contains Tags
\nContainsTags can be a comma separated list of tags that ALL must be contained in the album's tags for the album to be returned in search results.
\nIf nothing is specified, search results won't be filtered by ContainsTags and will return results based on the other parameters in the request (i.e. library, format, workspace status etc)
\nRequest Notes: Not Contains Tags
\nNotContainsTags can be a comma separated list of tags that ALL must NOT be contained in the album's tags for the album to be returned in the search results.
\nIf nothing is specified, search results won't be filtered by NotContainsTags and will return results based on the other parameters in the request (i.e. library, format, workspace status etc)
\n","urlObject":{"path":["getalbumsbyworkspacestatus","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"567407ef-0bc3-4c3d-9df5-a62f6a923eb7","name":"Get Albums by Workspace Status (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"LibraryID\":\"c32pefyh57f2ea73c9\",\r\n\t\"Format\":\"z9x8f593550f3tadde\",\r\n\t\"WorkspaceStatus\":0,\r\n\t\"ContainsTags\":\"\",\r\n\t\"NotContainsTags\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_IntegrationAPI_URL}}/getalbumsbyworkspacestatus/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 28 Aug 2019 04:59:50 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Albums\": [\n {\n \"Featured\": false,\n \"ReleaseDate\": \"1/1/1987 12:00:00 AM\",\n \"Code\": \"PML001\",\n \"Detail\": \"Contemporary themes and underscores for industry, sports and achievement. 25 tracks\",\n \"Name\": \"PML001 The Zenith Orchestra 1\",\n \"DisplayTitle\": \"PML001 The Zenith Orchestra 1\",\n \"ID\": \"59764b55c4h067cacd\",\n \"Status\": \"inactive\",\n \"Tags\": \"1 received\",\n \"Linebreaks\": []\n }\n ]\n}"},{"id":"5eef2e86-21b4-4277-9202-547bcc12e2f1","name":"Get Albums by Workspace Status (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"Accepts album ID and format.
\nReturns album details and all tracks (and other assets) for the album that exist in the workspace, including bucket and key for each.
\nTo obtain track metadata use the Get Tracks method.
\nRequest Elements
\n","urlObject":{"path":["getworkspacealbumtracks","{{HM_IntegrationAPI_Token}}","{AlbumID}","{Format}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cf4727c4-2987-490c-9502-3ddb1edf8648","name":"Get Tracks By Workspace Album (JSON)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"url":"{{HM_IntegrationAPI_URL}}/getworkspacealbumtracks/{{HM_IntegrationAPI_Token}}/5fa68e7115hf3d8o38/u94b8f2593b50tadde"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 28 Aug 2019 05:17:06 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"3665"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"workspaceAlbums\": [\n {\n \"Code\": \"FEM 006\",\n \"Format\": \"u94b8f2593b50tadde\",\n \"FormatName\": \"MP3 (320kbps, 44.1kHz)\",\n \"Name\": \"Man Of Steel Remixed EP\",\n \"DisplayTitle\": \"FEM 006 Man Of Steel Remixed EP\",\n \"LibraryID\": \"r4577b553abe8vfdk1\",\n \"Tags\": \"\",\n \"Status\": \"active\",\n \"WorkspaceAlbumItems\": [\n {\n \"ItemType\": \"TrackAudio\",\n \"TrackNumber\": \"1\",\n \"Name\": \"Man of Steel Dirty Dubstep Remix\",\n \"FileName\": \"{filename}\",\n \"FileSize\": 6728238,\n \"Bucket\": \"{bucket}\",\n \"Key\": \"{key}\",\n \"DownloadToken\": \"ea441a38ed770y800T\",\n \"TrackID\": \"56cbfc3ue7y25e4de6\"\n }\n ]\n }\n ]\n}"},{"id":"7c8de792-c3e5-4d74-9bad-e81ed9f0080b","name":"Get Tracks By Workspace Album (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/getworkspacealbumtracks/{{HM_IntegrationAPI_Token}}/5fa68e7115hf3d8o38/u94b8f2593b50tadde"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 28 Aug 2019 05:19:32 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nReturns all tracks specified in the request body.
\nThe response will include one or more track elements.
\nRequest Elements
\nNotes regarding Request Elements
\n","urlObject":{"path":["gettracks","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a4e2a4bb-5fda-4b80-a238-d9ab80742631","name":"Get Tracks (XML) ","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"Using credentials setup in the Admin, authenticate an user to get a management user token.
\nRequest Elements
\n","urlObject":{"path":["getmanagementusertoken","{{HM_IntegrationAPI_Token}}","{username}","{password}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6d1a19da-8a97-4da8-97a7-b16e3b9ba041","name":"Get Management User Token (XML)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/getmanagementusertoken/{{HM_IntegrationAPI_Token}}/username/password"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Wed, 28 Aug 2019 05:29:33 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"300"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\nQueues a download.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getmanagementuserdownload","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e4280220-65f0-4b86-a1c8-d8b2968e620e","name":"Get Management User Download (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"ManagementUserToken\":\"0b553f6605056e69407a6fa4bdbbe456o8\",\r\n\t\"DownloadType\":\"album\",\r\n\t\"Identifier\":\"09a5f5e30dc44y8zce\",\r\n\t\"Format\":\"19b8b59i5503addere\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_IntegrationAPI_URL}}/getmanagementuserdownload/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 28 Aug 2019 05:40:23 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"RequestSent\": true\n}"},{"id":"e7bcc2ae-442c-4b82-9e02-a5bae95f1b1c","name":"Get Management User Download (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"Sets a tag on an album.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["setalbumtag","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"873a007e-ce3c-440e-9817-5d1ccf757a69","name":"Set Album Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"OK\nRemoves a tag from an album.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["removealbumtag","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e4f99005-2a22-4351-9458-73503692cf15","name":"Remove Album Tag (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"AlbumID\":\"0y3982ya6855b9152e\",\n\t\"Tag\":\"tag-one\"\n}"},"url":"{{HM_IntegrationAPI_URL}}/removealbumtag/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 28 Aug 2019 04:28:47 GMT"},{"key":"Server","value":"Microsoft-IIS/8.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"71b3a67f-cebc-439a-b171-e49842a670f6","name":"Remove Album Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_IntegrationAPI_AuthToken}}"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"OK\nSets a tag on a library.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["setlibrarytag","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f422823e-bc34-47af-9322-0a54610a8ae2","name":"Set Library Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"eyJraWQiOiJFenBSMDNxa0lLVnZmNlF4QldhRFlTYStVaHBzUm9zWnpFeDNqNUdObVprPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI2OWI3amlxNWNnOTRiMWU3YmhpcjVzczliZ..."},{"key":"AccessKey","value":"9a1533448300e3d9f1ab17ba11f6e7e2e3309eb654a8bdb99cfaf02117203c0e6a8281174dd2fec1","type":"text"}],"body":{"mode":"raw","raw":"OK\nRemoves a tag from a library.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["removelibrarytag","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3195fda6-2c08-4c49-a6a2-316ea563b3cb","name":"Remove Library Tag (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"eyJraWQiOiJFenBSMDNxa0lLVnZmNlF4QldhRFlTYStVaHBzUm9zWnpFeDNqNUdObVprPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI2OWI3amlxNWNnOTRiMWU3YmhpcjVzczliZ..."},{"key":"AccessKey","value":"9a1533448300e3d9f1ab17ba11f6e7e2e3309eb654a8bdb99cfaf02117203c0e6a8281174dd2fec1","type":"text"}],"body":{"mode":"raw","raw":"OK\nThe Agent API uses the Public API service endpoint.
\nIt can be used to extract sub published audio and metadata into your external system instead of downloading via an admin account.
\nWhen audio and metadata are changed in HarvestMedia, the workflows in the Agent API know to resend this data automatically.
\nThe following items are required for integration.
\nWorkspace access
\nItems placed into the workspace are stored at the following AWS S3 endpoint.
\naccount.workspace.harvestmedia.net/hma-{accountcode}
\nFor clients wanting to copy items to their own AWS S3 bucket, GetObject permissions will need to be established via a bucket policy for 3rd party IAMS user
ie: arn:aws:iam::{account}:user/{username}
Alternately, an Access Key ID and Secret Access Key can be provided for direct access using the AWS S3 API.
\nDocumentation is available here. http://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html
\nAdmin User
\nThe account owner will need to create an admin user to be able to download items to the workspace.
\nManage Tags
\nYou can add/remove the tags you want to appear in the workflow picklists:
\nGo to \"Account Settings\">“Advanced Metadata” > \"Groups\"
\nSelect “album tab picklist”
\nAdd, edit or delete as required. ie Add tag “Copied to {account name} – mp3”
\nBulk assigning “Copied to {account name} – mp3” to all albums in your account.
\nYou may need to flag albums that you have already downloaded prior to using the API integration.
\nGo to \"Music\">\"Album Manager\"
\nSearch for albums
\nSelect the albums
\nGo to the button in the header \"Action\" and select “Manage tags”
\nAssign “Copied to All Music – mp3”
\nAll our API endpoints require authentication before they will accept requests. Please refer to the documentation, for each API, to learn how to authenticate.
\nOnce authenticated, requests from that authentication will be bound by rate limits per IP address. Rate limits vary depending on the API endpoint that is being requested.
\nPlease refer to the rate limit table outlined below.
\nIMPORTANT: Rate limits are IP-based. This is important to note, particularly for the Public API, as it means the 3600 is not split between all users connected to the one access token.
\nRate limiting is put in place to help protect your applications from performance degradation and/or outages. It prevents misbehaving applications from consuming a majority share of what are essentially shared resources.
\nAll applications should be designed with these rate limits in mind. If you're reaching the relevant rate limit for your API endpoint then we would heavily recommend restructuring your application to improve it's performance and thus reducing the number of requests performed within the rate limit period.
\nFor the Export, Import and Integration API's our suggestion is to implement exponential back off in the first instance - which will provide better request flow control.
\nThe idea behind exponential back off is to use progressively longer waits between retries for consecutive error responses. You should implement a maximum delay interval, as well as a maximum number of retries. The maximum delay interval and maximum number of retries are not necessarily fixed values, and should be set based on the operation being performed, as well as other local factors, such as network latency.
\nThe following pseudo code shows one way to poll for a status using an incremental delay, assuming you are not using concurrent clients.
\nretries = 0\nDO\nwait for (2^retries \\\\* 100) milliseconds\nstatus = Get the result of the asynchronous operation.\nIF status = SUCCESS\n retry = false\nELSE IF status = NOT_READY\n retry = true\nELSE IF status = THROTTLED\n retry = true\nELSE\n Some other error occurred, so stop calling the API.\n retry = false\nEND IF\nretries = retries + 1\nWHILE (retry AND (retries < MAX_RETRIES))\n\nThe current request, and any future requests for the remainder of the 5 minute rate limit period, will be blocked.
\nThe response headers will contain:
\nStatus Code: 403
The response body will contain:
\nThe request could not be satisfied. Request blocked. We can't connect to the server for this app or website at this time.
After the 5 minute period has elapsed, access will be re-granted. Should the integration again exceed the rate limits in the next 5 minute period, access will be summarily blocked.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"61ecd55f-11c9-4e88-b60a-98117f982b49"},{"name":"API Health Status","id":"89d3115e-9189-4019-81fa-abee27c428b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"To programmatically check the status of any of the Harvest Media API's, there is an available endpoint that can be periodically polled to check real time application performance.
\nHealth endpoint: https://service.harvest.music/health
\nWhen a request is made to this endpoint a number of metrics will be returned, each defining a key deliverable of the API.
\nHere is an example response:
\n{\n \"metrics\": {\n \"apdex\": [\n {\n \"type\": \"Search\",\n \"value\": \"0.97\",\n \"description\": \"Excellent\"\n },\n {\n \"type\": \"GeoIP\",\n \"value\": \"1.00\",\n \"description\": \"Excellent\"\n },\n {\n \"type\": \"Data\",\n \"value\": \"0.98\",\n \"description\": \"Excellent\"\n },\n {\n \"type\": \"Cache\",\n \"value\": \"0.82\",\n \"description\": \"Fair\"\n },\n {\n \"type\": \"Asset\",\n \"value\": \"0.97\",\n \"description\": \"Excellent\"\n },\n {\n \"type\": \"Download\",\n \"value\": \"0.82\",\n \"description\": \"Fair\"\n }\n ]\n }\n}\n\nThe metrics returned are;
\nSearch: the core search mechanics for searching metadata. Full impairment of this service would prevent users of the site from being able to perform searches or retrieve predictive suggestions.
\nGeoIP: the look up service in-use that determines the location of users. Typically used to provide regional-context to the content shown to users. Full impairment of this service would prevent registrations and the authentication of guests on the website - which in turn prevents the return of tracks across all API responses.
\nData: the core data repository services. This excludes cache layers that reside above the data repository. Full impairment of this service would prevent all API requests from being fulfilled.
\nCache: the cache service in-use to provide cachable responses to users. Impairment of this service would see slower response times across all services.
\nAsset: the assets that are delivered from the API. This includes artwork and samples. Full impairment of this service would see artwork and samples failing to return.
\nDownload: the download service in-use to deliver audio and cuesheets to users. Full impairment of this service would see download requests being requested but never fulfilled. In cases where the download is asked or force to be delivered by email (for example due to size of download) the request will be queued and delivered when services are returned.
\nEach metric contains a type, value and description. The type is a unique identifier to the deliverable, the value is an Apdex score (more on this below) and the description is the user experience based off the Apdex.
The Apdex (Application Performance Index) score is an open standard which defines three different types of users and their experience with an application:
\nA satisfied user feels fully productive on your application due to a smooth, responsive experience that’s free of any slowdowns.
\nA tolerating user may notice small amounts of lag or slowdowns, but continues to work around them without complaint.
\nA frustrated user is actively thinking about not waiting for your application to respond or abandoning it altogether due to consistent lag or long waiting times.
\nApdex measures the ratio of satisfied, tolerating, and frustrated users based on raw response time data.
\nBased on the above information, the metric score provided in the response can be interpretted in the following manner:
\nIn the majority of cases, integrating with this endpoint is not needed. However, should a need arise that requires a mechanism for moving a website into maintenance mode then a potential usage could be;
\nCreate a means of tracking failed requests that come to the Harvest Media API. If a certain number of requests fail within a certain period of time then request the health endpoint to see if it is a valid impairment of services. If yes, then move the site into maintenance mode
\nOnce in maintenance mode, continue to poll the health endpoint periodically and after services have been shown to be restored (and after enough time has elapsed to be sure) then re-open the site
\nA truly impactful degradation would be metric scores that fall into the Unacceptable range for an extended duration (0.0 - 0.49). Full impairment would be values in the single digits.
\nIt should be noted that a decision should be made on the overall impact of each metric to the core operation of the site. For example, if all metrics are Excellent except for, say, the Download metric then moving the site into maintenance mode is probably not required. This is because the only service impacted is downloads, meaning users can still use the bulk of API services on offer like searches, member playlists, samples etc. As such, if implementation of the health endpoint is required then we would heavily recommend determining which combination of services needs to be fully impaired before moving into a maintenance mode.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"89d3115e-9189-4019-81fa-abee27c428b0"}],"id":"68d41a07-f8ae-410b-84ae-4c3100f0703f","event":[{"listen":"prerequest","script":{"id":"2d2912b0-cfb4-4aa4-bfaf-c5f82dd9b5ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b355223e-58a1-4c68-b0ce-507936bb1bda","type":"text/javascript","exec":[""]}}],"_postman_id":"68d41a07-f8ae-410b-84ae-4c3100f0703f","description":""}],"event":[{"listen":"prerequest","script":{"id":"5b43a642-49a4-406c-87ff-a1882aa0fcc1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"85366089-8b57-427a-89fd-d708a0b9ad78","type":"text/javascript","exec":[""]}}]}