Service Tokens
\nService tokens are used when no regional context is required on the API endpoint.
\nService token is not a guest token and should not be used as such, because guest tokens have a regional context based on where the guest is coming from.
\nExamples of endpoints that have no regional context, and use service tokens are:
\ngetservicetoken
\ngetservicetokeninfo/{{HM_ServiceAPI_Token}}
\ngetserviceinfo/{{HM_ServiceAPI_Token}}
\ngetshorturl/{{HM_ServiceAPI_Token}}
\ngetregionbyip/{{HM_ServiceAPI_Token}}?ip={IP}
\ngetcountries/{{HM_ServiceAPI_Token}}
\ngetguestmembertoken/{{HM_ServiceAPI_Token}}/{RegionID}
\ngetmembertoken/{{HM_ServiceAPI_Token}}
\nregistermember/{{HM_ServiceAPI_Token}}
\nvalidatepersistentlogintoken/{{HM_ServiceAPI_Token}}
\nWhen looking at the documentation, if you see {{HM_ServiceAPI_Token}} in the URL then this is the service token.
\nMember Tokens
\nMember tokens can come in two forms:
\nGuest member token
\nLogged in member token
\nA guest member token is obtained by:
\ngetregionbyip/{{HM_ServiceAPI_Token}}?ip={IP}
\ngetguestmembertoken/{{HM_ServiceAPI_Token}}/{RegionID}
\nThis guest member token can be used in all API endpoints that contain “HM_ServiceAPI_MemberToken”
\nA logged in member token is obtained by:
\ngetmembertoken/{{HM_ServiceAPI_Token}}
\nvalidatepersistentlogintoken/{{HM_ServiceAPI_Token}}
\nThis logged in member token can be used in all API endpoints that contain “HM_ServiceAPI_MemberToken”
\nDesired State
\nOur desired state is:
\nUse service tokens in only the API methods that are listed as {{HM_ServiceAPI_Token}}
\nUse member tokens in all other cases
\nWhen a user comes to the site, the following should occur:
\nRetrieve the users IP address
\nRetrieve a region based on the IP address
\nUse the region to retrieve a guest member token
\nIf the user logs in, the guest member token should be replaced with the logged in member token
\nIf the user logs out, the logged in member token should be replaced with the guest member token
\nGAP
\nIt is not currently possible to search via ST_PLAYLIST, nor is it possible to get results VIEW: PLAYLIST
GAP
\nIt is not currently possible to search via ST_RIGHTHOLDER, nor is it possible to get results VIEW: RIGHTHOLDER
Instructions for Opt-in after receiving the response:
\nwhen “SubscribeDefault” is missing or empty then hide the subscribe checkbox.
\nwhen “SubscribeDefault” is true then show the subscribe checkbox selected.
\nwhen “SubscribeDefault” is false then show the subscribe checkbox deselected.
\nWhen posting data to /registermember/ the Subscribe field is optional.
When SubscribeDefault is omitted from getRegionByIP, the Member should be assigned as Subscribe:(null), ie. “opt in assumed”.
PLEASE NOTE: the same applies when doing /updatemember/ however the variable is slightly different, when a member is on their profile page you will be loading member details by doing /getmember/, if there is no field called \"SubscribeNewsletter\" it means the member has Assumed Opt-In, so you should not offer the option to update \"subscribe\" in /updatemember/
PLEASE NOTE: if you do the call as JSON subscribedefault won't appear when opt-in is assumed, however, if you do the call as XML it will show subscribedefault as being null
\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":"{{HM_ServiceAPI_IPAddress}}"}],"variable":[]}},"response":[{"id":"761d3c15-8c11-48c4-a7db-a07f36d8221f","name":"Get Regions By IP","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getregionbyip/{{HM_ServiceAPI_Token}}?ip={{HM_ServiceAPI_IPAddress}}","host":["{{HM_ServiceAPI_URL}}"],"path":["getregionbyip","{{HM_ServiceAPI_Token}}"],"query":[{"key":"ip","value":"{{HM_ServiceAPI_IPAddress}}","description":"IPv4 or IPv6 IP address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 27 Oct 2024 14:10: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 \"Region\": {\n \"ID\": \"88f8791e732f07e1\",\n \"Name\": \"Global\",\n \"Countries\": [\n {\n \"TLD\": \"GB\",\n \"Name\": \"United Kingdom\",\n \"IsTaxed\": true,\n \"TaxRate\": 0.22\n }\n ],\n \"LanguageCode\": \"\",\n \"SubscribeDefault\": false,\n \"LicensingModel\": \"SubscriptionEcomGatewayMemberOnly\",\n \"Currency\": {\n \"Name\": \"Australian Dollar\",\n \"Code\": \"AUD\",\n \"Symbol\": \"A$\"\n },\n \"Blocked\": false\n },\n \"Country\": {\n \"TLD\": \"GB\",\n \"Name\": \"United Kingdom\",\n \"IsTaxed\": true,\n \"TaxRate\": 0.22\n }\n}"}],"_postman_id":"34c22ff5-23a9-4e34-addf-4ec65c463f35"},{"name":"Authenticate Guest Member","event":[{"listen":"test","script":{"id":"10836b42-e165-4ec1-a9a3-870c590ebc7d","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.Token.Value;","}","","console.log(\"HM_ServiceAPI_MemberToken set to \" + jsonDataToken);","console.log(\"HM_ServiceAPI_MemberTokenIsLoggedMember set to false\");","","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberToken\", jsonDataToken);","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberTokenIsLoggedMember\", \"false\")"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0fdf89e9-d7d2-40d7-b1f2-ef399c98d8c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getguestmembertoken/{{HM_ServiceAPI_Token}}/{{HM_IntegrationAPI_regionid}}","urlObject":{"path":["getguestmembertoken","{{HM_ServiceAPI_Token}}","{{HM_IntegrationAPI_regionid}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fdf89e9-d7d2-40d7-b1f2-ef399c98d8c2"}],"id":"86fa7880-56e8-431f-b597-660670f686ac","_postman_id":"86fa7880-56e8-431f-b597-660670f686ac","description":""},{"name":"==Sitewide Panels==","item":[{"name":"Album Panel - Latest Albums","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"816c4ef1-7db5-4efd-92d3-eaf82fa63e85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"15\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"816c4ef1-7db5-4efd-92d3-eaf82fa63e85"},{"name":"Album Panel - Featured Albums [GAP]","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"91d2be45-c32a-42da-a828-9e91319ccd14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"FeaturedAlbumsOnly\": true,\r\n \"HasStems\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"15\",\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}}","description":"NOTE: FeaturedAlbumsOnly = true flag
\nGAP
\nStartFragment
\nFeaturedAlbumsOnly does not currently exist
EndFragm
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91d2be45-c32a-42da-a828-9e91319ccd14"},{"name":"Album Panel - Album Picklist","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"c8ec6eaf-e2d5-4550-9a6c-bc713a74251c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Album\": {\r\n \"Albums\": \"g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d\",\r\n \"OrOperation\": \"true\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"15\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8ec6eaf-e2d5-4550-9a6c-bc713a74251c"},{"name":"Track Panel - Latest Tracks","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"81b4f8c8-ebf7-4b56-bad9-c67a28bb1270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Track\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"5\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"81b4f8c8-ebf7-4b56-bad9-c67a28bb1270"},{"name":"Track Panel - Track Picklist","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"974849a5-efce-4751-8ebf-41c9df843802","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\r\n \"SearchFilters\": {\r\n \"SearchType\": \"Normal\",\r\n \"IncludeInactive\": \"false\",\r\n \"MainOnly\": \"false\",\r\n \"AlternateOnly\": \"false\",\r\n \"FeaturedLibrariesOnly\": null,\r\n \"HasStems\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Track\": {\r\n \"Tracks\": \"g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d\",\r\n \"OrOperation\": \"true\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Track\",\r\n \"Sort_Predefined\": \"\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"5\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"974849a5-efce-4751-8ebf-41c9df843802"},{"name":"Collection Panel - Collection Picklist","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"033cb938-49f4-4493-921f-58a4db742011","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Style\": {\r\n \"Styles\": \"g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d,g56ed5590ha8c7c34d\",\r\n \"OrOperation\": \"true\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Style\",\r\n \"Sort_Predefined\": \"\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"15\",\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_ServiceToken}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_ServiceToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"033cb938-49f4-4493-921f-58a4db742011"},{"name":"Playlist Panel - Latest Playlists","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"32230873-0046-4d81-aa30-b09167f6f9fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\r\n \"SearchFilters\": {\r\n \"SearchType\": \"Normal\",\r\n \"IncludeInactive\": \"false\",\r\n \"MainOnly\": \"false\",\r\n \"AlternateOnly\": \"false\",\r\n \"FeaturedLibrariesOnly\": null,\r\n \"HasStems\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Playlist\",\r\n \"Sort_Predefined\": \"Custom_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"15\",\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}}","description":"GAP
\nIt is not currently possible to search via ST_PLAYLIST, nor is it possible to get results VIEW: PLAYLIST
GAP
\nIt is not currently possible to search via ST_PLAYLIST, nor is it possible to get results VIEW: PLAYLIST
GAP
\nIt is not currently possible to search via ST_RIGHTHOLDER, nor is it possible to get results VIEW: RIGHTHOLDER
NOTE; will create the tag if it doens't yet exist
\n","urlObject":{"path":["addtomembertags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7764a33-23a9-42ec-8f2b-b5e230c70d64"},{"name":"Add Album to Tag","event":[{"listen":"test","script":{"id":"ae7f98c6-c67e-46bc-a6d8-3914c5735867","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"2976f6b8-9f32-4193-92bc-809de467fa39","exec":[""],"type":"text/javascript"}}],"id":"6ef730d8-3da2-4bf1-a3ea-3edca2a3d1dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ObjectType\": \"Album\",\n \"ObjectIDs\": [\n \"316bace72939965c\"\n ],\n \"AddToTagIDs\": [\n \"31aa846ec3de5273\",\n \"97dd0a3108fb8271\"\n ]\n}"},"url":"{{HM_ServiceAPI_URL}}/addtomembertags/{{HM_ServiceAPI_MemberToken}}","description":"NOTE; will create the tag if it doens't yet exist
\n","urlObject":{"path":["addtomembertags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ef730d8-3da2-4bf1-a3ea-3edca2a3d1dc"},{"name":"Add Playlist to Tag","event":[{"listen":"test","script":{"id":"ae7f98c6-c67e-46bc-a6d8-3914c5735867","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"2976f6b8-9f32-4193-92bc-809de467fa39","exec":[""],"type":"text/javascript"}}],"id":"6dde63bf-0af5-48ad-a870-2614cb85e0a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ObjectType\": \"Playlist\",\n \"ObjectIDs\": [\n \"316bace72939965c\"\n ],\n \"AddToTagIDs\": [\n \"31aa846ec3de5273\",\n \"97dd0a3108fb8271\"\n ]\n}"},"url":"{{HM_ServiceAPI_URL}}/addtomembertags/{{HM_ServiceAPI_MemberToken}}","description":"NOTE; will create the tag if it doens't yet exist
\n","urlObject":{"path":["addtomembertags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6dde63bf-0af5-48ad-a870-2614cb85e0a5"}],"id":"3e73b28f-fdcb-4fb8-8f2c-0cb328c4d946","_postman_id":"3e73b28f-fdcb-4fb8-8f2c-0cb328c4d946","description":""},{"name":"Download","item":[{"name":"Validate Track Download","event":[{"listen":"test","script":{"id":"eccd99b3-8198-49e6-8484-a300969b2736","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"0d00b621-fe80-4956-b0e0-b953049744a7","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"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Identifier\":\"316bace72939965c\",\r\n\t\"ContentIDs\":\"\",\r\n\t\"DownloadType\":\"track\",\r\n\t\"Format\":[\"mp3\"],\r\n\t\"TrimEndSecs\":0,\r\n\t\"TrimStartSecs\":0,\r\n\t\"IncludeVersionCheck\":false\r\n}"},"url":"{{HM_ServiceAPI_URL}}/validatemusicdownloadrequest/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["validatemusicdownloadrequest","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d00b621-fe80-4956-b0e0-b953049744a7"},{"name":"Validate Stem Pack Download","event":[{"listen":"test","script":{"id":"eccd99b3-8198-49e6-8484-a300969b2736","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"31836d21-abb7-455f-b999-d25b6a77d9a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Identifier\":\"b6a69cacaa8d8a65b80327b7ee0de8e7a\",\r\n\t\"ContentIDs\":\"\",\r\n\t\"DownloadType\":\"stems\",\r\n\t\"Format\":[\"wav\"],\r\n\t\"TrimEndSecs\":0,\r\n\t\"TrimStartSecs\":0,\r\n\t\"IncludeVersionCheck\":false\r\n}"},"url":"{{HM_ServiceAPI_URL}}/validatemusicdownloadrequest/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["validatemusicdownloadrequest","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"31836d21-abb7-455f-b999-d25b6a77d9a4"},{"name":"Validate Album Download","event":[{"listen":"test","script":{"id":"eccd99b3-8198-49e6-8484-a300969b2736","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"f53c9092-bffe-4bb4-b7aa-6a0f49aec731","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"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Identifier\":\"316bace72939965c\",\r\n\t\"ContentIDs\":\"\",\r\n\t\"DownloadType\":\"album\",\r\n\t\"Format\":[\"mp3\"],\r\n\t\"TrimEndSecs\":0,\r\n\t\"TrimStartSecs\":0,\r\n\t\"IncludeVersionCheck\":false\r\n}"},"url":"{{HM_ServiceAPI_URL}}/validatemusicdownloadrequest/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["validatemusicdownloadrequest","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f53c9092-bffe-4bb4-b7aa-6a0f49aec731"},{"name":"Validate Playlist Download","event":[{"listen":"test","script":{"id":"eccd99b3-8198-49e6-8484-a300969b2736","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"21495274-ffa8-4e99-835e-2f9d5a3a3b25","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"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Identifier\":\"316bace72939965c\",\r\n\t\"ContentIDs\":\"\",\r\n\t\"DownloadType\":\"playlist\",\r\n\t\"Format\":[\"mp3\"],\r\n\t\"TrimEndSecs\":0,\r\n\t\"TrimStartSecs\":0,\r\n\t\"IncludeVersionCheck\":false\r\n}"},"url":"{{HM_ServiceAPI_URL}}/validatemusicdownloadrequest/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["validatemusicdownloadrequest","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21495274-ffa8-4e99-835e-2f9d5a3a3b25"},{"name":"Validate Playlist Category Download","event":[{"listen":"test","script":{"id":"eccd99b3-8198-49e6-8484-a300969b2736","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"e563ba74-0814-4bb9-b5e1-56fd9172786b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Identifier\":\"316bace72939965c\",\r\n\t\"ContentIDs\":\"\",\r\n\t\"DownloadType\":\"playlistcategory\",\r\n\t\"Format\":[\"mp3\"],\r\n\t\"TrimEndSecs\":0,\r\n\t\"TrimStartSecs\":0,\r\n\t\"IncludeVersionCheck\":false\r\n}"},"url":"{{HM_ServiceAPI_URL}}/validatemusicdownloadrequest/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["validatemusicdownloadrequest","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e563ba74-0814-4bb9-b5e1-56fd9172786b"},{"name":"Get Track Download","event":[{"listen":"test","script":{"id":"c0ce855e-ca28-46c1-8fb2-0fc2a5f88cf0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"b8992dbf-8d40-400f-a62b-2a8b233d0f02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Identifier\":\"316bace72939965c\",\r\n\t\"DownloadType\":\"track\",\r\n\t\"Format\":\"mp3\",\r\n\t\"TrimStartSecs\":0,\r\n\t\"TrimEndSecs\":0,\r\n\t\"Email\":\"peter@harvestthe.net\",\r\n\t\"IsShare\":false,\r\n\t\"Message\":\"\",\r\n\t\"SenderEmail\":\"\",\r\n\t\"ForceEmail\":false,\r\n\t\"IncludeVersions\":false,\r\n\t\"VersionFolderName\":\"\",\r\n\t\"DownloadFileName\":\"\",\r\n\t\"CuesheetFileName\":\"\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmusicdownload/{{HM_ServiceAPI_MemberToken}}","description":"PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8992dbf-8d40-400f-a62b-2a8b233d0f02"},{"name":"Get Stem Pack Download","event":[{"listen":"test","script":{"id":"c0ce855e-ca28-46c1-8fb2-0fc2a5f88cf0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"3de6ebba-e969-4f8c-be9b-f7accf14ab2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Identifier\":\"b6a69cacaa8d8a65b80327b7ee0de8e7a\",\r\n\t\"DownloadType\":\"stems\",\r\n\t\"Format\":\"wav\",\r\n\t\"TrimStartSecs\":0,\r\n\t\"TrimEndSecs\":0,\r\n\t\"Email\":\"peter@harvestthe.net\",\r\n\t\"IsShare\":false,\r\n\t\"Message\":\"\",\r\n\t\"SenderEmail\":\"\",\r\n\t\"ForceEmail\":false,\r\n\t\"IncludeVersions\":false,\r\n\t\"VersionFolderName\":\"\",\r\n\t\"DownloadFileName\":\"\",\r\n\t\"CuesheetFileName\":\"\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmusicdownload/{{HM_ServiceAPI_MemberToken}}","description":"PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3de6ebba-e969-4f8c-be9b-f7accf14ab2a"},{"name":"Get Album Download","event":[{"listen":"test","script":{"id":"c0ce855e-ca28-46c1-8fb2-0fc2a5f88cf0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"4af973c6-6564-4c0c-9701-0de599deaea6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Identifier\":\"316bace72939965c\",\r\n\t\"DownloadType\":\"album\",\r\n\t\"Format\":\"mp3\",\r\n\t\"TrimStartSecs\":0,\r\n\t\"TrimEndSecs\":0,\r\n\t\"Email\":\"peter@harvestthe.net\",\r\n\t\"IsShare\":false,\r\n\t\"Message\":\"\",\r\n\t\"SenderEmail\":\"\",\r\n\t\"ForceEmail\":false,\r\n\t\"IncludeVersions\":false,\r\n\t\"VersionFolderName\":\"\",\r\n\t\"DownloadFileName\":\"\",\r\n\t\"CuesheetFileName\":\"\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmusicdownload/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4af973c6-6564-4c0c-9701-0de599deaea6"},{"name":"Get Playlist Download","event":[{"listen":"test","script":{"id":"c0ce855e-ca28-46c1-8fb2-0fc2a5f88cf0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"58c14de9-a352-49f5-b425-05de85956a92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Identifier\":\"316bace72939965c\",\r\n\t\"DownloadType\":\"playlist\",\r\n\t\"Format\":\"mp3\",\r\n\t\"TrimStartSecs\":0,\r\n\t\"TrimEndSecs\":0,\r\n\t\"Email\":\"peter@harvestthe.net\",\r\n\t\"IsShare\":false,\r\n\t\"Message\":\"\",\r\n\t\"SenderEmail\":\"\",\r\n\t\"ForceEmail\":false,\r\n\t\"IncludeVersions\":false,\r\n\t\"VersionFolderName\":\"\",\r\n\t\"DownloadFileName\":\"\",\r\n\t\"CuesheetFileName\":\"\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmusicdownload/{{HM_ServiceAPI_MemberToken}}","description":"PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58c14de9-a352-49f5-b425-05de85956a92"},{"name":"Get Playlist Category Download","event":[{"listen":"test","script":{"id":"c0ce855e-ca28-46c1-8fb2-0fc2a5f88cf0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"06d7f7fe-cc59-4a4d-9947-3e9f8bdd7516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Identifier\":\"316bace72939965c\",\r\n\t\"DownloadType\":\"playlistcategory\",\r\n\t\"Format\":\"mp3\",\r\n\t\"TrimStartSecs\":0,\r\n\t\"TrimEndSecs\":0,\r\n\t\"Email\":\"peter@harvestthe.net\",\r\n\t\"IsShare\":false,\r\n\t\"Message\":\"\",\r\n\t\"SenderEmail\":\"\",\r\n\t\"ForceEmail\":false,\r\n\t\"IncludeVersions\":false,\r\n\t\"VersionFolderName\":\"\",\r\n\t\"DownloadFileName\":\"\",\r\n\t\"CuesheetFileName\":\"\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmusicdownload/{{HM_ServiceAPI_MemberToken}}","description":"PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"06d7f7fe-cc59-4a4d-9947-3e9f8bdd7516"}],"id":"145f5f81-5aa1-4bde-83f7-de545b738e38","_postman_id":"145f5f81-5aa1-4bde-83f7-de545b738e38","description":""},{"name":"Download Cuesheet","item":[{"name":"Get Track Cuesheet","event":[{"listen":"test","script":{"id":"e554b054-27cb-4046-be9e-3815be36f4ab","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"4989007f-22f9-4f97-b7eb-b83fcdf2d4cf","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"},{"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":"{{HM_ServiceAPI_URL}}/getcuesheet/{{HM_ServiceAPI_MemberToken}}?filename={Name}.csv","urlObject":{"path":["getcuesheet","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"filename","value":"{Name}.csv"}],"variable":[]}},"response":[],"_postman_id":"4989007f-22f9-4f97-b7eb-b83fcdf2d4cf"},{"name":"Get Album Cuesheet","event":[{"listen":"test","script":{"id":"e554b054-27cb-4046-be9e-3815be36f4ab","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"01dba7ce-7478-48a4-8798-29b1c16c7935","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"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Album\": \"32fb86ab1baa3572vf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getcuesheet/{{HM_ServiceAPI_MemberToken}}?filename={Name}.csv","urlObject":{"path":["getcuesheet","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"filename","value":"{Name}.csv"}],"variable":[]}},"response":[],"_postman_id":"01dba7ce-7478-48a4-8798-29b1c16c7935"},{"name":"Get Playlist Cuesheet","event":[{"listen":"test","script":{"id":"e554b054-27cb-4046-be9e-3815be36f4ab","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"366b8d4a-8d99-49d4-9c21-74bc6595be7a","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"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Playlist\": \"999bef621d6c7b72v6\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getcuesheet/{{HM_ServiceAPI_MemberToken}}?filename={Name}.csv","urlObject":{"path":["getcuesheet","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"filename","value":"{Name}.csv"}],"variable":[]}},"response":[],"_postman_id":"366b8d4a-8d99-49d4-9c21-74bc6595be7a"}],"id":"246a7264-93fa-4261-89ab-33288670a9fb","_postman_id":"246a7264-93fa-4261-89ab-33288670a9fb","description":""},{"name":"Share","item":[{"name":"Any","item":[{"name":"Get Any Short Url","event":[{"listen":"test","script":{"id":"c7a6c7fb-4f16-4058-83c2-b7a5f4fef2db","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"2548b5b5-a401-453e-9f0e-ac3c19d80faa","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"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"URL\":\"https://www.google.com/\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getshorturl/{{HM_ServiceAPI_Token}}","urlObject":{"path":["getshorturl","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2548b5b5-a401-453e-9f0e-ac3c19d80faa"}],"id":"ecc80064-d1c0-4149-820a-fdf69fb10db6","_postman_id":"ecc80064-d1c0-4149-820a-fdf69fb10db6","description":""},{"name":"Member Folder & Playlist","item":[{"name":"Get Folder Share Url","event":[{"listen":"test","script":{"id":"21c2e318-6593-4f30-8bce-197064b4e0ea","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"a20379f3-75fe-4965-b977-bb79e7a30aec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\",\r\n \"ObjectIdentifier\": \"{MemberPlaylistCategoryID}\",\r\n \"ObjectType\": \"PlaylistCategory\",\r\n \"Users\": [\r\n {\r\n \"Username\": \"\",\r\n \"Type\": \"GuestMemberAccount\",\r\n \"ShareType\": \"Sync\",\r\n \"AllowDownload\": true,\r\n \"AllowFollow\": true,\r\n \"AllowSave\": true,\r\n \"AllowShare\": true\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}","urlObject":{"path":["getsharemusicurl","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a20379f3-75fe-4965-b977-bb79e7a30aec"},{"name":"Get Playlist Share Url","event":[{"listen":"test","script":{"id":"21c2e318-6593-4f30-8bce-197064b4e0ea","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"44f93c12-f839-4016-bfa9-67d8fdc527da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\",\r\n \"ObjectIdentifier\": \"{MemberPlaylistID}\",\r\n \"ObjectType\": \"Playlist\",\r\n \"Users\": [\r\n {\r\n \"Username\": \"\",\r\n \"Type\": \"GuestMemberAccount\",\r\n \"ShareType\": \"Sync\",\r\n \"AllowDownload\": true,\r\n \"AllowFollow\": true,\r\n \"AllowSave\": true,\r\n \"AllowShare\": true\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}","urlObject":{"path":["getsharemusicurl","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"44f93c12-f839-4016-bfa9-67d8fdc527da"}],"id":"f0861627-9265-46b4-845c-4cd416789b15","_postman_id":"f0861627-9265-46b4-845c-4cd416789b15","description":""}],"id":"7f4f93a7-060c-439b-a3c5-e162c1d8ffb6","_postman_id":"7f4f93a7-060c-439b-a3c5-e162c1d8ffb6","description":""},{"name":"Tag Based Similarity","item":[{"name":"Get Tracks Based on Tags","event":[{"listen":"test","script":{"id":"c0ce855e-ca28-46c1-8fb2-0fc2a5f88cf0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"45ddc274-e02d-4b4f-8536-ef370dda7883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"Track\": \"6af81bfe4aca90d11448aed6cb15cdb5e0\",\r\n \"MainOnly\": true,\r\n \"Skip\": 0,\r\n \"Limit\": 20,\r\n \"SimilarityPercentage\": 50,\r\n \"SimilarityMethod\": \"Category\",\r\n \"Categories\": [\r\n {\r\n \"ID\": \"c679bcac74f3b93120\",\r\n \"Type\": \"Category\"\r\n },\r\n {\r\n \"ID\": \"a78bef9f9833ced3f4\",\r\n \"Type\": \"Category\"\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsimilartracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["getsimilartracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45ddc274-e02d-4b4f-8536-ef370dda7883"}],"id":"e3ffa1b1-acb5-4ae5-95c5-141a41f9d489","_postman_id":"e3ffa1b1-acb5-4ae5-95c5-141a41f9d489","description":""}],"id":"940defc3-0638-40a3-936b-b00d632c1a3e","_postman_id":"940defc3-0638-40a3-936b-b00d632c1a3e","description":""},{"name":"Home Page","item":[{"name":"Get Collections","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"6be16929-3174-450e-b417-92b544ad917d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Style\",\r\n \"Sort_Predefined\": \"Alphabetic_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"5\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6be16929-3174-450e-b417-92b544ad917d"},{"name":"Contact Us Email","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"6c61af3d-36c2-476f-9b52-21f558fde4af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"Name\": \"\",\r\n \"Email\": \"{{email}}\",\r\n \"PhoneNumber\": \"\",\r\n \"Subject\": \"\",\r\n \"Message\": \"{{message}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendcontactusemail/{{HM_ServiceAPI_Token}}","description":"This endpoint delivers an enquiry for the account admin owner and also sends a copy of the message to the sender. Email (of the enquirer) and Message are mandatory.
\n","urlObject":{"path":["sendcontactusemail","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"67b97bbd-2be0-4087-9f77-33e042e6fe8a","name":"Contact Us Email (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 \"Name\": \"\",\r\n \"Email\": \"{{email}}\",\r\n \"PhoneNumber\": \"\",\r\n \"Subject\": \"\",\r\n \"Message\": \"{{message}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendcontactusemail/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Sep 2024 08:55:53 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":"6c61af3d-36c2-476f-9b52-21f558fde4af"},{"name":"Custom Contact Us","id":"ba174196-455e-4a96-8e34-f7d35aeda586","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"ToEmail\": [\"{{toemail1}}\", \"{{toemail2}}\"],\r\n \"BodyRequest\": \"{{bodyHTMLrequest}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendcustomcontactusemail/{{HM_ServiceAPI_MemberToken}}","description":"This endpoint delivers a customized HTML message to any recipient added to \"ToEmail\" list, and a notification email to the member (sender). ToEmail (the recipient) and Body Request are mandatory
\n","urlObject":{"path":["sendcustomcontactusemail","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"adc74044-f9ee-421f-9b2d-89f467d6ddcd","name":"Custom Contact Us","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 \"ToEmail\": [\"{{toemail1}}\", \"{{toemail2}}\"],\r\n \"BodyRequest\": \"{{bodyHTMLrequest}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendcustomcontactusemail/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Oct 2024 00:33: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 \"Code\": \"OK\"\n}"}],"_postman_id":"ba174196-455e-4a96-8e34-f7d35aeda586"}],"id":"f56a0886-0cee-4d7b-b30f-a0aaf4a5d884","_postman_id":"f56a0886-0cee-4d7b-b30f-a0aaf4a5d884","description":""},{"name":"Registration Page","item":[{"name":"Get Countries","event":[{"listen":"test","script":{"id":"d4073fef-dd8f-4bb8-8f25-14a07e88d493","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"1726dfa0-9fa3-43ba-9e58-bfabfcf2d1cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getcountries/{{HM_ServiceAPI_Token}}","urlObject":{"path":["getcountries","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1726dfa0-9fa3-43ba-9e58-bfabfcf2d1cb"},{"name":"Signup Member","event":[{"listen":"test","script":{"id":"dfd39d46-a146-4f56-a01f-72a2d1ad59ae","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c3b12df1-da28-41a2-9367-9d23ab5e240a","exec":[""],"type":"text/javascript"}}],"id":"80624dc6-8b56-49c7-89f1-777dcb5a8632","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"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"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\":\"test@test.com\",\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\":\"test@test.com\",\r\n\t\t\"Password\":\"testpassword\",\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 \"PositionType\":\"Manager\",\r\n \"Freelancer\":\"false\",\r\n\t\t\"IP\":\"{Users IP}\"\r\n\t},\r\n\t\"NoMemberEmail\":false\r\n}"},"url":"{{HM_ServiceAPI_URL}}/registermember/{{HM_ServiceAPI_Token}}","urlObject":{"path":["registermember","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80624dc6-8b56-49c7-89f1-777dcb5a8632"},{"name":"Signup Member (MG)","event":[{"listen":"test","script":{"id":"dfd39d46-a146-4f56-a01f-72a2d1ad59ae","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c3b12df1-da28-41a2-9367-9d23ab5e240a","exec":[""],"type":"text/javascript"}}],"id":"4f290853-43e4-492a-9247-fbb73830048a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"test@test.com\",\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\":\"test@test.com\",\r\n\t\t\"Password\":\"testpassword\",\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 \"PositionType\":\"Manager\",\r\n \"Freelancer\":\"false\",\r\n\t\t\"IP\":\"{Users IP}\"\r\n\t},\r\n\t\"NoMemberEmail\":false\r\n}"},"url":"{{HM_ServiceAPI_URL}}/registermember/{{HM_ServiceAPI_Token}}","urlObject":{"path":["registermember","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f290853-43e4-492a-9247-fbb73830048a"}],"id":"3e12ff19-9397-4caf-a538-80301c2d7f34","_postman_id":"3e12ff19-9397-4caf-a538-80301c2d7f34","description":""},{"name":"Login Page","item":[{"name":"Signin Member","event":[{"listen":"test","script":{"id":"781134a3-39fd-4d09-9fe5-ea6f5f7e6b66","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;\r","\r","var jsonData = null;\r","var jsonDataToken = \"\";\r","var jsonDataPersistentToken = \"\";\r","\r","if (responseBody.indexOf(\"= 0) {\r"," jsonData = xml2Json(responseBody);\r"," jsonDataToken = jsonData.responsemembertoken.membertoken.$.value;\r"," jsonDataPersistentToken = jsonData.responsemembertoken.persistentlogintoken.$.token;\r","} else {\r"," jsonData = JSON.parse(responseBody)\r"," jsonDataToken = jsonData.MemberToken.Value;\r"," jsonDataPersistentToken = jsonData.PersistentLoginToken.Token;\r","}\r","\r","console.log(\"HM_ServiceAPI_MemberToken set to \" + jsonDataToken);\r","console.log(\"HM_ServiceAPI_MemberPersistentToken set to \" + jsonDataPersistentToken);\r","console.log(\"HM_ServiceAPI_MemberTokenIsLoggedMember set to true\");\r","\r","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberToken\", jsonDataToken);\r","postman.setEnvironmentVariable(\"HM_IntegrationAPI_MemberToken\", jsonDataToken);\r","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberPersistentToken\", jsonDataPersistentToken);\r","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberTokenIsLoggedMember\", \"true\");\r","\r","postman.setNextRequest(\"Get Member Details\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8f8dcfdb-e7c8-46a5-82e1-381b8950be0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"UserName\":\"{{HM_ServiceAPI_MemberUsername}}\",\r\n\t\"Password\":\"{{HM_ServiceAPI_MemberPassword}}\",\r\n\t\"PersistentLogin\":true,\r\n\t\"ReturnMemberDetails\":false,\r\n \"ReturnMemberSubscriptionDetails\":true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getmembertoken/{{HM_ServiceAPI_Token}}","description":"A temporary password can be set up for a user via the Harvest Admin and OKTA webhook when leaving a group.
\nWhen a user is in this state, the following can be observed.
\n{\n \"MemberToken\": {\n \"Value\": \"9ebf1ca21c3c298d31b520fb0b5f79f2\",\n \"Expiry\": \"2024-12-12T08:11:07.4\",\n \"UTCOffset\": 11.0,\n \"TemporaryPassword\": \"true\",\n \"Type\": \"MemberToken\",\n \"IsOfSingleUse\": false\n },\n \"PersistentLoginToken\": {\n \"Token\": \"c8e2a8f6feab4bff8ea843966da59b92\",\n \"Expiry\": \"2025-03-11T08:11:07.557\",\n \"UTCOffset\": 11.0\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 on login to determine whether to show the user the “set a new password for your account” modal.
\nPlease Note: the TemporaryPassword property will also be present if the user is using a temporary password for all other member related responses such as Get Member Details (/getmember) or Update Member Details (/updatemember)
Note: we get 30, instead of 5, to try and prevent the same album from showing 5 times.
\nWe want unique labels/albums here if we can.
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"16ee5fb5-094f-45c7-9d36-648b6de83498"}],"id":"fd25dc90-9b8b-469b-aad8-4b39e4bd8567","_postman_id":"fd25dc90-9b8b-469b-aad8-4b39e4bd8567","description":""},{"name":"Suggested [TBC]","item":[],"id":"93f7b860-65cf-4b63-a197-fd4193c9e7ee","_postman_id":"93f7b860-65cf-4b63-a197-fd4193c9e7ee","description":""},{"name":"Member Hub","item":[{"name":"Get Productions","event":[{"listen":"test","script":{"id":"830bd936-ac4a-472f-a252-bb194a7ccab1","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"c1cb48b1-5ed2-4835-86cc-d26dd283aefe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupproductions/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_MemberGroupID}}?sort={{HM_ServiceAPI_PlaylistSortOrder}}","description":"Returns 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, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc
\n","urlObject":{"path":["getmembergroupproductions","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberGroupID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"sort","value":"{{HM_ServiceAPI_PlaylistSortOrder}}"}],"variable":[]}},"response":[],"_postman_id":"c1cb48b1-5ed2-4835-86cc-d26dd283aefe"},{"name":"Get Production Categories","event":[{"listen":"test","script":{"id":"935465e6-2394-4951-9a69-6c54c71e700c","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"a21162c0-8c2c-4786-b157-2ca7c8efbb76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupproductioncategories/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_MemberGroupID}}/{{HM_ServiceAPI_MemberGroupProductionID}}?returnplaylistcount={{HM_ServiceAPI_ShowCounts}}&skip={{HM_ServiceAPI_Skip}}&limit={{HM_ServiceAPI_Limit}}&sort={{HM_ServiceAPI_PlaylistSortOrder}}","description":"Returns 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, Created_Asc, Created_Desc, LastUpdated_Asc, LastUpdated_Desc
\n","urlObject":{"path":["getmembergroupproductioncategories","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberGroupID}}","{{HM_ServiceAPI_MemberGroupProductionID}}"],"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":[],"_postman_id":"a21162c0-8c2c-4786-b157-2ca7c8efbb76"},{"name":"Get Production Categories & Playlists","event":[{"listen":"test","script":{"id":"19b0211d-829c-4bdc-8b89-0c0412575cd8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"4ed84c1b-6c38-4f26-84d9-97f4bec7fd79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupproductioncategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_MemberGroupID}}/{{HM_ServiceAPI_MemberGroupProductionID}}?returnplaylistcount={{HM_ServiceAPI_ShowCounts}}&returntrackcount={{HM_ServiceAPI_ShowCounts}}&returnrootobjectsonly={{HM_ServiceAPI_ShowCounts}}&productioncategoryid={{HM_ServiceAPI_MemberGroupProductionCategoryID}}&skip={{HM_ServiceAPI_Skip}}&limit={{HM_ServiceAPI_Limit}}&sort={{HM_ServiceAPI_PlaylistSortOrder}}","description":"Returns a list of categories & playlists that are associated with the production in this Member Group.
\nWill return errors when:
\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
\n","urlObject":{"path":["getmembergroupproductioncategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberGroupID}}","{{HM_ServiceAPI_MemberGroupProductionID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"returntrackcount","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"returnrootobjectsonly","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"productioncategoryid","value":"{{HM_ServiceAPI_MemberGroupProductionCategoryID}}"},{"key":"skip","value":"{{HM_ServiceAPI_Skip}}"},{"key":"limit","value":"{{HM_ServiceAPI_Limit}}"},{"key":"sort","value":"{{HM_ServiceAPI_PlaylistSortOrder}}"}],"variable":[]}},"response":[],"_postman_id":"4ed84c1b-6c38-4f26-84d9-97f4bec7fd79"},{"name":"Get Production Playlist & Tracks","event":[{"listen":"test","script":{"id":"9dbdd5ec-3b3b-46f9-accb-5d77117fb3b6","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"d50d4510-87e0-4c48-9ab6-a1872dff4c66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupproductionplaylistandtracks/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_MemberGroupID}}/{{HM_ServiceAPI_MemberGroupProductionID}}/{{HM_ServiceAPI_FeaturedPlaylistID}}?returntracks={{HM_ServiceAPI_ShowCounts}}&includeinactive={includeInactive}&languagecode={{HM_ServiceAPI_LanguageCode}}&skip={{HM_ServiceAPI_Skip}}&limit={{HM_ServiceAPI_Limit}}&sort={{HM_ServiceAPI_PlaylistSortOrder}}","description":"Returns 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}}","{{HM_ServiceAPI_MemberGroupID}}","{{HM_ServiceAPI_MemberGroupProductionID}}","{{HM_ServiceAPI_FeaturedPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returntracks","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"includeinactive","value":"{includeInactive}"},{"key":"languagecode","value":"{{HM_ServiceAPI_LanguageCode}}"},{"key":"skip","value":"{{HM_ServiceAPI_Skip}}"},{"key":"limit","value":"{{HM_ServiceAPI_Limit}}"},{"key":"sort","value":"{{HM_ServiceAPI_PlaylistSortOrder}}"}],"variable":[]}},"response":[],"_postman_id":"d50d4510-87e0-4c48-9ab6-a1872dff4c66"}],"id":"a45800af-808e-4cab-a724-348169efc8f2","_postman_id":"a45800af-808e-4cab-a724-348169efc8f2","description":""}],"id":"22895395-8e1a-4f9f-913d-a1dc3c33c299","_postman_id":"22895395-8e1a-4f9f-913d-a1dc3c33c299","description":""},{"name":"Member Profile Page","item":[{"name":"Get Member Details","event":[{"listen":"test","script":{"id":"2efe7b8a-4c54-4a50-b233-8f408918664b","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"02404c5b-c139-4aa6-b366-f89ec3a5ab0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getmember/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["getmember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"02404c5b-c139-4aa6-b366-f89ec3a5ab0d"},{"name":"Request Password Change","event":[{"listen":"test","script":{"id":"23208e14-709a-4caa-8cfc-31b0cbc43ed3","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"dc2782f6-147e-411e-8ba4-e5a27ee69ac3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\": \"\",\r\n\t\"Email\": \"test@test.com\",\r\n\t\"LanguageCode\": \"EN\",\r\n\t\"ResetLink\":\"https://yourdomain.com/reset?token={token}\",\r\n\t\"TokenMergeString\": \"{token}\",\r\n\t\"UseShortUrl\": false,\r\n\t\"ResetTokenExpiryHours\": 2\r\n}"},"url":"{{HM_ServiceAPI_URL}}/sendpasswordresetlinkemail/{{HM_ServiceAPI_Token}}","urlObject":{"path":["sendpasswordresetlinkemail","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc2782f6-147e-411e-8ba4-e5a27ee69ac3"},{"name":"Update Member","event":[{"listen":"test","script":{"id":"23208e14-709a-4caa-8cfc-31b0cbc43ed3","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"d5f82ff6-94bc-4e42-86da-04e0a2d78f05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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}"},"url":"{{HM_ServiceAPI_URL}}/updatemember/{{HM_ServiceAPI_Token}}","description":"PLEASE NOTE: when a member is on their profile page you will be loading member details by doing /getmember/, if there is no field called \"SubscribeNewsletter\" it means the member has Assumed Opt-In, so you should not offer the option to update the variable \"subscribe\" in /updatemember/
Notes:
\nDates must be provided to the API in UTC
\n","urlObject":{"path":["gethistorybymembertoken","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-01-12"},{"key":"skip","value":"0"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"618dd0f5-bf05-4354-b667-b40d7f527c5e"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"d581b9a5-3516-49a3-974d-12da768cedaf","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"false\",\r\n\t\"ReturnCategories\":\"true\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"true\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"true\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"b72b78ef520c1f1d65538be16b8b6d20\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d581b9a5-3516-49a3-974d-12da768cedaf"}],"id":"8967ae19-9229-4b7d-9dcd-1f9b026c45b5","_postman_id":"8967ae19-9229-4b7d-9dcd-1f9b026c45b5","description":""},{"name":"Member All Download History Page","item":[{"name":"Get Download History","event":[{"listen":"test","script":{"id":"c80bdc6b-8703-4546-b4ef-420776e84ff0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"04bd5f2a-ab4e-4fea-8ea6-ee7cbbf03a2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getdownloadhistorybymembertoken/{{HM_ServiceAPI_MemberToken}}?startdate=2023-01-01&enddate=2023-01-12&skip=0&limit=10","urlObject":{"path":["getdownloadhistorybymembertoken","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-01-12"},{"key":"skip","value":"0"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"04bd5f2a-ab4e-4fea-8ea6-ee7cbbf03a2b"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"ef269d67-ec5d-46bb-b296-d91bf9078c53","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef269d67-ec5d-46bb-b296-d91bf9078c53"}],"id":"40b33142-ed6b-4239-8c43-67b451f6ba46","_postman_id":"40b33142-ed6b-4239-8c43-67b451f6ba46","description":""},{"name":"Member All Playlists Page","item":[{"name":"Left Panel","item":[{"name":"Tree","item":[{"name":"Get Left Panel Folder & Playlists - Playlists within a Folder","event":[{"listen":"test","script":{"id":"5f1b0483-37de-447d-bd54-05ae11862ae3","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"5a002484-c687-4f36-aea2-ee25566e699a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmemberplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&returntrackcount=true&returnrootobjectsonly=true&returnautosaveonly=false&returnfirstautosave=false&returnhighlightonly=false&playlistcategoryid={CategoryID}&skip=0&limit=20&sort=LastUpdated_Desc","description":"NOTE: Use the playlistcategoryid field to get contents of a folder
COLLABORATION PLAYLIST
\nIf IsCollaboration = true then the playlist is a collaboration. You can use this to show the collab icon in the left panel
If IsOwner = true then this user owns this playlist and so has full access to the playlist. If false then this is a recipient.
If IsOwner = true then IsEditable will always be true
If IsEditable = true then this member has editor rights. If false then this is a listener user
Below is a sample response for a collaborator who received a playlist:
\n `\"IsEditable\": true, \"IsCollaboration\": true, \"HasCollaborator\": true, \"CollaboratingDate\": \"7/1/2024 8:22:37 AM\", \"IsOwner\": false, \"IsPublishable\": false, \"HasPublishMember\": false, \"LasPublishDate\": \"\"`\n\nRequest
\nreturnplaylists=all/mine/received/sent
If not provided, will be set to mine
returnplaylists=all will return all owned and shared playlists
returnplaylists=mine will return all owned
returnplaylists=received will return received shared playlists only
returnshared=sent will return playlists that have been shared somewhere
Response
\nNew properties in the response:
\nIsEdittable
\nIsCollaboration
\nHasCollaborators
\nCollaboratingDate
\nIsOwner
\nIsPublishable
\nHasPublishMembers
\nLastPublishDate
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["getmemberplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"returnplaylistcount","value":"true"},{"key":"returntrackcount","value":"true"},{"key":"returnrootobjectsonly","value":"true"},{"key":"returnautosaveonly","value":"false"},{"key":"returnfirstautosave","value":"false"},{"key":"returnhighlightonly","value":"false"},{"key":"playlistcategoryid","value":"{CategoryID}"},{"key":"skip","value":"0"},{"key":"limit","value":"20"},{"key":"sort","value":"LastUpdated_Desc"}],"variable":[]}},"response":[{"id":"36b55596-a2aa-4529-a2d8-b61d4176553c","name":"Flex Get Member Playlist Categories & Playlists","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={{HM_ServiceAPI_ShowCounts}}&returntrackcount={{HM_ServiceAPI_ShowCounts}}&playlistcategoryid=b38c3585f24296a4&skip=0&limit=10","host":["{{HM_ServiceAPI_URL}}"],"path":["getmemberplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"returnplaylistcount","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"returntrackcount","value":"{{HM_ServiceAPI_ShowCounts}}"},{"key":"returnrootobjectsonly","value":"{{HM_ServiceAPI_ShowCounts}}","disabled":true},{"key":"returnautosaveonly","value":"{{HM_ServiceAPI_ShowCounts}}","disabled":true},{"key":"returnfirstautosave","value":"{{HM_ServiceAPI_ShowCounts}}","disabled":true},{"key":"returnhighlightonly","value":"{{HM_ServiceAPI_ShowCounts}}","disabled":true},{"key":"returnplaylistcollaboratingcount","value":"{{HM_ServiceAPI_ShowCounts}}","disabled":true},{"key":"playlistcategoryid","value":"b38c3585f24296a4"},{"key":"skip","value":"0"},{"key":"limit","value":"10"},{"key":"sort","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2024 20:26:25 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\": \"b38c3585f24296a4\",\n \"Name\": \"Test Playlist Category\",\n \"Description\": \"This is a test Playlist Category\",\n \"ObjectType\": \"PlaylistCategory\",\n \"HasImage\": false,\n \"AutoSave\": false,\n \"HighlightTracks\": false,\n \"CreatedDate\": \"8/10/2024 6:15:54 AM\",\n \"ColorHex\": \"000\",\n \"PlaylistsCount\": \"1\",\n \"PlaylistCollaboratingOwnerCount\": 0,\n \"PlaylistCollaboratingCount\": 0,\n \"Playlists\": [\n {\n \"Name\": \"test playlist\",\n \"ID\": \"d4f89a8d045e8ee4\",\n \"Description\": \"\",\n \"CreatedDate\": \"8/6/2024 10:48:04 PM\",\n \"LastUpdateDate\": \"8/10/2024 6:24:54 AM\",\n \"TrackCount\": \"4\",\n \"Tracks\": [],\n \"RelatedPlaylists\": [],\n \"HasImage\": false,\n \"Tags\": \"\",\n \"LanguageItems\": [],\n \"AutoSave\": false,\n \"Type\": \"Curated\",\n \"ObjectType\": \"Playlist\",\n \"OrderBy\": \"Custom_Asc\",\n \"ExternalPlaylistImageUrl\": \"\",\n \"HighlightTracks\": false,\n \"MaxOrderID\": \"3\",\n \"IsEditable\": true,\n \"IsCollaboration\": true,\n \"HasCollaborator\": false,\n \"IsOwner\": true,\n \"IsPublishable\": false,\n \"HasPublishMember\": false\n }\n ]\n }\n ],\n \"TotalPlaylistsCount\": \"1\",\n \"TotalPlaylistCategoriesCount\": \"1\",\n \"TotalCount\": \"1\"\n}"}],"_postman_id":"5a002484-c687-4f36-aea2-ee25566e699a"},{"name":"Search Left Panel Folder & Playlists Tree","event":[{"listen":"test","script":{"id":"4a81478a-8d14-4205-b356-5c2290341d8a","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"e994c040-f2d0-405b-a8d7-e5379ab93f8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"Keywords\": \"\",\r\n \"ReturnPlaylistCount\": true,\r\n \"ReturnTrackCount\": true,\r\n \"ReturnContentsOnCategoryMatch\": false,\r\n \"Skip\": 0,\r\n \"Limit\": 20,\r\n \"Sort\": \"LastUpdated_Desc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchmemberplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["searchmemberplaylistcategoriesandplaylists","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e994c040-f2d0-405b-a8d7-e5379ab93f8d"}],"id":"76045712-7e58-4318-a504-1a1d8ccef59c","_postman_id":"76045712-7e58-4318-a504-1a1d8ccef59c","description":""},{"name":"Folders","item":[{"name":"Create Playlist Folder","event":[{"listen":"test","script":{"id":"88906464-72ba-4a16-8879-022007ff3e60","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"279f9d0f-d76b-4686-866c-9ea47c0ae269","exec":[""],"type":"text/javascript"}}],"id":"361d34f6-b632-4b2c-970e-3991d3e93910","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 A\",\r\n\t\"PlaylistCategoryDescription\": \"\",\r\n\t\"ColorHex\": \"\",\r\n\t\"AddToTop\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addmemberplaylistcategory/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["addmemberplaylistcategory","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"361d34f6-b632-4b2c-970e-3991d3e93910"},{"name":"Update Playlist Folder","event":[{"listen":"prerequest","script":{"id":"0d2dd453-dcc0-49d9-9f88-a159f2623bca","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"f1a7f5e6-df2f-4d30-91f9-ef6c7d218013","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"c5e5f76c-7462-4b63-a0c1-6ecade5c8072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 B\",\r\n \"PlaylistCategoryDescription\": \"\",\r\n\t\"ColorHex\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatememberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_NewMemberPlaylistCategoryID}}","urlObject":{"path":["updatememberplaylistcategory","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistCategoryID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5e5f76c-7462-4b63-a0c1-6ecade5c8072"},{"name":"Reorder Folder","event":[{"listen":"test","script":{"id":"6a1737c2-c80a-4958-83bf-ad9009001cd1","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"17e91056-28a7-4363-b5c1-a0870050a645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/reordermemberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_NewMemberPlaylistCategoryID}}?OrderID={OrderID}","description":"NOTE: 0-index based
\n","urlObject":{"path":["reordermemberplaylistcategory","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistCategoryID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"OrderID","value":"{OrderID}"}],"variable":[]}},"response":[],"_postman_id":"17e91056-28a7-4363-b5c1-a0870050a645"},{"name":"Delete Folder - Keep Child Playlists","event":[{"listen":"test","script":{"id":"8e69592f-aab4-48ad-a2e1-ddd31dfc45bd","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"720cf3fe-a45f-413c-a864-28b42b8a1d67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removememberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_NewMemberPlaylistCategoryID}}?keepChildren=true","description":"PLAYLIST COLLABORATION
\ngiveShareCopy=true will provide the recipient with a non-publishable copy of the playlist.
giveShareCopy=false will see the recipients immediately lose access to the playlist and not receive their own point in time version
keepChildren=true will continue to put the playlist (collaboration or not to the root)
keepChildren=false will remove the member from the share
Owners
\nFull use of giveShareCopy
Full use of keepChildren
Recipients
\nBlocked from using giveShareCopy
Full use of keepChildren
PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nAll recipients
\nFLAGGING
\nUse the property \"HighlightTracks\": true to flag a playlist and it's tracks.
NOTE: Use the playlistcategoryid to assign a newly created playlist straight into a folder
PLAYLIST COLLABORATION
\nResponse body a few new properties here
\nCreateDate
\nLastUpdateDate
\nIsEdittable
\nIsCollaboration
\nHasCollaborators
\nCollaboratingDate
\nIsOwner
\nIsPublishable
\nHasPublishMembers
\nLastPublishDate
\nOwners
\nFull use
\nRecipients
\nOnly for allowEdit collaborators
FLAGGING
\nUse the property \"HighlightTracks\": true to flag a playlist and it's tracks.
Owners
\nFull use
\nRecipients
\nOnly for allowEdit collaborators
FLAGGING
\nUse the property \"AutoSaveApplyToHighlightTracks: true\" to flag a playlist and it's tracks. The idea for this is that setting AutoSave on a playlist is usually the current working playlist for the user. So it makes sense they may want to track the tracks and so flag the playlist in one API call
PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\nFLAGGING
\nThis dedicated endpoint is unique in that it will return the list of trackIDs (only) that are now flagged. Using this will allow you to display any tracks that are currently on the DOM in the new flagged state without having to reload all of the panel of tracks anew.
\nTo obtain the trackIDs set: \"HighlightReturnTracks\": true
PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["reordermemberplaylist","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"movetoplaylistcategoryid","value":""},{"key":"orderid","value":"{OrderID}"}],"variable":[]}},"response":[],"_postman_id":"4461c895-cccb-4de2-99f2-d0581c0933cc"},{"name":"Reorder Member Playlist to Folder","event":[{"listen":"test","script":{"id":"d39024ed-39bd-49dc-9312-c7f44ee0bb6e","exec":[""],"type":"text/javascript"}}],"id":"3ebc5ea2-d5a4-46c7-bcf1-4406f95bc561","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/reordermemberplaylist/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_NewMemberPlaylistID}}?movetoplaylistcategoryid={CategoryID}&orderid={OrderID}","description":"NOTE: Use the playlistcategoryid to assign to the orderid position in the folder
PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["reordermemberplaylist","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"movetoplaylistcategoryid","value":"{CategoryID}"},{"key":"orderid","value":"{OrderID}"}],"variable":[]}},"response":[],"_postman_id":"3ebc5ea2-d5a4-46c7-bcf1-4406f95bc561"},{"name":"Deleted Playlist","event":[{"listen":"test","script":{"id":"18dc4635-e16a-42bb-964a-0eb372dabacf","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"b723dc6b-e5a1-4fd9-ac2e-472a452843c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/removeplaylist/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_NewMemberPlaylistID}}","description":"COLLABORATION PLAYLIST
\nFor collaborative playlists when deleting the playlist you have the option to give a copy to collaborators in the playlist:
\n{{HM_ServiceAPI_URL}}/removeplaylist/{{HM_ServiceAPI_MemberToken}}/{PlaylistID}?giveShareCopy={giveShareCopy}
If giveShareCopy = true then all collaborators will receive a snapshot copy of this playlist in their account.
Owners
\nFull use
\nRecipients
\nBlocked from use
\n","urlObject":{"path":["removeplaylist","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b723dc6b-e5a1-4fd9-ac2e-472a452843c4"},{"name":"Duplicate Playlist","event":[{"listen":"test","script":{"id":"1fec085a-c0a5-443c-9595-a5fe94973b0a","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c77476b0-3f82-43b3-a299-2375a7599de0","exec":[""],"type":"text/javascript"}}],"id":"e74a2381-437f-49da-a723-ef2a65709189","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"SourcePlaylistID\": \"{PlaylistID}\",\r\n \"DuplicatePlaylistName\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/duplicatememberplaylist/{{HM_ServiceAPI_MemberToken}}","description":"PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nAll recipients
\n","urlObject":{"path":["duplicatememberplaylist","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e74a2381-437f-49da-a723-ef2a65709189"},{"name":"Compare Playlist","event":[{"listen":"test","script":{"id":"1fec085a-c0a5-443c-9595-a5fe94973b0a","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c77476b0-3f82-43b3-a299-2375a7599de0","exec":[""],"type":"text/javascript"}}],"id":"b2ae8755-df58-41ff-af84-157e6ed4b2fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"Playlists\": [\r\n \"{PlaylistID}\"\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}}/{{HM_ServiceAPI_NewMemberPlaylistID}}","urlObject":{"path":["filtermemberplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2ae8755-df58-41ff-af84-157e6ed4b2fc"}],"id":"1687e463-cc16-4020-a4ed-7e0aba420dac","_postman_id":"1687e463-cc16-4020-a4ed-7e0aba420dac","description":""},{"name":"Share Modal","item":[{"name":"Get Playlist Share URL","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","// var jsonData = null;","// var jsonDataToken = \"\";","","// if (responseBody.indexOf(\"= 0) {","// jsonData = xml2Json(responseBody);"," ","// console.log(jsonData.responseengageshare.url.split(\"/\")[jsonData.responseengageshare.url].split(\"/\").length -1);"," ","// jsonDataToken = jsonData.responseengageshare.url.split(\"/\")[jsonData.responseengageshare.url].split(\"/\").length -1;","// } else {","// jsonData = JSON.parse(responseBody)","// jsonDataToken = jsonData.Url.split(\"/\")[jsonData.Url.split(\"/\").length -1];","// }","","// console.log(\"HM_ServiceAPI_EnageAccessToken set to \" + jsonDataToken);","","// postman.setEnvironmentVariable(\"HM_ServiceAPI_EnageAccessToken\", jsonDataToken);","","// postman.setNextRequest(\"Get Shared Playlist By Engage\");"],"type":"text/javascript","id":"351cd360-8dda-411e-b4f5-c22a49ee2ca3"}}],"id":"b2f1166d-dad0-4c30-ae03-8ba2e137e07b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\",\r\n // \"ToMemberToken\": \"{{HM_ServiceAPI_EngageToMemberToken}}\",\r\n \"ObjectIdentifier\": \"2b1a4d9911916190\",\r\n \"ObjectType\": \"Playlist\",\r\n // \"ShareType\": \"Sync\",\r\n // \"AllowDownload\": true,\r\n // \"AllowFollow\": true,\r\n // \"AllowSave\": true,\r\n // \"AllowShare\": true\r\n \"Users\": [\r\n {\r\n \"Username\": \"\",\r\n \"Type\": \"GuestMemberAccount\",\r\n \"ShareType\": \"Sync\",\r\n \"AllowDownload\": false,\r\n \"AllowFollow\": false,\r\n \"AllowSave\": false,\r\n \"AllowShare\": false,\r\n \"AllowCollaboration\": false,\r\n \"AllowEdit\": false\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}","description":"Gets a playlist share URL that can be shared to guests and other members alike.
\nRequest Elements
\nRequest Notes
\nFor this call you will require a MemberToken of the sender and the playlist ID.
The rest of the request body values will need to be changed depening on preference.
You get an array of Users, each user can be either a member or a guest and have their own set of parameters, given there is already another method to deliver a playlist to members (Deliver Share Music) we will only explain how to send a shareURL to a guest.
\nFor a guest you will pass the following:
\"Username\": \"\",
\"Type\": \"GuestMemberAccount\",
Once a share URL is obtained please convert it to a short URL using {{HM_ServiceAPI_URL}}/getshorturl/{{HM_ServiceAPI_Token}}
\nit is possible to send the URL to an email address using Send Share Music Email (
\n\nPLAYLIST COLLABORATION
\nSome combinations of ShareType, AllowEdit and AllowCollaboration will not work.
\nSync Notes:
\nShareType = Sync for collaboration
AllowCollaboration = true + AllowEdit = false = Read-Only collaborator
AllowCollaboration = true + AllowEdit = true = Editable collaborator
Copy Notes:
\nShareType = Copy for publishable
AllowPublish is enabled in the background automatically. This is not a configurable property
Owners
\nFull use
\nRecipients
\nBlocked entirely
\nOther request body elements:
\n","urlObject":{"path":["getsharemusicurl","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2da7646b-5e2f-42e7-b10d-04f39741518a","name":"Playlist URL to share with guests as Copy","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 \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\",\r\n \"ObjectIdentifier\": \"d4f89a8d045e8ee4\",\r\n \"ObjectType\": \"Playlist\",\r\n \"Users\": [\r\n {\r\n \"Username\": \"\",\r\n \"Type\": \"GuestMemberAccount\",\r\n \"ShareType\": \"Copy\",\r\n \"AllowDownload\": false,\r\n \"AllowFollow\": false,\r\n \"AllowSave\": false,\r\n \"AllowShare\": false,\r\n \"AllowCollaboration\": false,\r\n \"AllowEdit\": false\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Aug 2024 12:51:26 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 \"ShareMusic\": [\n {\n \"Username\": \"guest\",\n \"Status\": \"Success\",\n \"Url\": \"http://search.kongamusic.com/engage-playlist/d6b5714e9dc0774f1d2781b1e946e6b3\"\n }\n ]\n}"},{"id":"25ef2c76-d1ee-4eb2-b306-86c7ab3a45c4","name":"Playlist URL to share with guests as Sync but as Listeners only","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 \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\",\r\n \"ObjectIdentifier\": \"d4f89a8d045e8ee4\",\r\n \"ObjectType\": \"Playlist\",\r\n\r\n \"Users\": [\r\n {\r\n \"Username\": \"\",\r\n \"Type\": \"GuestMemberAccount\",\r\n \"ShareType\": \"Sync\",\r\n \"AllowDownload\": false,\r\n \"AllowFollow\": false,\r\n \"AllowSave\": false,\r\n \"AllowShare\": false,\r\n \"AllowCollaboration\": true,\r\n \"AllowEdit\": false\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Aug 2024 14:48:24 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 \"ShareMusic\": [\n {\n \"Username\": \"guest\",\n \"Status\": \"Success\",\n \"Url\": \"http://search.kongamusic.com/engage-playlist/c02dd4c6e2a13761142a94cf3eb41d77\"\n }\n ]\n}"},{"id":"13bf41e5-08b5-4bb3-be69-ebfbd720a32a","name":"Playlist URL to share with guests as Sync and as collaborators'","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 \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\",\r\n \"ObjectIdentifier\": \"d4f89a8d045e8ee4\",\r\n \"ObjectType\": \"Playlist\",\r\n\r\n \"Users\": [\r\n {\r\n \"Username\": \"\",\r\n \"Type\": \"GuestMemberAccount\",\r\n \"ShareType\": \"Sync\",\r\n \"AllowDownload\": false,\r\n \"AllowFollow\": false,\r\n \"AllowSave\": false,\r\n \"AllowShare\": false,\r\n \"AllowCollaboration\": true,\r\n \"AllowEdit\": true\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Aug 2024 14:50: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 \"ShareMusic\": [\n {\n \"Username\": \"guest\",\n \"Status\": \"Success\",\n \"Url\": \"http://search.kongamusic.com/engage-playlist/c02dd4c6e2a13761471302c8be3a0efb\"\n }\n ]\n}"},{"id":"c54af909-3f49-4b1f-a69b-a96b05bddeeb","name":"Error code when member does not exist and you have to use GuestMemberAccount","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 \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\",\r\n \"ObjectIdentifier\": \"d4f89a8d045e8ee4\",\r\n \"ObjectType\": \"Playlist\",\r\n\r\n \"Users\": [\r\n {\r\n \"Username\": \"francesco+kongaliveeee@harvestmedia.net\",\r\n \"Type\": \"MemberAccount\",\r\n \"ShareType\": \"Copy\",\r\n \"AllowDownload\": false,\r\n \"AllowFollow\": false,\r\n \"AllowSave\": false,\r\n \"AllowShare\": false,\r\n \"AllowCollaboration\": false,\r\n \"AllowEdit\": false\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Aug 2024 14:18:46 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 \"ShareMusic\": [\n {\n \"Username\": \"francesco+kongaliveeee@harvestmedia.net\",\n \"Status\": \"Failed\",\n \"Url\": \"\",\n \"Error\": {\n \"Code\": \"11\",\n \"Description\": \"No member exists with this username\"\n }\n }\n ]\n}"}],"_postman_id":"b2f1166d-dad0-4c30-ae03-8ba2e137e07b"},{"name":"Get Playlist Category Share URL","id":"19691e28-4426-401e-bd89-2d47ea8d7c5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}","description":"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.
\nGet a Member Token for the Sender (see
\n\n)
\nGet a Member Token for the Recipient (see
\n\n)
\nOnce a share URL is obtained it is possible to send the URL to an email address;
\nSend a Share Email (see
\n\n)
\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":"5e650c60-5539-4d86-882e-58fa68b92368","name":"Send Share Music Email (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\"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":"fc1d0250-5719-434a-aa84-a18e91ced754","name":"Send Share Music Email (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":"OK\nStep 1: Get a Share URL
\n{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}
{ \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\", \"ObjectIdentifier\": \"2b1a4d9911916190\", \"ObjectType\": \"Playlist\", \"Users\": [ { \"Username\": \"\", \"Type\": \"GuestMemberAccount\", \"ShareType\": \"Sync\", \"AllowDownload\": true, \"AllowFollow\": true, \"AllowSave\": true, \"AllowShare\": true, \"AllowCollaboration\": false, \"AllowEdit\": false } ] }
Step 2: Convert long to short URL
\n{{HM_ServiceAPI_URL}}/getshorturl/{{HM_ServiceAPI_Token}}
{ \"URL\":\"{share url}\" }
PLAYLIST COLLABORATION
\nSome combinations of ShareType, AllowEdit and AllowCollaboration will not work.
\nShareType = Sync for collaboration
AllowCollaboration = true + AllowEdit = false = Read-Only collaborator
AllowCollaboration = true + AllowEdit = true = Editable collaborator
Owners
\nFull use
\nRecipients
\nBlocked entirely
\n","urlObject":{"path":["deliversharemusic","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"70bda03a-2c2b-4e2b-a80d-9c48dacaa35a"}],"id":"2ba491f1-4c17-491f-a905-301b2f38640b","description":"{{HM_ServiceAPI_URL}}/validateusername/{{HM_ServiceAPI_Token}}
{ \"Username\":\"peter@harvestthe.net\", \"VerifyEmail\": false }
This response indicates that there is no user with this email address:
\n{ \"Code\": \"OK\" }
This response indicates that there is a user with this email address:
\n{ \"Error\": { \"Code\": \"17\", \"Description\": \"Username already exists (Account is active)\" } }
It is possible to receive other responses where the username exists. Like this:
\n{ \"Error\": { \"Code\": \"17\", \"Description\": \"Username already exists (Account is denied)\" } }
The Code value here is the same in both cases. You can search for the existence of “active” in the Description to determine if it’s valid. If “active” cannot be found then the user should be treated as if the user does not exist.
\nThis should only be performed on emails that received this response during step 1:
\n{ \"Error\": { \"Code\": \"17\", \"Description\": \"Username already exists (Account is active)\" } }
{{HM_ServiceAPI_URL}}/deliversharemusic/{{HM_ServiceAPI_MemberToken}}
{ \"ObjectIdentifier\": \"2b1a4d9911916190\", \"ObjectType\": \"Playlist\", \"Users\": [ { \"Username\": \"{username entered}\", \"ShareType\": \"Sync\", \"AllowEdit\": {true = user selected editor role, false = user selected listener role}, \"AllowCollaboration\": true, \"NotifyUser\": true, \"Message\": \"{custom message to add to the users email if one is needed}\" } ] }
For these members, the process now ends.
\nThis should be performed on emails that the received the following response in step 1:
\n{ \"Code\": \"OK\" }
or
\n{ \"Error\": { \"Code\": \"17\", \"Description\": \"{where the description does not contain the word \"active\"\" } }
Get a Share Collab Url. We only generate this once as the resultant URL will be used for all email addresses that landed in this flow:
\n{{HM_ServiceAPI_URL}}/getsharemusicurl/{{HM_ServiceAPI_Token}}
{ \"FromMemberToken\": \"{{HM_ServiceAPI_MemberToken}}\", \"ObjectIdentifier\": \"2b1a4d9911916190\", \"ObjectType\": \"Playlist\", \"Users\": [ { \"Username\": \"\", \"Type\": \"GuestMemberAccount\", \"ShareType\": \"Sync\", \"AllowDownload\": true, \"AllowFollow\": true, \"AllowSave\": true, \"AllowShare\": true, \"AllowCollaboration\": true, \"AllowEdit\": {true = user selected editor role, false = user selected listener role} } ] }
Convert long to short URL. Again, only doing this once
\n{{HM_ServiceAPI_URL}}/getshorturl/{{HM_ServiceAPI_Token}}
{ \"URL\":\"{share url}\" }
Now we have our URL, for each email address we need to send this URL to them:
\n{{HM_ServiceAPI_URL}}/sendsharemusiclinkemail/{{HM_ServiceAPI_MemberToken}}
{ \"FromEmail\":\"{logged in users email address}\", \"ToEmail\":\"{users entered email address}\", \"Message\":\"{custom message to add to the users email if one is needed}\", \"Link\":\"{share url}\", \"ContentType\":\"Playlist\", \"ContentTitle\":\"{name of the playlist}\", \"SelectEmailTemplateByMemberRegion\":false }
Step 1: Loading the left panel
\nWhen loading the left panel of the playlists and folders there are some new properties to understand.
\n{{HM_ServiceAPI_URL}}/getmemberplaylistcategoriesandplaylists/{{HM_ServiceAPI_MemberToken}}?returnplaylistcount=true&returntrackcount=true&returnrootobjectsonly=true&returnautosaveonly=false&returnfirstautosave=false&returnhighlightonly=false&returnplaylistcollaboratingcount=true&playlistcategoryid=&skip=0&limit=10&sort=Custom_Asc
In the response you will see
\n \"IsEditable\": true, \"IsCollaboration\": true, \"HasCollaborator\": true, \"CollaboratingDate\": \"7/1/2024 8:22:37 AM\", \"IsOwner\": false, \"IsPublishable\": false, \"HasPublishMember\": false, \"LasPublishDate\": \"\"
If IsCollaboration = true then the playlist is a collaboration. You can use this to show the collab icon in the left panel
If IsOwner = true then this user owns this playlist and so has full access to the playlist. If false then this is a recipient.
If IsOwner = true then IsEditable will always be true
If IsEditable = true then this member has editor rights. If false then this is a listener user
PLAYLIST COLLABORATION
\nAllows for paging using skip and limit query parameters
Allows for sorting using sort query parameter;
Created_Asc
\nCreated_Desc
\nLastUpdated_Asc
\nLastUpdated_Desc
\nUsername_Asc
\nUsername_Desc
\nOwners
\nCan be used to retrieve all shares for a specific playlist. This will allow owners to see all the times they shared as copy or sync, delivery or share etc. It is also how they can see collaborators regardless of ACTIVE or PENDING status
\nRecipients
\nCan be used to retrieve all collaboration ACTIVE shares for a specific playlist. This is how a user can see the list of recipients who have accepted collaboration
\nRequest Elements
\nRequest Notes: ObjectType
\nTwo possible values; Playlist and PlaylistCategory.
If not provided, will default to Playlist.
Request Notes: DeliveryType
\nTwo possible values; Share and Deliver.
If not provided, will default to returning all shares irrespective of delivery type.
\nShares of type Share occur from the Get Playlist Share Url endpoint.
Shares of type Deliver occur from the Delivery Share Music endpoint.
Request Notes: ShareType
\nTwo possible values; Sync and Copy.
If not provided, will default to returning all shares irrespective of share type.
\nRequest Notes: SharedTo
\nTwo possible values; GuestMemberAccount and MemberAccount.
If not provided, will default to returning all shares irrespective of the shared to value.
\nRequest Notes: ShareStatus
\nFour possible values; Active, Withdrawn, Deleted and Ended.
If not provided, will default to returning all shares irrespective of the share status.
\nShares can fall into each status in the following way;
\nActive: Occurs when the share has been created and is open for use
\nWithdrawn: Occurs when the owner of the share has removed the share
\nEnded: Occurs when the recipient of the share has left the share
\nDeleted: Occurs when the recipient of the share has left and the owner has since removed the share. This is a combination of the Withdrawn and Ended states.
\nRequest Notes: IsCollaboration
\nTwo possible values; true, or false.
If not provided, will default to returning all shares irrespective of being a collaboration or not.
\nIf set to true, then only collaborative shares will be returned.
Request Notes: IsCollaborating
\nTwo possible values; true, or false.
If not provided, will default to returning all shares irrespective of being an active collaboration or not.
\nIf set to true, then only collaborative shares that have been accepted and are actively being collaborated against will be returned.
Request Notes: IsEditor
\nTwo possible values; true, or false.
If not provided, will default to returning all shares irrespective of being an active editor in a collaboration or not.
\nIf set to true, then only collaborative shares that have been accepted and are actively being collaborated against, where the recipient is an editor, will be returned.
PLAYLIST COLLABORATION
\nOwners
\nUse AllowEdit true/false to move a member between Read-Only and Editable permissions.
AllowPublish not enabled here, but could be in the future.
All other AllowXYZ properties here should just be set to true for now. They are purely informational and do not actually do anything significant yet.
Recipients
\nBlocked from use
\n","urlObject":{"path":["updatememberplaylistshare","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberPlaylistShareID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"970f9475-804b-458e-b4b9-779217ac8122"},{"name":"Remove Member Playlist Share","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","id":"d45bf378-7533-454a-8ec7-50d09bc11739"}}],"id":"b160825c-6df8-484e-9da6-f4d17c010b78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removememberplaylistshare/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_MemberPlaylistShareID}}?giveShareCopy={giveShareCopy}","description":"PLAYLIST COLLABORATION
\nThe recipient can remove themselves from the share if they like. But cannot remove anyone else.
\nOwner can remove anyone.
\nDuring removal - giveShareCopy determines if the user being removed/leaving receives a standalone copy or not
\nOwners
\nFull use
\nRecipients
\nBlocked from use
\n","urlObject":{"path":["removememberplaylistshare","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_MemberPlaylistShareID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"giveShareCopy","value":"{giveShareCopy}"}],"variable":[]}},"response":[],"_postman_id":"b160825c-6df8-484e-9da6-f4d17c010b78"}],"id":"f70c091c-116a-4c3a-a5ce-87991a5dbbe6","description":"Step 1: Get collaborators
\n{{HM_ServiceAPI_URL}}/getmemberplaylistshares/{{HM_ServiceAPI_MemberToken}}/2b1a4d9911916190?skip=0&limit=20&sort=Alphabetic_Asc
Filter the response by AllowCollaboration = true to find collaborators. This is needed as the response will also include snapshot shares, which can be ignored here.
In the response AllowEdit ; when true it means the user is a editor role, when false it means the user is a listener role.
In the response SharedToCollaborating; when true means this user accepted. If false, the it means its pending. However, it is best to not show anything pending.
Step 2: Changing a collaborators permissions
\nThis is for shares that are SharedToCollaborating = true.
{{HM_ServiceAPI_URL}}/updatememberplaylistshare/{{HM_ServiceAPI_MemberToken}}/{PlaylistShareID}
{ \"AllowDownload\": true, \"AllowSave\": true, \"AllowFollow\": true, \"AllowShare\": true, \"AllowEdit\": {true = user selected editor role, false = user selected listener role} }
Step 3: Remove a collaborator
\nThis is for shares that are SharedToCollaborating = true.
{{HM_ServiceAPI_URL}}/removememberplaylistshare/{{HM_ServiceAPI_MemberToken}}/{PlaylistShareID}?giveShareCopy={giveShareCopy}
If giveShareCopy = true then the collaborator will receive a snapshot copy of this playlist in their account.
PLEASE NOTE: this call is in the Left Panel of Member All Playlists Page, under Playlist folder, you just need to add the below flag of giveShareCopy
Step 1: Delete the playlist
\n{{HM_ServiceAPI_URL}}/removeplaylist/{{HM_ServiceAPI_MemberToken}}/{PlaylistID}?giveShareCopy={giveShareCopy}
If giveShareCopy = true then all collaborators will receive a snapshot copy of this playlist in their account.
Step 1: Delete a folder that contains collaboration playlists
\nThe call to getmemberplaylistcategoriesandplaylists is used to load the list of folders and playlists.
In the request URL you will see a property for &returnplaylistcollaboratingcount={true/false}.
When true, this will return whether there are any collaboration playlists inside the folder (PlaylistCollaborationCount). You can use this to know whether to show the confirmation notice to the user or not.
Then when deleting the folder you do it like so:
\n{{HM_ServiceAPI_URL}}/removememberplaylistcategory/{{HM_ServiceAPI_MemberToken}}/{PlaylistCategoryID}?keepChildren={keepChildren}&giveShareCopy={giveShareCopy}
You like to provide the user with a few options here. So a modal that has options for;
\nDelete folder, keep playlists
\nDelete folder, delete playlists
\nDelete folder, delete playlists and give collaborators a copy
\nIf {keepChildren} is true then {giveShareCopy} is ignored
If {keepChildren} is false then {giveShareCopy} comes into play.
If giveShareCopy = true then all collaborators will receive a snapshot copy of this playlist in their account.
Step 1: Load the share
\n{{HM_ServiceAPI_URL}}/getmemberplaylistshares/{{HM_ServiceAPI_MemberToken}}/{PlaylistID}?skip=0&limit=1&sort=
For recipients this will return only a single record.
\nStep 2: Leave the share
\n{{HM_ServiceAPI_URL}}/removememberplaylistshare/{{HM_ServiceAPI_MemberToken}}/{PlaylistShareID}?giveShareCopy={giveShareCopy}
If giveShareCopy = true then this member will receive a snapshot copy of this playlist in their account.
PLAYLIST COLLABORATION
\nNew properties in the response:
\nIsEdittable
\nIsCollaboration
\nHasCollaborators
\nCollaboratingDate
\nIsOwner
\nIsPublishable
\nHasPublishMembers
\nLastPublishDate
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["getmemberplaylist","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_NewMemberPlaylistID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"ReturnTracks","value":"false"}],"variable":[]}},"response":[],"_postman_id":"6ca6c609-5d53-4ecb-81fa-40a1d2d86332"},{"name":"Get Playlist Tracks","event":[{"listen":"test","script":{"id":"1f83557b-547c-4da9-b2f9-438748a31739","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"66ac74ec-10d5-4ff5-ac63-507aa562e1c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Keyword\": \"%\",\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}}/searchmemberplaylisttracks/{{HM_ServiceAPI_MemberToken}}/{PlaylistID}","urlObject":{"path":["searchmemberplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"66ac74ec-10d5-4ff5-ac63-507aa562e1c1"},{"name":"Search Playlist Tracks","event":[{"listen":"test","script":{"id":"1f83557b-547c-4da9-b2f9-438748a31739","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"cb009b7d-cdbe-45bb-af8d-5babc3eb3a80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"Keyword\": \"pop\",\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}}/searchmemberplaylisttracks/{{HM_ServiceAPI_MemberToken}}/{PlaylistID}","description":"PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nFull use
\n","urlObject":{"path":["searchmemberplaylisttracks","{{HM_ServiceAPI_MemberToken}}","{PlaylistID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb009b7d-cdbe-45bb-af8d-5babc3eb3a80"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"d42b6b01-79fb-4f8b-b258-d0fa3f700986","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d42b6b01-79fb-4f8b-b258-d0fa3f700986"},{"name":"Reorder Tracks - Same Playlist","event":[{"listen":"test","script":{"id":"df687bd8-5e6e-42a4-b5dd-f9d706ce78bc","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"de355eb7-b4f0-4eb5-8923-7439acaeee4a","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"FromPlaylistID\": \"{PlaylistID-A}\",\r\n \"ToPlaylistID\": \"{PlaylistID-A}\",\r\n \"TrackIDs\": \"{TrackID}\",\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}}","description":"PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nOnly for allowEdit collaborators
PLAYLIST COLLABORATION
\nOwners
\nFull use
\nRecipients
\nOnly for allowEdit collaborators
This endpoint provides a means of obtaining recommended tracks from a Playlists existing tracks. It provides an array of suggested tracks similar to the Member's Playlist.
\nTracks that in the current Member Playlist will never be shown as a suggestion, even if the track was not provided as a seed for suggestions.
\nRequest Notes:
\nSeedLimit - defines the number of seed tracks to be used for obtaining similar tracks. The maximum value here varies depending on AI Provider:
AIMS: 10
\nCyanite: 100
\nHarmix: 100
\nSeedMin - defines the minimum number of seeds that must exist on the Member Playlist to be allowed to obtain suggestions
SeedDetermination - defines how seeds are chosen from the current list of tracks on the Member Playlist. They can be chosen by; Random or Created_Asc or Created_Desc.
Skip/Limit - defines the paged array to return.
Limit is 90Request Example:
\nFor example, a SeedDetermination based on \"last 5 tracks\" added to the playlist
\nSeedLimit = 5
\nSeedMin = 1
\nSeedDetermination = Created_Desc
\nUsage suggestions
\nWe would recommend integrating this in the following way:
\nAim to show < 30 suggestions, 5-10 is a good measured number. However, we would suggest fetching more than is needed for a single page. For example, you might want to only show 5 similar suggestions - but we would suggest fetching 30, not 5 from the API. This will allow you to flip a track for a new suggestion without having to return to the API.
\nActions that benefit from this approach (assuming showing 5 suggestions):
\nUser adds one of the suggestions to their Member Playlist.
\nUser clicks refresh button on the suggestions
\nUser clicks ignore suggestion
\nSo you can see here how pre-fetching more than you need allows faster replacement of tracks. This is useful as obtaining suggestions by the API can be slow.
\nThere are however cases where you may like to refresh the list of suggestions entirely. This might need to be done when the seeds of the member playlist could change:
\nUsers adds a new track(s) to the member playlist
\nUser removes a track(s) from the member playlist
\nAllows 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":[],"_postman_id":"58e26c23-88d8-47b7-a88e-dacbe7c73046"},{"name":"Update Saved Search","event":[{"listen":"test","script":{"id":"6ea4a0b7-545c-40ab-9c4d-2ff9dac9f36c","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","// var jsonData = null;","// var jsonDataPlaylistID = \"\";","","// if (responseBody.indexOf(\"= 0) {","// jsonData = xml2Json(responseBody);","// jsonDataPlaylistID = jsonData.responseplaylists.playlists.playlist.$.id;","// } else {","// jsonData = JSON.parse(responseBody)","// if (jsonData.Playlists.length > 0) {","// jsonDataPlaylistID = jsonData.Playlists[0].ID;","// }","// }","","// console.log(\"HM_ServiceAPI_NewMemberPlaylistID set to \" + jsonDataPlaylistID);","","// postman.setEnvironmentVariable(\"HM_ServiceAPI_NewMemberPlaylistID\", jsonDataPlaylistID);","","// postman.setNextRequest(\"Update Member Playlist (MT)\");"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"58bd671b-ea61-4298-b207-55b09d4893f6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9a7439cd-36c1-4942-a22c-1024c26f61cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 Description - Updated\",\r\n \"SearchHistoryID\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemembersavesearch/{{HM_ServiceAPI_MemberToken}}/{SearchHistoryID}","description":"Allows updating of the details for a saved search.
\nRequest Elements
\nRequest Notes
\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":[],"_postman_id":"9a7439cd-36c1-4942-a22c-1024c26f61cb"},{"name":"Remove Saved Search Term","event":[{"listen":"test","script":{"id":"473037d1-f735-4000-a05b-c921adacf754","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Create Member Playlist\");"],"type":"text/javascript","packages":{}}}],"id":"8becc900-b2a8-4014-b02a-c5393101e223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removemembersavedsearchterm/{{HM_ServiceAPI_MemberToken}}/{SearchHistoryID}/{SearchTermID}","description":"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
\nRemoves a single member saved search.
\nRequest elements
\nRequest Notes:
\nSearchHistoryID is the ID of the saved search to be removed.
Removes all saved member searches.
\nRequest elements
\n","urlObject":{"path":["removeallmembersavedsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d5cce9e-a01d-4c76-b63b-72519e671b73"}],"id":"28b13a98-3072-4f67-bf81-aadd8435b257","_postman_id":"28b13a98-3072-4f67-bf81-aadd8435b257","description":""},{"name":"Member All Tags Page","item":[{"name":"Left Panel","item":[{"name":"Create Tag","event":[{"listen":"test","script":{"id":"3a118696-884b-4452-9dda-dac4a7b5e856","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"7e58cf4e-3574-49bb-bc99-8835eed7b0da","exec":[""],"type":"text/javascript"}}],"id":"ab4130f5-50cf-4286-8355-5326789bacc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"TagName\": \"{{HM_ServiceAPI_TagName}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addmembertag/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["addmembertag","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab4130f5-50cf-4286-8355-5326789bacc4"},{"name":"Update Tag","event":[{"listen":"test","script":{"id":"3a118696-884b-4452-9dda-dac4a7b5e856","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"7e58cf4e-3574-49bb-bc99-8835eed7b0da","exec":[""],"type":"text/javascript"}}],"id":"bbef6a0a-8c5f-4fa4-89be-8b70b5243ac7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"TagName\": \"{{HM_ServiceAPI_TagName}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemembertag/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["updatemembertag","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbef6a0a-8c5f-4fa4-89be-8b70b5243ac7"},{"name":"Get Tags","event":[{"listen":"test","script":{"id":"158ef00d-845e-4750-acd3-447a671aa0e8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"f9cb6382-4f34-4b8e-97af-b99b0c062842","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getmembertags/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=10&Sort=Alphabetic_Asc","urlObject":{"path":["getmembertags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"10"},{"key":"Sort","value":"Alphabetic_Asc"}],"variable":[]}},"response":[],"_postman_id":"f9cb6382-4f34-4b8e-97af-b99b0c062842"},{"name":"Delete Tag","event":[{"listen":"test","script":{"id":"a8392543-c7bc-4183-8500-7b7e5b9ec908","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"2c9e7592-0954-4b49-a8b1-6c0a59255468","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removemembertag/{{HM_ServiceAPI_MemberToken}}/{TagID}","urlObject":{"path":["removemembertag","{{HM_ServiceAPI_MemberToken}}","{TagID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c9e7592-0954-4b49-a8b1-6c0a59255468"},{"name":"Delete All Tags","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Add Track/Album to Member Favourites\");"],"type":"text/javascript","id":"e2b80e8a-54a5-459e-a69a-611f5a51b292"}}],"id":"89cf1fd9-f03c-42b9-ad65-ea0174d51332","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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}}","description":"Allows 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":[],"_postman_id":"89cf1fd9-f03c-42b9-ad65-ea0174d51332"}],"id":"5a10901d-077d-4320-9d81-8697c03f3882","_postman_id":"5a10901d-077d-4320-9d81-8697c03f3882","description":""},{"name":"Right Panel","item":[{"name":"Get Tracks By Tag","event":[{"listen":"test","script":{"id":"2a65cd6e-2fab-483f-9339-391bbfc8baa3","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"f66aabcf-ebe7-48c5-831f-3a74432a48c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"url":"{{HM_ServiceAPI_URL}}/getmembertagtracks/{{HM_ServiceAPI_MemberToken}}/{TagID}?Skip=0&Limit=10&Sort=Created_Asc","urlObject":{"path":["getmembertagtracks","{{HM_ServiceAPI_MemberToken}}","{TagID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"10"},{"key":"Sort","value":"Created_Asc"}],"variable":[]}},"response":[],"_postman_id":"f66aabcf-ebe7-48c5-831f-3a74432a48c2"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"700707be-8074-4b00-830a-efc80dc0b517","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"700707be-8074-4b00-830a-efc80dc0b517"},{"name":"Delete Track From Tag","event":[{"listen":"test","script":{"id":"7d171710-3f2e-4b84-ae19-b4c001c8304d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"bf0b041d-8c06-4ab4-91cf-d1ede475f3d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{HM_ServiceAPI_URL}}/removetrackmembertag/{{HM_ServiceAPI_MemberToken}}/{TagID}/{TrackID}","urlObject":{"path":["removetrackmembertag","{{HM_ServiceAPI_MemberToken}}","{TagID}","{TrackID}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf0b041d-8c06-4ab4-91cf-d1ede475f3d9"}],"id":"f0d5dee9-7335-4851-a8ab-e0fc469a580d","_postman_id":"f0d5dee9-7335-4851-a8ab-e0fc469a580d","description":""}],"id":"b269ee5c-395f-4cce-a7cf-1b0eede4d4c1","_postman_id":"b269ee5c-395f-4cce-a7cf-1b0eede4d4c1","description":""},{"name":"Member All Likes Page","item":[{"name":"Get Likes","event":[{"listen":"test","script":{"id":"af9857ff-71a8-4af4-bc85-13602b2a90d8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"95b46e38-4d18-4925-b60b-066e62a7c834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getfavourites/{{HM_ServiceAPI_MemberToken}}?Skip=0&Limit=10&Sort=Created_Desc","urlObject":{"path":["getfavourites","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"Skip","value":"0"},{"key":"Limit","value":"10"},{"key":"Sort","value":"Created_Desc"}],"variable":[]}},"response":[],"_postman_id":"95b46e38-4d18-4925-b60b-066e62a7c834"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"a2f9d81e-71bd-4097-a924-2d126b8db3b2","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2f9d81e-71bd-4097-a924-2d126b8db3b2"},{"name":"Remove Track from Likes","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Remove All Tracks from Member Favourites\");"],"type":"text/javascript","id":"0556a025-e627-4a25-827a-e57a1c5bfcec"}}],"id":"e792e13e-73f9-4a2b-b370-1f959a8c4c76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removefavouritestrack/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_TrackID}}","description":"Allows the removal of a track from a member favourites.
\nRequest Elements
\n","urlObject":{"path":["removefavouritestrack","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_TrackID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e792e13e-73f9-4a2b-b370-1f959a8c4c76"},{"name":"Remove All Tracks from LIkes","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Create & Assign Member Comment to Track\");"],"type":"text/javascript","id":"f62eb71c-c18f-46ae-bd15-478965fb69b2"}}],"id":"a2d35779-6ec8-4b66-aa1d-48a6709a8c2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/removeallfavouritestracks/{{HM_ServiceAPI_MemberToken}}","description":"Allows 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":[],"_postman_id":"a2d35779-6ec8-4b66-aa1d-48a6709a8c2f"}],"id":"7dfeda2b-0ccb-4238-8aa4-a4aa9d502e4c","_postman_id":"7dfeda2b-0ccb-4238-8aa4-a4aa9d502e4c","description":""},{"name":"Search Page","item":[{"name":"Core Search","item":[{"name":"Get Search Default","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"82d2cf4a-ef91-4919-94c5-60145ee33535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ReturnCSUrl\": \"true\",\r\n \"SaveSearchHistory\": \"false\",\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 \"LibraryType\": null,\r\n \"HasStems\": null,\r\n \"HasLyrics\": \"false\",\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"ST_StyleGroup\": {\r\n \"StyleGroups\": \"a1d25ce03a3225c8,0d694892092ca56b,be0c2de9cc016d87\",\r\n \"Negative\": \"false\",\r\n \"OrOperation\": \"true\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Style\",\r\n \"Sort_Predefined\": \"\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"100\",\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}}","description":"NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nWhen \"Facet_Category\" is set to true, it will return ONLY those categories that are still applicable to the users search.
\nWe only return those categories that have count > 0 of tracks in the result set. So if a parent has a child category that is count > 0 it will be included BUT if the parent itself is not count > 0 then it will not be included in the response. In other words, we do not provide the full tree - only those that are applicable to the search result.
\nTo implement this in the UI, Flex will need to loop over the categories panel and hide anything that is not included in the Facet response array.
\nThe response does not present categories in a nested fashion, it will give you a flat array, so this may require some additional logic on the flex side.
\nNote - calling this only when required is important, as it does have some additional load time when included. So please do not include this in every call - like on the collection pages etc. Only include this on a cloudsearch request that will show the categories panel on screen.
\nNote II - This response does return the count of results as well which is something you may want to implement.
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2f2bd90f-c35c-4719-96cb-bca779419549","name":"Get Search Filtered By Category with Tracks only","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 \"ReturnCSUrl\": true,\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 \"LibraryType\": null,\r\n \"HasStems\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Category\": {\r\n \"IDs\": \"ATT_0d122ffdef92b624yh\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Track\",\r\n \"Sort_Predefined\": \"RankExpression\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"10\",\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\": \"true\",\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":"Date","value":"Wed, 23 Oct 2024 22:06:24 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 \"Facets\": {\n \"Categories\": {\n \"Items\": [\n {\n \"ID\": \"2ad766c014cc92ac\",\n \"ParentID\": \"5044ae38e8d1828c\",\n \"Name\": \"Animation\",\n \"Count\": 1\n },\n {\n \"ID\": \"76a6f23ba2988333\",\n \"ParentID\": \"576f346b35a49883\",\n \"Name\": \"Bold\",\n \"Count\": 1\n },\n {\n \"ID\": \"c708cb1177f17d3c\",\n \"ParentID\": \"c5aa3c4494e1ea09\",\n \"Name\": \"Brass\",\n \"Count\": 1\n },\n {\n \"ID\": \"55787588714783cc\",\n \"ParentID\": \"c5aa3c4494e1ea09\",\n \"Name\": \"Electric Guitar\",\n \"Count\": 1\n },\n {\n \"ID\": \"68eebb32935e5bf4\",\n \"ParentID\": \"576f346b35a49883\",\n \"Name\": \"Emotional\",\n \"Count\": 1\n },\n {\n \"ID\": \"3d18bd1d2e82325d\",\n \"ParentID\": \"576f346b35a49883\",\n \"Name\": \"Energetic\",\n \"Count\": 1\n },\n {\n \"ID\": \"cf5eaa99cc761c2d\",\n \"ParentID\": \"576f346b35a49883\",\n \"Name\": \"Exciting\",\n \"Count\": 1\n },\n {\n \"ID\": \"fa066fe67a228e76\",\n \"ParentID\": \"c5aa3c4494e1ea09\",\n \"Name\": \"Guitar\",\n \"Count\": 1\n },\n {\n \"ID\": \"fe855b0a64a32fac\",\n \"ParentID\": \"3b432c935e53283e\",\n \"Name\": \"Hard Rock - Metal\",\n \"Count\": 1\n },\n {\n \"ID\": \"02ee71c9fe6957b1\",\n \"ParentID\": \"576f346b35a49883\",\n \"Name\": \"Hopeful\",\n \"Count\": 1\n },\n {\n \"ID\": \"b7be98352741b52e\",\n \"ParentID\": \"c5aa3c4494e1ea09\",\n \"Name\": \"Orchestra\",\n \"Count\": 1\n },\n {\n \"ID\": \"bf473a9ae80d406f\",\n \"ParentID\": \"3b432c935e53283e\",\n \"Name\": \"Rock\",\n \"Count\": 1\n },\n {\n \"ID\": \"64761b0db57e6bf6\",\n \"ParentID\": \"c5aa3c4494e1ea09\",\n \"Name\": \"Strings\",\n \"Count\": 1\n },\n {\n \"ID\": \"53e68f10fa608106\",\n \"ParentID\": \"c5aa3c4494e1ea09\",\n \"Name\": \"Vocals\",\n \"Count\": 1\n }\n ]\n }\n }\n}"}],"_postman_id":"a3aa1a2b-8a88-4578-aa59-476f793f4166"},{"name":"Get Search Filtered By BPM","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"22dcd3d8-c3e8-429b-b092-7b2b8f52b516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\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 \"LibraryType\": null,\r\n \"HasStems\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_BPM\": {\r\n \"Start\": \"30\",\r\n \"End\": \"120\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Track\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"10\",\r\n \"Facet_Library\": \"true\",\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\": \"true\",\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\": \"true\",\r\n \"Facet_Duration\": \"true\",\r\n \"Facet_ReleaseYear\": \"false\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","description":"NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nAdd \"KeywordLanguage\" to the request with the languageISO 639-1 two-letter code that the keyword will be translated to.
\nExample, if the input is a portuguese word \"amor\" (love, in English), then the request keyword should be \"amor\" and the KeywordLanguage: PT.
\nThe ISO 639-1 two-letter language code uses a pattern of two lowercase letters (xx) to represent a language. Here are some common examples:
NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nAdd \"KeywordLanguage\" to the request with the languageISO 639-1 two-letter code that the keyword will be translated to.
\nExample, if the input is a spanish word \"corazón\" (heart, in English), then the request keyword should be \"corazón\" and the KeywordLanguage: ES.
\nThe ISO 639-1 two-letter language code uses a pattern of two lowercase letters (xx) to represent a language. Here are some common examples:
NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Can only be called after at least one search term has been entered
\n","urlObject":{"path":["autocomplete","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"33476e11-9c11-433f-9867-81c7acac7b67"},{"name":"Get Suggested Keywords Multi-Filtered","event":[{"listen":"test","script":{"id":"c12db662-d47c-40b9-b5d1-bf3b571d9233","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"8c06c8c8-5ca5-4647-812c-19628c04f100","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"keyword\": \"\",\r\n \"wildcard\": true,\r\n \"ReturnKeywords\": true,\r\n \"ReturnKeywordsMaxSize\": 100,\r\n \"ReturnKeywordsForMatch\": true,\r\n \"ReturnKeywordsForMatch_Fields\": \"TrackKeywords\",\r\n \"ReturnKeywordsForMatch_HideWhenSearchTerm\": true,\r\n \"ReturnKeywordsDisableKeywordGroup\": false,\r\n \"searchFilters\": {\r\n \"SearchType\": \"Normal\",\r\n \"MainOnly\": \"true\",\r\n \"IncludeInactive\": \"false\",\r\n \"AlternateOnly\": \"false\",\r\n \"FeaturedLibrariesOnly\": null,\r\n \"HasStems\": null,\r\n \"previousSearchTermBundles\": [\r\n {\r\n \"st_keyword_aggregated\": {\r\n \"exactPhrase\": false,\r\n \"negative\": false,\r\n \"wildcard\": true,\r\n \"disableKeywordGroup\": false,\r\n \"orOperation\": false,\r\n \"keywords\": \"pop\"\r\n }\r\n },\r\n {\r\n \"st_keyword_aggregated\": {\r\n \"exactPhrase\": false,\r\n \"negative\": false,\r\n \"wildcard\": true,\r\n \"disableKeywordGroup\": false,\r\n \"orOperation\": false,\r\n \"keywords\": \"rock\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/autocomplete/{{HM_ServiceAPI_MemberToken}}","description":"NOTE: Can only be called after at least one search term has been entered
\n","urlObject":{"path":["autocomplete","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c06c8c8-5ca5-4647-812c-19628c04f100"}],"id":"28f2b7e7-1d4e-491f-8163-e6a5912c2a42","_postman_id":"28f2b7e7-1d4e-491f-8163-e6a5912c2a42","description":""},{"name":"Predictive Search","item":[{"name":"Get Predictive Search","event":[{"listen":"test","script":{"id":"c12db662-d47c-40b9-b5d1-bf3b571d9233","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"e3d29719-5fcf-4de0-8136-9a94ed2ff617","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"Keyword\": \"KBL0006_01 I ADORE YOU\",\r\n\t\"Wildcard\": true,\r\n\t\"ReturnTracks\": true,\r\n\t\"ReturnTracks_MainOnly\": true,\r\n\t\"ReturnTracks_Fields\": \"DisplayTitle,alternatetitle\",\r\n\t\"ReturnTracks_Limit\": 1,\r\n\t\"ReturnTracks_Order\": \"Date_Descent\",\r\n\t\"ReturnTracks_DisableKeywordGroup\": true,\r\n\t\"ReturnTracks_Rank\": \"\",\r\n\t\"ReturnAlbums\": true,\r\n\t\"ReturnAlbums_Fields\": \"CdCode,DisplayTitle,Description,Keywords\",\r\n\t\"ReturnAlbums_Limit\": 1,\r\n\t\"ReturnAlbums_Order\": \"Date_Descent\",\r\n\t\"ReturnAlbums_DisableKeywordGroup\": true,\r\n\t\"ReturnLyrics\": true,\r\n\t\"ReturnLyrics_Limit\": 1,\r\n\t\"ReturnLyrics_MainOnly\": false,\r\n\t\"ReturnLyrics_DisableKeywordGroup\": true,\r\n\t\"ReturnFeaturedPlaylists\": true,\r\n\t\"ReturnFeaturedPlaylist_Fields\": \"ProjectTitle\",\r\n\t\"ReturnFeaturedPlaylists_Limit\": 1,\r\n\t\"ReturnFeaturedPlaylist_Order\": \"Alphabetic_Ascent\",\r\n\t\"ReturnFeaturedPlaylists_DisableKeywordGroup\": true,\r\n \"ReturnLibraries\": false,\r\n \"ReturnStyles\": false,\r\n \"ReturnCategoryAttributes\": false,\r\n \"ReturnRightHolders\": false,\r\n \"ReturnKeywords\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/autocomplete/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["autocomplete","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3d29719-5fcf-4de0-8136-9a94ed2ff617"},{"name":"All Lyric Results","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"f66db480-cc9b-4570-8d1b-f6e86e8efaa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Keyword\": {\r\n \t\"Fields\": \"TrackLyrics\",\r\n \"ExactPhrase\": \"false\",\r\n \"Wildcard\": \"true\",\r\n \"DisableKeywordGroup\": \"false\",\r\n \"OrOperation\": \"false\",\r\n \"Keywords\": \"happy\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Track\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"10\",\r\n \"Facet_Library\": \"true\",\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\": \"true\",\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\": \"true\",\r\n \"Facet_Duration\": \"true\",\r\n \"Facet_ReleaseYear\": \"false\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","description":"NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nSearching 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":"7b4154f0-103c-4a33-9b95-16d101737824"},{"name":"By MP3","item":[{"name":"Get Upload URL","event":[{"listen":"test","script":{"id":"66c5df76-9791-4d85-8847-b9c90886d35b","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"60405fee-dafc-42e3-a6e6-f690420c4344","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"AssetType\": \"AudioExtract\",\r\n \"FileName\": \"test.mp3\",\r\n \"ContentType\": \"audio/mpeg\",\r\n \"ExpiresInSeconds\": \"120\",\r\n \"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}","description":"The response will contain two URLs.
\nPresignedUploadUrl is the URL to upload the file to. This should be used when PUT the actual file.
ResourceUrl is the URL where the resultant file, once uploaded, will reside. This will be used in the /cloudsearch/ call at the end of the process once analysis has completed.
The response will appear like the following
\n{\n \"Code\": \"OK\"\n}\n\nReturns similar tracks based an uploaded MP3 file.
\nPlease note that the MP3 file needs to be uploaded prior to attempting to perform a search. Please refer to the implementation guide in order to do so.
\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":[],"_postman_id":"7b782bdf-aa1a-4e8c-ac59-704b26e49557"},{"name":"Get Similar Tracks (By Segment)","event":[{"listen":"test","script":{"id":"4d954a95-4b6e-4dae-a472-02e5c3d7d79d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Register Member\");"],"type":"text/javascript"}}],"id":"759f0001-a013-4835-b20b-f7c001f0e926","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"Url\": \"{ResourceUrl}}\",\r\n \"Type\": \"MP3\",\r\n \"Start\": \"22\",\r\n \"Duration\": \"52\"\r\n }\r\n ]\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\": \"10\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","description":"Returns similar tracks based an uploaded MP3 file.
\nPlease note that the MP3 file needs to be uploaded prior to attempting to perform a search. Please refer to the implementation guide in order to do so.
\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":[],"_postman_id":"759f0001-a013-4835-b20b-f7c001f0e926"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"9e11e0d2-2242-4287-9dac-6b731b163efd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e11e0d2-2242-4287-9dac-6b731b163efd"}],"id":"79038671-f539-42e8-a4bd-3132fc0d8507","description":"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\nPossible values for Type are;
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.
\n\nSearching by a prompt, allows you to provide a sentence or prompt to obtain similar tracks for.
\n\n","_postman_id":"e838d65e-bc22-46ba-8d1e-9dacac72a34b"}],"id":"bcda6b45-29a1-422e-bc89-acb150b262cb","_postman_id":"bcda6b45-29a1-422e-bc89-acb150b262cb","description":""},{"name":"CYANITE","item":[{"name":"By Track","item":[{"name":"Get Similar Tracks","event":[{"listen":"test","script":{"id":"1b0fddcd-a083-47c7-bab4-f63531d74b1d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"0b5920f9-4adb-463e-854f-aa082b564e02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","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\": \"{{HM_ServiceAPI_TrackID}}\"}],\r\n \"Start\": \"\",\r\n \"Duration\": \"\" \r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Limit\": \"10\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b5920f9-4adb-463e-854f-aa082b564e02"},{"name":"Get Similar Tracks (By Segment)","event":[{"listen":"test","script":{"id":"1b0fddcd-a083-47c7-bab4-f63531d74b1d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"afa5f0e9-164d-4a09-acff-301fe387a204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","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\": \"{{HM_ServiceAPI_TrackID}}\"}],\r\n \"Start\": \"22\",\r\n \"Duration\": \"52\" \r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Limit\": \"10\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"afa5f0e9-164d-4a09-acff-301fe387a204"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"f5427339-6398-4bdc-bb85-2d822b267591","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5427339-6398-4bdc-bb85-2d822b267591"}],"id":"2beb89aa-de96-4965-b96d-8a08dfabd83e","description":"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":"2beb89aa-de96-4965-b96d-8a08dfabd83e"},{"name":"By MP3","item":[{"name":"Get Upload URL","event":[{"listen":"test","script":{"id":"66c5df76-9791-4d85-8847-b9c90886d35b","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"d7c7405a-f1db-4d5b-9ad4-b1fee2a5617e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"AssetType\": \"AudioExtract\",\r\n \"FileName\": \"test.mp3\",\r\n \"ContentType\": \"audio/mpeg\",\r\n \"ExpiresInSeconds\": \"120\",\r\n \"ObjectId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getpresigneduploadurl/{{HM_ServiceAPI_MemberToken}}","description":"The response will contain two URLs.
\nPresignedUploadUrl is the URL to upload the file to. This should be used when PUT the actual file.
ResourceUrl is the URL where the resultant file, once uploaded, will reside. This will be used in the /cloudsearch/ call at the end of the process once analysis has completed.
The response will appear like the following
\n{\n \"Code\": \"OK\",\n \"Asset\": {\n \"ExternalID\": \"d683a1b8e6efab78c655ebfdf2e0a8b6\"\n }\n}\n\nThis ExternalID is important as it is to be used to poll the service to check the status of the external providers analysis.
This is the same endpoint as Spotify, however here you leave off the ExternalType altogether.
\nThe ExternalID is the ID that was received during /confirmpresignedupload/ resonse.
There are 3 possible responses;
\nOK response
\nWhen this response is received it means that the uploaded track has been analysed and the /cloudsearch/ request is ready to return results.
\n{\n \"Code\": \"OK\"\n}\n\nPending response
\nWhen this response is received it means that the uploaded track is pending analysis. This can take anywhere from 1-40 seconds depending on the external provider.
\nThis endpoint should be polled every 4 seconds to fetch the latest status update. Unfortunately there is no other way to retrieve this update.
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Pending\"\n }\n}\n\nError response
\nWhen this response is received it means that the uploaded track cannot be searched on. There are various reasons for this. The format will be \"Analysis Failed - {reason}\".
\nNo Spotify Previews allowed
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - It seems like this track does not have a preview on Spotify.\"\n }\n}\n\nErrored
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - Could not find library track.\"\n }\n}\n\nReturns similar tracks based an uploaded MP3 file.
\nPlease note that the MP3 file needs to be uploaded prior to attempting to perform a search. Please refer to the implementation guide in order to do so.
\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":[],"_postman_id":"3bff24b6-d714-4483-b5da-20d29b1b34d3"},{"name":"Get Similar Tracks (By Segment)","event":[{"listen":"test","script":{"id":"1b0fddcd-a083-47c7-bab4-f63531d74b1d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"ead76c94-2f84-4950-b7e7-619578392fae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","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 \"Url\": \"{ResourceUrl}\",\r\n \"Type\": \"MP3\",\r\n \"Start\": \"22\",\r\n \"Duration\": \"55\"\r\n }\r\n ]\r\n }\r\n },\r\n \"ResultView\": {\r\n \"Sort_Predefined\": \"EvokeRanking\",\r\n \"Limit\": \"10\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ead76c94-2f84-4950-b7e7-619578392fae"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"e9dcb0fa-9950-4e9c-8d1c-25046b0bc23d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9dcb0fa-9950-4e9c-8d1c-25046b0bc23d"}],"id":"57cc389d-16c0-42df-989f-f870820f9f22","description":"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\nThe ExternalID is the spotify track ID that appears in the URL that the users posts. This needs to be extracted from the users URL to be provided here.
There are 3 possible responses;
\nOK
\nPending
\nError
\nOK response
\nWhen this response is received it means that the Spotify track has been analysed and the /cloudsearch/ request is ready to return results.
\n{\n \"Code\": \"OK\"\n}\n\nPending response
\nWhen this response is received it means that the Spotify track is pending analysis. This can take anywhere from 1-40 seconds depending on the external provider.
\nThis endpoint should be polled every 4 seconds to fetch the latest status update. Unfortunately there is no other way to retrieve this update.
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Pending\"\n }\n}\n\nError response
\nWhen this response is received it means that the Spotify track cannot be searched on. There are various reasons for this. The format will be \"Analysis Failed - {reason}\".
\nNo Spotify Previews allowed
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - It seems like this track does not have a preview on Spotify.\"\n }\n}\n\nErrored
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - Could not find library track.\"\n }\n}\n\nThis endpoint only works with Spotify presently.
\nThe ExternalID is the spotify track ID that appears in the URL that the users posts. This needs to be extracted from the users URL to be provided here.
There are 3 possible responses;
\nOK response
\nWhen this response is received it means that the Spotify track has been analysed and the /cloudsearch/ request is ready to return results.
\n{\n \"Code\": \"OK\"\n}\n\nPending response
\nWhen this response is received it means that the Spotify track is pending analysis. This can take anywhere from 1-40 seconds depending on the external provider.
\nThis endpoint should be polled every 4 seconds to fetch the latest status update. Unfortunately there is no other way to retrieve this update.
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Pending\"\n }\n}\n\nError response
\nWhen this response is received it means that the Spotify track cannot be searched on. There are various reasons for this. The format will be \"Analysis Failed - {reason}\".
\nNo Spotify Previews allowed
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - It seems like this track does not have a preview on Spotify.\"\n }\n}\n\nErrored
\n{\n \"Error\": {\n \"Code\": \"4\",\n \"Description\": \"Analysis Failed - Could not find library track.\"\n }\n}\n\nType can either be Spotify or Youtube.
\nIn both instances the URL is the fully supplied URL.
\n","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5173e49c-9b9c-4d26-9d7d-aeac7773835b"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"7e04a57a-566e-475f-802a-1653fff3b10f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e04a57a-566e-475f-802a-1653fff3b10f"}],"id":"98551046-350a-46b5-a162-a9e7be9a793d","description":"Searching by URL requires a number of steps;
\nCheck the service for the availability of the Spotify or YouTube URL
\nGet External Status (Spotify) or Get External Status (YouTube)
\nContinue to repeat (1) if the response is Analysis Penidng, 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\nSearching by a prompt, allows you to provide a sentence or prompt to obtain similar tracks for.
\n\n","_postman_id":"28dd5d67-d81e-4a6d-baa7-6233cfd2f61f"}],"id":"e29d8d33-2614-48e9-94ae-f0e4b2063268","_postman_id":"e29d8d33-2614-48e9-94ae-f0e4b2063268","description":""}],"id":"cb10e3e4-8974-410c-b941-d748a2543066","_postman_id":"cb10e3e4-8974-410c-b941-d748a2543066","description":""},{"name":"Create Saved Search","id":"d2523117-657e-4001-9cb4-265a8dc50d48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 Name\",\r\n \"Description\": \"My Search Description\",\r\n \"SearchHistoryID\": \"{ParentSearchHistoryID}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addmembersavesearch/{{HM_ServiceAPI_MemberToken}}","description":"Allows 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":[],"_postman_id":"d2523117-657e-4001-9cb4-265a8dc50d48"}],"id":"1d2bb184-238f-463a-a9d4-6df62edc8f85","_postman_id":"1d2bb184-238f-463a-a9d4-6df62edc8f85","description":""},{"name":"Search Page - SFX Only","item":[{"name":"Core Search","item":[{"name":"Get Search Filtered By Keyword","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"c7fe56a7-574b-42c2-87ba-0ea6372644c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"ReturnCSUrl\": \"true\",\r\n \"SaveSearchHistory\": \"false\",\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 \"LibraryType\": \"SoundEffects\",\r\n \"HasStems\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Keyword_Aggregated\": {\r\n \"ExactPhrase\": \"false\",\r\n \"Wildcard\": \"true\",\r\n \"DisableKeywordGroup\": \"false\",\r\n \"OrOperation\": \"false\",\r\n \"Keywords\": \"pop\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Style\",\r\n \"Sort_Predefined\": \"\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"100\",\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}}","description":"NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Can only be called after at least one search term has been entered
\n","urlObject":{"path":["autocomplete","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09a1ba57-0b3b-40f2-831b-9084042dbef8"}],"id":"29887a90-0b28-4493-8017-d041e419a0ca","_postman_id":"29887a90-0b28-4493-8017-d041e419a0ca","description":""},{"name":"Predictive Search","item":[{"name":"Get Predictive Search","event":[{"listen":"test","script":{"id":"c12db662-d47c-40b9-b5d1-bf3b571d9233","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"bc5d7484-f796-4ad7-bbd8-15e6ab57f94c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Keyword\": \"happy\",\r\n\t\"Wildcard\": true,\r\n \"LibraryType\": \"SoundEffects\",\r\n\t\"ReturnTracks\": true,\r\n\t\"ReturnTracks_MainOnly\": true,\r\n\t\"ReturnTracks_Fields\": \"DisplayTitle,Keywords,Instrumentation,MusicFor,Mood\",\r\n\t\"ReturnTracks_Limit\": 1,\r\n\t\"ReturnTracks_Order\": \"Date_Descent\",\r\n\t\"ReturnTracks_DisableKeywordGroup\": true,\r\n\t\"ReturnTracks_Rank\": \"\",\r\n\t\"ReturnAlbums\": false,\r\n\t\"ReturnLyrics\": false,\r\n\t\"ReturnFeaturedPlaylists\": false,\r\n \"ReturnLibraries\": false,\r\n \"ReturnStyles\": false,\r\n \"ReturnCategoryAttributes\": false,\r\n \"ReturnRightHolders\": false,\r\n \"ReturnKeywords\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/autocomplete/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["autocomplete","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc5d7484-f796-4ad7-bbd8-15e6ab57f94c"}],"id":"33a6ff80-208b-4868-921e-ea990d1b4d5a","_postman_id":"33a6ff80-208b-4868-921e-ea990d1b4d5a","description":""}],"id":"f6fae97b-44e8-4864-bcfe-663469b0c15e","_postman_id":"f6fae97b-44e8-4864-bcfe-663469b0c15e","description":""},{"name":"Search Music Page - Music Only","item":[{"name":"Core Search","item":[{"name":"Get Search Filtered By Keyword","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"b3214017-6d44-487e-a714-85a4d6e93ab8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"ReturnCSUrl\": \"true\",\r\n \"SaveSearchHistory\": \"false\",\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 \"LibraryType\": \"Music\",\r\n \"HasStems\": null,\r\n \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Keyword_Aggregated\": {\r\n \"ExactPhrase\": \"false\",\r\n \"Wildcard\": \"true\",\r\n \"DisableKeywordGroup\": \"false\",\r\n \"OrOperation\": \"false\",\r\n \"Keywords\": \"pop\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Style\",\r\n \"Sort_Predefined\": \"\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"100\",\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}}","description":"NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE: Can only be called after at least one search term has been entered
\n","urlObject":{"path":["autocomplete","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2f8ab71b-ca03-42ab-bfbe-9e7b4affb78e","name":"Get Suggested Keywords","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"Keyword\":\"france\",\r\n\t\"Wildcard\":true,\r\n\t\"ReturnTracks\":true,\r\n\t\"ReturnTracks_MainOnly\":true,\r\n\t\"ReturnTracks_Fields\":\"DisplayTitle,Keywords,AlternateTitle\",\r\n\t\"ReturnTracks_Limit\":1,\r\n\t\"ReturnTracks_Order\":\"\",\r\n\t\"ReturnTracks_DisableKeywordGroup\":true,\r\n\t\"ReturnTracks_Rank\":\"\",\r\n\t\"ReturnAlbums\":true,\r\n\t\"ReturnAlbums_Fields\":\"CdCode,DisplayTitle,Description,Keywords\",\r\n\t\"ReturnAlbums_Limit\":1,\r\n\t\"ReturnAlbums_Order\":\"\",\r\n\t\"ReturnAlbums_DisableKeywordGroup\":false,\r\n\t\"ReturnLibraries\":true,\r\n\t\"ReturnLibraries_Fields\":\"Name,Prefix,Description\",\r\n\t\"ReturnLibraries_Limit\":1,\r\n\t\"ReturnLibraries_DisableKeywordGroup\":false,\r\n\t\"ReturnStyles\":true,\r\n\t\"ReturnStyles_Limit\":1,\r\n\t\"ReturnStyles_Order\":\"\",\r\n\t\"ReturnStyles_DisableKeywordGroup\":false,\r\n\t\"ReturnCategoryAttributes\":true,\r\n\t\"ReturnCategoryAttributes_Limit\":1,\r\n\t\"ReturnCategoryAttributes_ShowOnPlayerOnly\":false,\r\n\t\"ReturnCategoryAttributes_IncludeCategory\":false,\r\n\t\"ReturnCategoryAttributes_Order\":\"AllAlphabetic\",\r\n\t\"ReturnCategoryAttributes_DisableKeywordGroup\":false,\r\n\t\"ReturnRightHolders\":true,\r\n\t\"ReturnRightHolders_Fields\":\"firstname, lastname\",\r\n\t\"ReturnRightHolders_Limit\":1,\r\n\t\"ReturnRightHolders_DisableKeywordGroup\":false,\r\n\t\"RightHolderTypes\":\"Artist\",\r\n\t\"ReturnLyrics\":true,\r\n\t\"ReturnLyrics_Limit\":1,\r\n\t\"ReturnLyrics_MainOnly\":false,\r\n\t\"ReturnLyrics_DisableKeywordGroup\":false,\r\n\t\"ReturnKeywords\":true,\r\n\t\"ReturnKeywordsMaxSize\":1,\r\n\t\"ReturnKeywordsForMatch\":false,\r\n \"ReturnKeywordsForMatch_Fields\":\"\",\r\n \"ReturnKeywordsForMatch_HideWhenSearchTerm\":false,\r\n\t\"ReturnKeywordsDisableKeywordGroup\":false,\r\n\t\"ReturnFeaturedPlaylists\":true,\r\n\t\"ReturnFeaturedPlaylist_Fields\":\"ProjectTitle,Description\",\r\n\t\"ReturnFeaturedPlaylists_Limit\": 1,\r\n\t\"ReturnFeaturedPlaylist_Order\":\"Alphabetic_Ascent\",\r\n\t\"ReturnFeaturedPlaylists_DisableKeywordGroup\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/autocomplete/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Nov 2024 04:59: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 \"AlbumsFound\": 3,\n \"Albums\": [\n {\n \"AlbumID\": \"e17ca409526752bb\",\n \"CDCode\": \"WOM167\",\n \"DisplayTitle\": \"WOM 167 Le Voyage De La Vie\",\n \"TrackCount\": \"48\"\n }\n ],\n \"TracksFound\": 2,\n \"Tracks\": [\n {\n \"TrackID\": \"0c9ebe9102db2567\",\n \"CDCode\": \"WOMG 021\",\n \"TrackNumber\": \"014\",\n \"DisplayTitle\": \"Porcelain\",\n \"AlternateTitle\": \"\",\n \"AlbumID\": \"0df020525f6629b2\"\n }\n ],\n \"StylesFound\": 0,\n \"TagsFound\": 0,\n \"CategoryAttributesFound\": 0,\n \"LibraryFound\": 0,\n \"ComposerFound\": 0,\n \"RightHolderFound\": 3,\n \"rightHolders\": [\n {\n \"RightHolderID\": \"1f4320b8e61624f1\",\n \"FirstName\": \"Francesco\",\n \"LastName\": \"Siano\",\n \"Name\": \"\",\n \"MiddleName\": \"\",\n \"IPI\": \"427681343\",\n \"Type\": \"Artist\"\n }\n ],\n \"LyricFound\": 0,\n \"FeaturedPlaylistsFound\": 0,\n \"KeywordsFound\": 1\n}"}],"_postman_id":"fd60793b-4037-455e-b8d0-0fea59b46a48"}],"id":"ff9d6321-4062-4b2f-a421-9e65063b03d1","_postman_id":"ff9d6321-4062-4b2f-a421-9e65063b03d1","description":""},{"name":"Predictive Search","item":[{"name":"Get Predictive Search","event":[{"listen":"test","script":{"id":"c12db662-d47c-40b9-b5d1-bf3b571d9233","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"be844c0b-9650-4a12-b5a1-aa1b4af1a338","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"Keyword\": \"happy\",\r\n\t\"Wildcard\": true,\r\n \"LibraryType\": \"Music\",\r\n\t\"ReturnTracks\": true,\r\n\t\"ReturnTracks_MainOnly\": true,\r\n\t\"ReturnTracks_Fields\": \"DisplayTitle,Keywords,Instrumentation,MusicFor,Mood\",\r\n\t\"ReturnTracks_Limit\": 1,\r\n\t\"ReturnTracks_Order\": \"Date_Descent\",\r\n\t\"ReturnTracks_DisableKeywordGroup\": true,\r\n\t\"ReturnTracks_Rank\": \"\",\r\n\t\"ReturnAlbums\": false,\r\n\t\"ReturnLyrics\": false,\r\n\t\"ReturnFeaturedPlaylists\": false,\r\n \"ReturnLibraries\": false,\r\n \"ReturnStyles\": false,\r\n \"ReturnCategoryAttributes\": false,\r\n \"ReturnRightHolders\": false,\r\n \"ReturnKeywords\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/autocomplete/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["autocomplete","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be844c0b-9650-4a12-b5a1-aa1b4af1a338"}],"id":"3170a8c9-fb32-4c2c-803e-fb540e79fea7","_postman_id":"3170a8c9-fb32-4c2c-803e-fb540e79fea7","description":""}],"id":"658e6dac-9a66-4d70-8f60-5bc59daf3d83","_postman_id":"658e6dac-9a66-4d70-8f60-5bc59daf3d83","description":""},{"name":"Track Info Page","item":[{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"46bb379c-e6fa-431b-a522-699576345e91","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"false\",\r\n\t\"ReturnCategories\":\"true\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"true\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"46bb379c-e6fa-431b-a522-699576345e91"},{"name":"Get Similar Tracks","event":[{"listen":"test","script":{"id":"1b0fddcd-a083-47c7-bab4-f63531d74b1d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"b6b46d5c-6592-4918-aaf6-c3291349cd29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"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 \"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 \"Limit\": \"5\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6b46d5c-6592-4918-aaf6-c3291349cd29"}],"id":"413dc6d7-83b7-42a4-8eee-32a901ca47e2","_postman_id":"413dc6d7-83b7-42a4-8eee-32a901ca47e2","description":""},{"name":"All Labels Page","item":[{"name":"Get Labels","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"7350e4a9-f9f3-436d-9a3b-717f33ed75e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Keyword\": {\r\n \"Fields\": \"LibraryName\",\r\n \"ExactPhrase\": false,\r\n \"Wildcard\": true,\r\n \"DisableKeywordGroup\": false,\r\n \"OrOperation\": false,\r\n \"Negative\": false,\r\n \"Keywords\": \"%\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Library\",\r\n \"View_Library_Count\":\"Track\",\r\n \"Sort_Predefined\": \"Alphabetic_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"20\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7350e4a9-f9f3-436d-9a3b-717f33ed75e1"},{"name":"Get Labels Filtered By Search","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"8a1ab065-d671-4fd3-b9c9-c636cd918e6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"PreviousSearchTermBundles\": [\r\n {\r\n \"SearchHistoryID\": 11676466,\r\n \"St_Keyword\": {\r\n \"Fields\": \"LibraryName\",\r\n \"ExactPhrase\": false,\r\n \"Wildcard\": true,\r\n \"DisableKeywordGroup\": false,\r\n \"OrOperation\": false,\r\n \"Negative\": false,\r\n \"Keywords\": \"%\"\r\n }\r\n }\r\n ],\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\": \"dark horse\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Library\",\r\n \"View_Library_Count\":\"Track\",\r\n \"Sort_Predefined\": \"Alphabetic_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"20\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a1ab065-d671-4fd3-b9c9-c636cd918e6f"}],"id":"0e427b76-11ab-4867-a067-e4bd11d7f518","_postman_id":"0e427b76-11ab-4867-a067-e4bd11d7f518","description":""},{"name":"Label Page","item":[{"name":"Get Label","event":[{"listen":"test","script":{"id":"eee6fe17-9678-4b01-b9e4-2b6092ab87f9","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"81d5e167-e2fe-4660-989f-5be214cf3ba6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getlibrary/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_LibraryID}}","urlObject":{"path":["getlibrary","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_LibraryID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"81d5e167-e2fe-4660-989f-5be214cf3ba6"},{"name":"Get Latest Albums","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"3622fc18-a7f6-4605-ae4a-dbc747f7ef2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Library\": {\r\n \t\"Libraries\": \"a22b13jd6456cf03a1\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"15\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3622fc18-a7f6-4605-ae4a-dbc747f7ef2c"}],"id":"20d2d2d9-3029-4d1f-aaa9-6dad20410974","_postman_id":"20d2d2d9-3029-4d1f-aaa9-6dad20410974","description":""},{"name":"All Albums Page","item":[{"name":"Get Labels for Dropdown","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"eac3c9f6-a53c-4691-a186-fcd80a115031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Library\",\r\n \"View_Library_Count\":\"Track\",\r\n \"Sort_Predefined\": \"Alphabetic_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"20\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eac3c9f6-a53c-4691-a186-fcd80a115031"},{"name":"Get Collections for Dropdown","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"2d234dba-0193-43b2-8447-6b543c2062a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Style\",\r\n \"Sort_Predefined\": \"Alphabetic_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"5\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d234dba-0193-43b2-8447-6b543c2062a0"},{"name":"Get Albums (No Filters)","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"a9cff265-1b8f-431a-8bb2-cc47058524f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\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\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"20\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9cff265-1b8f-431a-8bb2-cc47058524f6"},{"name":"Get Albums Filtered By Label","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"47767b4e-00f0-4f04-b88c-7747a26d5cfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Library\": {\r\n \t\"Libraries\": \"a22b13jd6456cf03a1\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"20\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47767b4e-00f0-4f04-b88c-7747a26d5cfb"},{"name":"Get Albums Filtered By Style","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"933f4aa0-b9fc-4ff3-b7b2-c067167ce0fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Style\": {\r\n \"Styles\": \"a22b13jd6456cf03a1\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"20\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"933f4aa0-b9fc-4ff3-b7b2-c067167ce0fd"},{"name":"Get Albums Filtered By Label & Style","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"1354715d-3036-4357-969b-b8f1d53edf98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Library\": {\r\n \"Libraries\": \"b666754e0fa69f1790\",\r\n \"Negative\": false\r\n },\r\n \"St_Style\": {\r\n \"Styles\": \"a22b13jd6456cf03a1\",\r\n \"Negative\": false\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"20\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1354715d-3036-4357-969b-b8f1d53edf98"}],"id":"e5a78da2-8523-436b-a062-6b05b36d21a6","_postman_id":"e5a78da2-8523-436b-a062-6b05b36d21a6","description":""},{"name":"Album Page","item":[{"name":"Get Album","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"4bdf05d5-c96a-44ae-bfbd-efd9ade24523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Album\": {\r\n \"Albums\": \"g56ed5590ha8c7c34d\",\r\n \"Negative\": \"\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"Alphabetic_Asc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"1\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4bdf05d5-c96a-44ae-bfbd-efd9ade24523"},{"name":"Get Album Tracks","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"bbcb108f-eec1-4b93-bc6c-bebc0e2bddaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"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 \"ReturnCSUrl\": true,\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Album\": {\r\n \"Albums\": \"ab7908fb71697899\",\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 \"View_Album_Assigned_To_Style\": \"false\",\r\n \"View_Playlist_Assigned_To_Style\": \"false\",\r\n \"Sort_Predefined\": \"Alphabetic_Asc \",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"100\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbcb108f-eec1-4b93-bc6c-bebc0e2bddaf"},{"name":"Get Track Details","event":[{"listen":"test","script":{"id":"d523a71a-0877-4323-8702-7b9060788951","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"de0cd323-f9ca-416e-b76b-8767f25fecff","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"},{"key":"Authorization","type":"text","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"ReturnAlternateVersions\":\"true\",\r\n\t\"ReturnAttributes\":\"false\",\r\n\t\"ReturnCategories\":\"false\",\r\n\t\"ReturnCategoryFacet\":\"false\",\r\n\t\"ReturnCodes\":\"false\",\r\n\t\"ReturnComposers\":\"false\",\r\n\t\"ReturnRelatedTracks\":\"false\",\r\n\t\"ReturnRightHolders\":\"true\",\r\n \"ReturnStems\": \"false\",\r\n\t\"GetMainVersionFromAlternate\":\"false\",\r\n\t\"CuesheetOnlyCodesAndAttribute\":\"false\",\r\n\t\"ReturnInactiveTracks\":\"false\",\r\n \"ReturnRegionOnlyTracks\":\"false\",\r\n\t\"track\":[\"{{HM_ServiceAPI_TrackID}}\"]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/gettracks/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["gettracks","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"de0cd323-f9ca-416e-b76b-8767f25fecff"},{"name":"Get Related Albums","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"d4c9f948-7fd5-4b15-9c4d-239a3646ad03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Style\": {\r\n \"Styles\": \"189ff1b76392046f,4972a6d41723a81e,f38d313245e6a333,6c481973f31eb1e3\",\r\n \"OrOperation\": \"true\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Album\",\r\n \"Sort_Predefined\": \"Random\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"4\",\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}}","urlObject":{"path":["cloudsearch","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4c9f948-7fd5-4b15-9c4d-239a3646ad03"},{"name":"Get Album (non-CS)","id":"6eb7eee0-a162-4d98-b6b5-4cb8bef0a373","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HM_ServiceAPI_URL}}/getalbumtracks/{{HM_ServiceAPI_MemberToken}}/{AlbumID}/mainonly?skip={skip}&limit={limit}","urlObject":{"path":["getalbumtracks","{{HM_ServiceAPI_MemberToken}}","{AlbumID}","mainonly"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"skip","value":"{skip}"},{"key":"limit","value":"{limit}"}],"variable":[]}},"response":[],"_postman_id":"6eb7eee0-a162-4d98-b6b5-4cb8bef0a373"}],"id":"9305a0a8-9f07-4da8-ab2b-c25039453233","_postman_id":"9305a0a8-9f07-4da8-ab2b-c25039453233","description":""},{"name":"All Playlists Page","item":[{"name":"DISCO","item":[{"name":"Send Member Playlist to Disco","event":[{"listen":"test","script":{"id":"1b23b05d-01f9-470d-aa38-db2017489c1c","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"6dc9c954-7626-41dc-8232-8ffe04e47db4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_IntegrationAPI_URL}}/sendtodisco/{{HM_ServiceAPI_MemberToken}}/{{playlistID}}?fileformatid={{optional_fileformatID}}","urlObject":{"path":["sendtodisco","{{HM_ServiceAPI_MemberToken}}","{{playlistID}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[{"key":"fileformatid","value":"{{optional_fileformatID}}"}],"variable":[]}},"response":[{"id":"a533ecf1-cb1d-4ee7-aad7-30115e29e7fc","name":"Send Member Playlist to Disco (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/sendtodisco/{{HM_ServiceAPI_MemberToken}}/{{playlistid}}?fileformatid={{optional_fileformatID}}","host":["{{HM_ServiceAPI_URL}}"],"path":["sendtodisco","{{HM_ServiceAPI_MemberToken}}","{{playlistid}}"],"query":[{"key":"fileformatid","value":"{{optional_fileformatID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 May 2025 04:03:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"No-Cache"},{"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\": \"c1c61173-0272-4b61-84de-6e970d373110\",\n \"url\": \"https://service-w4vblywy.disco.ac/lib/add-to-disco/?token=c1c61173-0272-4b61-84de-6e970d373110\"\n}"}],"_postman_id":"6dc9c954-7626-41dc-8232-8ffe04e47db4"},{"name":"Share Member Playlist to Disco","id":"b2453f68-5262-43aa-9ed0-e0787d86df8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"PlaylistID\": \"{{PlaylistID}}\",\r\n \"FileFormatID\": \"{{FileFormatID}}\",\r\n \"RecipientInboxURL\": \"{{RecipientInboxURL}}\",\r\n \"Note\": \"{{Notes}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_IntegrationAPI_URL}}/sharetodisco/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["sharetodisco","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_IntegrationAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a0554404-c792-4fc1-a9f0-3486be574a31","name":"Share Member Playlist to Disco (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"PlaylistID\": \"84ecf73c24f45983\",\r\n \"FileFormatID\": \"7026280a00766607\",\r\n \"RecipientInboxURL\": \"https://s.disco.ac/jrodofxcphxm\",\r\n \"Note\": \"Here is your BIG playlist\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sharetodisco/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Thu, 30 Apr 2026 06:41:58 GMT"},{"key":"content-type","value":"application/json"},{"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 \"ActivityID\": \"b1850e380186ee50\",\n \"Status\": \"Pending\"\n}"}],"_postman_id":"b2453f68-5262-43aa-9ed0-e0787d86df8b"},{"name":"Get External Share Status History - No RelationID","event":[{"listen":"test","script":{"id":"1b23b05d-01f9-470d-aa38-db2017489c1c","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"62224122-88d1-4298-b476-611627d14f78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"RelationType\": \"Playlist\",\r\n \"Skip\": {{Skip}},\r\n \"Limit\": {{limit}},\r\n \"Sort\": \"DateAdded_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getexternalsharestatushistory/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["getexternalsharestatushistory","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4ea9d01c-6c91-4bfa-a54c-3f6d39b55b51","name":"Get External Share Status History - No RelationID (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"RelationType\": \"Playlist\",\r\n \"RelationID\": \"{{PlaylistID}}\",\r\n \"Skip\": {{Skip}},\r\n \"Limit\": {{limit}},\r\n \"Sort\": \"DateAdded_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getexternalsharestatushistory/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Tue, 12 May 2026 05:31:54 GMT"},{"key":"content-type","value":"application/json"},{"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 \"ExternalShareStatusHistory\": [\n {\n \"ID\": \"272f1d66c82967de\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:02:44.783\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4d574935ca3d22c3\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"4d3ddcd6da8eed45\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:03:27.447\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4ea153312c6cd77f\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error in searching playlist track - Unexpected character encountered while parsing value: <. Path '', line 0, position 0.\"\n },\n {\n \"ID\": \"bc371530fd7e64c1\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:04:10.04\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"6ec1a87444201b29\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"95f52ce24a2ca7e1\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:04:38.997\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4440434b0e1cf7a6\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error in searching playlist track - Unexpected character encountered while parsing value: <. Path '', line 0, position 0.\"\n },\n {\n \"ID\": \"d0b8ba29471595bf\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:04:50.593\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"56928279dfe0cd83\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"19b8f5935503adde\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:05:21.96\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"c3dc38ada9998854\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"47ec1487133769b9\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:13:07.077\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"c3dc38ada9998854\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"3de9d6146c5f833b\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:13:21.34\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"56928279dfe0cd83\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"7026280a00766607\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:13:51.387\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4440434b0e1cf7a6\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error in searching playlist track - Unexpected character encountered while parsing value: <. Path '', line 0, position 0.\"\n },\n {\n \"ID\": \"99dc08a83ff1671e\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:14:47.19\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"6ec1a87444201b29\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"07a147a3be95f6f1\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:15:19.717\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4ea153312c6cd77f\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error in searching playlist track - Unexpected character encountered while parsing value: <. Path '', line 0, position 0.\"\n },\n {\n \"ID\": \"8185d768cd8fcaa7\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:15:58.133\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4d574935ca3d22c3\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"145e2b8d68c4a0b6\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:25:27.753\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"c3dc38ada9998854\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"593621618\",\n \"Status\": \"Success\",\n \"ErrorMessage\": \"\"\n },\n {\n \"ID\": \"8c2bee801542050d\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:25:55.05\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"56928279dfe0cd83\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"593624133\",\n \"Status\": \"Success\",\n \"ErrorMessage\": \"\"\n },\n {\n \"ID\": \"f924c25e35500090\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:27:15.03\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4440434b0e1cf7a6\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error in searching playlist track - Unexpected character encountered while parsing value: <. Path '', line 0, position 0.\"\n },\n {\n \"ID\": \"f86494decc7fd314\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:27:41.383\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"6ec1a87444201b29\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"593624125\",\n \"Status\": \"Success\",\n \"ErrorMessage\": \"\"\n },\n {\n \"ID\": \"90e8e7e17896333a\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:28:28.413\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4ea153312c6cd77f\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error in searching playlist track - Unexpected character encountered while parsing value: <. Path '', line 0, position 0.\"\n },\n {\n \"ID\": \"19ecbe6bedcfa645\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:28:38.237\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4d574935ca3d22c3\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"593624132\",\n \"Status\": \"Success\",\n \"ErrorMessage\": \"\"\n }\n ]\n}"}],"_postman_id":"62224122-88d1-4298-b476-611627d14f78"},{"name":"Get External Share Status History - By RelationID","event":[{"listen":"test","script":{"id":"1b23b05d-01f9-470d-aa38-db2017489c1c","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e37cd9c6-d31f-45a0-bc6c-686621ee26b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"RelationType\": \"Playlist\",\r\n \"Skip\": {{Skip}},\r\n \"Limit\": {{limit}},\r\n \"Sort\": \"DateAdded_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getexternalsharestatushistory/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["getexternalsharestatushistory","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3abf4fcf-6f72-4ca4-a4a5-8dad307326c5","name":"Get External Share Status History - By RelationID (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"RelationType\": \"Playlist\",\r\n \"RelationID\": \"{{RelationID}}\",\r\n \"Skip\": {{Skip}},\r\n \"Limit\": {{limit}},\r\n \"Sort\": \"DateAdded_Asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getexternalsharestatushistory/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Tue, 12 May 2026 05:33:48 GMT"},{"key":"content-type","value":"application/json"},{"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 \"ExternalShareStatusHistory\": [\n {\n \"ID\": \"272f1d66c82967de\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:02:44.783\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4d574935ca3d22c3\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"8185d768cd8fcaa7\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:15:58.133\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4d574935ca3d22c3\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"\",\n \"Status\": \"Error\",\n \"ErrorMessage\": \"Error on generating track URLs - Internal Operation Error\"\n },\n {\n \"ID\": \"19ecbe6bedcfa645\",\n \"Type\": \"DISCO_Share\",\n \"Style\": \"Information\",\n \"DateAdded\": \"2026-05-12T12:28:38.237\",\n \"RelationType\": \"Playlist\",\n \"RelationID\": \"4d574935ca3d22c3\",\n \"Message\": \"RecordSent\",\n \"MessageDetail\": \"593624132\",\n \"Status\": \"Success\",\n \"ErrorMessage\": \"\"\n }\n ]\n}"}],"_postman_id":"e37cd9c6-d31f-45a0-bc6c-686621ee26b2"}],"id":"75f8de09-50f1-4ac2-9a04-9440c891de1d","description":"This integration allows platforms to send curated playlists directly to Disco’s content system and monitor the status of these deliveries. The main use cases are:
\nPushing selected playlists from FLEX to Disco
\nTracking which playlists have already been sent or are currently being processed
\nGAP
\nIt is not currently possible to search via ST_PLAYLIST, nor is it possible to get results VIEW: PLAYLIST
GAP
\nIt is not currently possible to search via ST_PLAYLIST, nor is it possible to get results VIEW: PLAYLIST
GAP
\nIt is not currently possible to search via ST_PLAYLIST, nor is it possible to get results VIEW: PLAYLIST
GAP
\nIt is not currently possible to search via ST_PLAYLIST, nor is it possible to get results VIEW: PLAYLIST
RESPONSE HANDLING
\nThere are a number of possible responses from this endpoint.
\n(1) When the share has expired naturally
\n{\n \"RequestEngageToken\": {\n \"Value\": \"7ab502278d5a88e83156d15d221c0dee\",\n \"Expiry\": \"2026-04-07T15:48:37.067\",\n \"UTCOffset\": 10.0,\n \"Type\": \"EngageToken\",\n \"IsOfSingleUse\": false,\n \"TokenUsageState\": \"Expired\"\n }\n}\n\n(2) When the underlying playlist has been removed by the Owner
\n{\n \"Error\": {\n \"Code\": \"40\",\n \"Description\": \"Share Does Not Exist. The owner or recipient has since wtihdrawn from the share.\"\n }\n}\n\n(3) When the share is no longer active, because a recipient has already accepted the share. The ObjectID in the response is the playlistID in the recipients account.
\n{\n \"Error\": {\n \"Code\": \"41\",\n \"Description\": \"Share Accepted. The requested share has already been accepted.\"\n },\n \"ObjectID\": \"bb7d2ae62b832be853\"\n}\n\n(4) For collaborative playlists; when the share was withdrawn by the Owner or the Recipient left
\n{\n \"Error\": {\n \"Code\": \"38\",\n \"Description\": \"Shared Playlist Does Not Exist. The owner has removed the playlist.\"\n }\n}\n\nPLAYLIST COLLABORATION
\nExisting ReferredPermissions object in the response will now contain additional properties:
AllowEdit
AllowCollaboration
AllowPublish
LastPublishDate
You can use these to configure options to the user.
\nIf AllowCollaboration = false then show two saving options of Save as New and Save as Publishable
AllowPublish will always be true, but if in the future we needed this to be flexible then you may need to hide the Save as Publishable option if AllowPublish = falseIf AllowCollaboration = true then show two saving options of Save as New and Save as Collaboration
Shared playlists allow downloading as guests or members.
\n","urlObject":{"path":["getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"43da2e01-ca66-4699-ae4e-5230c2ba005a"},{"name":"Accept Shared Playlist (ShareURL only))","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","// var jsonData = null;","// var jsonDataToken = \"\";","","// if (responseBody.indexOf(\"= 0) {","// jsonData = xml2Json(responseBody);"," ","// console.log(jsonData.responseengageshare.url.split(\"/\")[jsonData.responseengageshare.url].split(\"/\").length -1);"," ","// jsonDataToken = jsonData.responseengageshare.url.split(\"/\")[jsonData.responseengageshare.url].split(\"/\").length -1;","// } else {","// jsonData = JSON.parse(responseBody)","// jsonDataToken = jsonData.Url.split(\"/\")[jsonData.Url.split(\"/\").length -1];","// }","","// console.log(\"HM_ServiceAPI_EnageAccessToken set to \" + jsonDataToken);","","// postman.setEnvironmentVariable(\"HM_ServiceAPI_EnageAccessToken\", jsonDataToken);","","// postman.setNextRequest(\"Get Shared Playlist By Engage\");"],"type":"text/javascript","id":"b4dafda2-a099-4e54-8d96-436809f96899"}}],"id":"bb0e30ab-0276-4be7-b6ba-bff1b9acde51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/acceptsharemusic/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_EnageAccessToken}}?acceptType={acceptType}","description":"Adds 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.
\nPLAYLIST COLLABORATION
\nacceptType=true will have 3 possible values;
AsCopy
\nAsPublishable
\nAsCollaboration
\nWhen not provided, will default to AsCopy
\nAsCopy will work for sharing via Sync or Copy
AsPublishable only works with Copy
AsCollaboration only works with Sync
Request Elements
\n","urlObject":{"path":["acceptsharemusic","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_EnageAccessToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"acceptType","value":"{acceptType}"}],"variable":[]}},"response":[],"_postman_id":"bb0e30ab-0276-4be7-b6ba-bff1b9acde51"}],"id":"48a0ae0b-63f5-4191-81bb-4ad8b917f15c","_postman_id":"48a0ae0b-63f5-4191-81bb-4ad8b917f15c","description":""},{"name":"Shared Playlist Page By ID","item":[{"name":"Swap ID for Token Share","event":[{"listen":"test","script":{"id":"351cd360-8dda-411e-b4f5-c22a49ee2ca3","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","// var jsonData = null;","// var jsonDataToken = \"\";","","// if (responseBody.indexOf(\"= 0) {","// jsonData = xml2Json(responseBody);"," ","// console.log(jsonData.responseengageshare.url.split(\"/\")[jsonData.responseengageshare.url].split(\"/\").length -1);"," ","// jsonDataToken = jsonData.responseengageshare.url.split(\"/\")[jsonData.responseengageshare.url].split(\"/\").length -1;","// } else {","// jsonData = JSON.parse(responseBody)","// jsonDataToken = jsonData.Url.split(\"/\")[jsonData.Url.split(\"/\").length -1];","// }","","// console.log(\"HM_ServiceAPI_EnageAccessToken set to \" + jsonDataToken);","","// postman.setEnvironmentVariable(\"HM_ServiceAPI_EnageAccessToken\", jsonDataToken);","","// postman.setNextRequest(\"Get Shared Playlist By Engage\");"],"type":"text/javascript","packages":{}}}],"id":"3a11c9cb-66d4-4d2a-8378-b4a2a8961988","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"ObjectIdentifier\": \"3c1a4d9a911a916190\",\r\n \"ObjectType\": \"Playlist\"\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurlbyid/{{HM_ServiceAPI_Token}}","urlObject":{"path":["getsharemusicurlbyid","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e5ed8f2f-2bc0-49c4-b0d4-3bf14949d873","name":"Swap ID for Token Share","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 \"ObjectIdentifier\": \"3c1a4d9a911a916190\",\r\n \"ObjectType\": \"Playlist\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getsharemusicurlbyid/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Aug 2024 12:51:26 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 \"ShareMusic\": [\n {\n \"Username\": \"guest\",\n \"Status\": \"Success\",\n \"Url\": \"http://Capacity is an array of string, could have multiple values requested by comma. Accepts:
\nArtist
\nAuthor
\nComposer
\nComposerAuthor
\nPublisher
\nSubPublisher
\nReturns all featured plans available for a given account or
\nReturns one specific plan (featured or not) requested via param
\n*Note for Enterprise or any other \"requestquote=true\" plan, no subscription price is returned.
\nRequest Elements
\n","urlObject":{"path":["getsubscriptionplans","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"eebbe21a-b4e3-4b80-a99c-7c8f907c800f","name":"Get Subscription Plans (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"url":"{{HM_ServiceAPI_URL}}/getsubscriptionplans/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Dec 2023 00:50:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"SubscriptionPlans\": [\n {\n \"ID\": \"272f1d66c82967de\",\n \"Name\": \"Individual\",\n \"Description\": \"Individual plan for single user\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-09-04T13:25:52\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"272f1d66c82967de\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"e5153b3e6e5ba804\",\n \"Price\": 24.99,\n \"StartDate\": \"2023-11-23T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n },\n {\n \"ID\": \"4d3ddcd6da8eed45\",\n \"Name\": \"Enterprise\",\n \"Description\": \"Please contact us for pricing\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Unlimited\",\n \"AllowTeam\": true,\n \"TeamMembers\": 15,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-09-04T13:26:30\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": true,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": []\n },\n {\n \"ID\": \"9e4d309244851779\",\n \"Name\": \"Free-trial\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-10-10T11:13:04\",\n \"HasFreeTrial\": true,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"19ecbe6bedcfa645\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"19ecbe6bedcfa645\",\n \"Price\": 5,\n \"StartDate\": \"2023-10-10T00:00:00\",\n \"Status\": 1\n }\n ],\n \"FreeTrial\": {\n \"ID\": \"5a2f797f4a3d59a5\",\n \"Period\": \"Trial\",\n \"PeriodDays\": 14,\n \"TrialDownloadLimit\": 20,\n \"RolloverSubscriptionID\": \"19ecbe6bedcfa645\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"\",\n \"SubscriptionPrices\": []\n }\n }\n ]\n },\n {\n \"ID\": \"0dabdb1ee6f7b545\",\n \"Name\": \"AllowTeam\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": true,\n \"TeamMembers\": 2,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-10-10T14:11:35\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"bce3cac31bcb8576\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"5a2f797f4a3d59a5\",\n \"Price\": 20,\n \"StartDate\": \"2023-10-10T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n },\n {\n \"ID\": \"f4df85b9b479ca70\",\n \"Name\": \"Daily\",\n \"Description\": \"Test for daily invoice check\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": true,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-10-24T17:35:11\",\n \"HasFreeTrial\": true,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [\n {\n \"ID\": \"d0b8ba29471595bf\",\n \"Description\": \"Test\",\n \"OrderID\": 0,\n \"IsHeader\": true,\n \"Status\": \"Active\"\n },\n {\n \"ID\": \"19b8f5935503adde\",\n \"Description\": \"Feature 1\",\n \"OrderID\": 1,\n \"IsHeader\": false,\n \"Status\": \"Active\"\n }\n ],\n \"Subscriptions\": [\n {\n \"ID\": \"0dabdb1ee6f7b545\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"9e4d309244851779\",\n \"Price\": 5,\n \"StartDate\": \"2023-10-24T00:00:00\",\n \"Status\": 1\n }\n ],\n \"FreeTrial\": {\n \"ID\": \"82193ff640dd7d69\",\n \"Period\": \"Trial\",\n \"PeriodDays\": 1,\n \"TrialDownloadLimit\": 20,\n \"RolloverSubscriptionID\": \"0dabdb1ee6f7b545\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"\",\n \"SubscriptionPrices\": []\n }\n }\n ]\n },\n {\n \"ID\": \"96f153356899e5c5\",\n \"Name\": \"Individual Upgrade\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-11-28T16:02:30\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"733cf072013be8c4\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"3b7e990361490e50\",\n \"Price\": 38,\n \"StartDate\": \"2023-11-28T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n },\n {\n \"ID\": \"f005ea25ae1dd914\",\n \"Name\": \"Price Badge Test\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-12-04T15:55:41\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"f005ea25ae1dd914\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"Monthly Badge Update\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"733cf072013be8c4\",\n \"Price\": 1.99,\n \"StartDate\": \"2023-12-04T00:00:00\",\n \"Status\": 1\n }\n ]\n },\n {\n \"ID\": \"ab2d1f4102e46d95\",\n \"Period\": \"Yearly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"PriceBadge\": \"Yearly Badge Update\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"96f153356899e5c5\",\n \"Price\": 11.99,\n \"StartDate\": \"2023-12-04T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n }\n ]\n}"},{"id":"c25f8e71-759b-4bf1-8296-1f4b9190aa57","name":"Get Subscription Plans (SPECIFIC PLAN)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/getsubscriptionplans/{{HM_IntegrationAPI_Token}}?subscriptionplanid=95f52ce24a2ca7e1","host":["{{HM_ServiceAPI_URL}}"],"path":["getsubscriptionplans","{{HM_IntegrationAPI_Token}}"],"query":[{"key":"subscriptionplanid","value":"95f52ce24a2ca7e1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Sep 2023 05:50:23 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Set-Cookie","value":"AWSALBTG=GvzrYgvdFsxLmBZ4l82L/rwW5Xk28jjr857UxpT7LS2dYZtxQrWjtbfp8MDlaerEjExt7dymsREEyYgNJ+4iomdGGJJrU/LLTbxhIUMD1PDbrKC94jQrAt9eIOMWuVR9R4WJBRoAJkhdr/JnvUZMA8YhNlDn8OQkdTWXBvgkPXyqo8JALxw=; Expires=Wed, 13 Sep 2023 05:50:23 GMT; Path=/","enabled":true},{"key":"Set-Cookie","value":"AWSALBTGCORS=GvzrYgvdFsxLmBZ4l82L/rwW5Xk28jjr857UxpT7LS2dYZtxQrWjtbfp8MDlaerEjExt7dymsREEyYgNJ+4iomdGGJJrU/LLTbxhIUMD1PDbrKC94jQrAt9eIOMWuVR9R4WJBRoAJkhdr/JnvUZMA8YhNlDn8OQkdTWXBvgkPXyqo8JALxw=; Expires=Wed, 13 Sep 2023 05:50:23 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"SubscriptionPlans\": [\n {\n \"ID\": \"95f52ce24a2ca7e1\",\n \"Name\": \"Individual\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-09-06T15:03:46\",\n \"HasFreeTrial\": true,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"7026280a00766607\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"47ec1487133769b9\",\n \"Price\": 10,\n \"StartDate\": \"2023-09-06T00:00:00\",\n \"Status\": 1\n }\n ],\n \"FreeTrial\": {\n \"ID\": \"99dc08a83ff1671e\",\n \"Period\": \"Trial\",\n \"PeriodDays\": 14,\n \"TrialDownloadLimit\": 20,\n \"RolloverSubscriptionID\": \"7026280a00766607\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": []\n }\n },\n {\n \"ID\": \"07a147a3be95f6f1\",\n \"Period\": \"Yearly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"3de9d6146c5f833b\",\n \"Price\": 100,\n \"StartDate\": \"2023-09-06T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"d246f989-786d-4665-9432-b731d546739b"}],"id":"385d6ec5-4e82-4991-94e9-8a3789a34d4a","description":"Returns all featured plans available for a given account or return one specific plan (featured or not) requested via param.
\n","_postman_id":"385d6ec5-4e82-4991-94e9-8a3789a34d4a"},{"name":"Member Log In Page","item":[{"name":"Authenticate Member & Generate Persistent Member Token","event":[{"listen":"test","script":{"id":"96bedff0-63bb-453c-a378-e0f65ab429a7","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataToken = \"\";","var jsonDataPersistentToken = \"\";","","if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataToken = jsonData.responsemembertoken.membertoken.$.value;"," jsonDataPersistentToken = jsonData.responsemembertoken.persistentlogintoken.$.token;","} else {"," jsonData = JSON.parse(responseBody)"," jsonDataToken = jsonData.MemberToken.Value;"," jsonDataPersistentToken = jsonData.PersistentLoginToken.Token;","}","","console.log(\"HM_ServiceAPI_MemberToken set to \" + jsonDataToken);","console.log(\"HM_ServiceAPI_MemberPersistentToken set to \" + jsonDataPersistentToken);","console.log(\"HM_ServiceAPI_MemberTokenIsLoggedMember set to true\");","","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberToken\", jsonDataToken);","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberPersistentToken\", jsonDataPersistentToken);","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberTokenIsLoggedMember\", \"true\");","","postman.setNextRequest(\"Get Member Details\");"],"type":"text/javascript"}}],"id":"c8c6a1c0-6170-49fa-9f7c-8123633c69dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_MemberUsername}}\",\r\n\t\"Password\":\"{{HM_ServiceAPI_MemberPassword}}\",\r\n\t\"PersistentLogin\":true,\r\n\t\"ReturnMemberDetails\":false,\r\n \"ReturnMemberSubscriptionDetails\":true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmembertoken/{{HM_IntegrationAPI_Token}}","description":"The following method should be used for member login.
\nIt will return a member token as well as a persistent login token if if requested by passing 'true' to <persistentlogin> element in the request body.
The persistent login token can be saved to member's cookie for reuse in future site accesses.
\nRequest Elements
\n","urlObject":{"path":["getmembertoken","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2de16c90-4e50-4c05-ad03-aaaa18ca834d","name":"Authenticate Member & Generate Persistent Member Token (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\":\"UserName\",\r\n\t\"Password\":\"Password\",\r\n\t\"PersistentLogin\":true,\r\n\t\"ReturnMemberDetails\":false,\r\n \"ReturnMemberSubscriptionDetails\":true\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","enabled":true},{"key":"Date","value":"Tue, 20 Aug 2019 04:29:52 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Content-Length","value":"298","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"f2a0e9e1-f897-498b-bf31-40c37201b2b2","name":"Authenticate Member & Generate Persistent Member Token (XML)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"Registers 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_IntegrationAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"9b29c7ee-289a-4b2f-9180-87a9cae04ea1","name":"Register 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\"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\":\"0cd2dbhf8c4cd66e21\",\r\n\t\t\"SearchFormat\":\"Track\",\r\n\t\t\"SearchSort\":\"New\",\r\n \"PositionType\":\"Manager\",\r\n \"Freelancer\":\"false\",\r\n\t\t\"IP\":\"123.45.648.90\",\r\n\t\t\"ExternalMemberID\": \"\",\r\n\t\t\"ExternalVerifyLink\": \"\"\r\n\t},\r\n\t\"NoMemberEmail\":false,\r\n \"VerifierEmail\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/registermember/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Tue, 20 Aug 2019 05:37:09 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Content-Length","value":"3641","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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\": \"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\": \"+61293577888\",\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\": \"pending\",\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 \"PositionType\": \"Manager\",\n \"Freelancer\": \"false\",\n \"ManagedBy\": {\n \"Name\": \"\",\n \"Email\": \"\",\n \"Phone\": \"\"\n },\n \"FileFormats\": [],\n \"HasProfileImage\": false\n }\n}"}],"_postman_id":"99e48e09-ee2e-44cc-90d4-da0a1913c832"}],"id":"1110a3a0-4e69-42be-899f-861a106d53aa","_postman_id":"1110a3a0-4e69-42be-899f-861a106d53aa","description":""},{"name":"Subscription Member Checkout Page","item":[{"name":"Create Invoice","event":[{"listen":"test","script":{"id":"07931462-9b4b-4220-bf48-fe6cb6749f7e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataInvoiceID = \"\";","var jsonDataInvoiceTotal = \"\";","","if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataInvoiceID = jsonData.responseinvoice.invoice.id;"," jsonDataInvoiceTotal = jsonData.responseinvoice.invoice.total;","} else {"," jsonData = JSON.parse(responseBody)"," if (jsonData.invoice !== null) {"," jsonDataInvoiceID = jsonData.invoice.id;"," jsonDataInvoiceTotal = jsonData.invoice.total;"," }","}","","console.log(\"HM_ServiceAPI_InvoiceID set to \" + jsonDataInvoiceID);","","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceID\", jsonDataInvoiceID);","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceTotal\", jsonDataInvoiceTotal);","","postman.setNextRequest(\"Get Invoice\");"],"type":"text/javascript"}}],"id":"7b7eae5c-dba6-466f-9e89-5526275b1d2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoice\": {\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"9e9c86da42e2b4d6\",\r\n \"referencetype\": \"Subscription\"\r\n },\r\n {\r\n \"referenceid\": \"95f52ce24a2ca7e1\",\r\n \"referencetype\": \"SubscriptionDiscount\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-12-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Creates 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":"2c0d0b35-70e8-4cb4-9686-4daa552c1065","name":"Create 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 \"invoice\": {\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"b20aada17ffad8f7\",\r\n \"referencetype\": \"Subscription\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-14T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-11-16T23:59:59\",\r\n \"issuedate\": \"2023-11-16T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Dec 2023 10:11:31 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"67577f49b74d0253\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-14T21:11:30.533\",\n \"duedate\": \"2023-12-14T21:11:31.413\",\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 20,\n \"total\": 20,\n \"invoicenumber\": 192,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1Nseu6IGENCfkRK2\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"7b7eae5c-dba6-466f-9e89-5526275b1d2e"},{"name":"Validate Coupon","id":"c7d91670-7280-4b7c-bed1-5af8e8abd993","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SubscriptionPlanID\":\"145e2b8d68c4a0b6\",\r\n \"CouponCode\":\"XMAS23\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/validatecoupon/{{HM_IntegrationAPI_Token}}","urlObject":{"path":["validatecoupon","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"24c9de6e-9e8a-4f28-8f2d-75a05879d1f8","name":"Validate Coupon (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"SubscriptionPlanID\":\"90e8e7e17896333a\",\r\n \"CouponCode\":\"IND50\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/validatecoupon{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Aug 2023 01:05:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": \"Valid\",\n \"Coupon\": {\n \"ID\": \"3de9d6146c5f833b\",\n \"Description\": \"Individual Discount\",\n \"Percentage\": 50,\n \"CodeRequired\": true,\n \"Code\": \"IND50\",\n \"PeriodCycle\": 3,\n \"EndDate\": \"2023-08-19T00:00:00\",\n \"Status\": 1\n }\n}"}],"_postman_id":"c7d91670-7280-4b7c-bed1-5af8e8abd993"},{"name":"Update Invoice","id":"61d5d953-79e4-434f-af9e-00c503c8a78b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"67577f49b74d0253\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-14T23:59:59\",\r\n \"issuedate\": \"2023-12-14T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"amount\": 0,\r\n \"amounttax\": 0,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"b20aada17ffad8f7\",\r\n \"referencetype\": \"Subscription\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Updates 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\".
\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.
\nRequest Notes: BillingDetails
\nPostalCode only is required to run payments for members located in US.
\n**
Response Notes**
On 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":["updateinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6553d78c-7d01-4b0f-9f80-5c670ed57aae","name":"Update Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"eb4efc5cbc9a5b00\",\r\n \"currencycode\": \"USD\",\r\n \"duedate\": \"2024-01-27T23:59:59\",\r\n \"issuedate\": \"2024-01-24T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"amount\": 0,\r\n \"amounttax\": 0,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"07615de0da9a3d50\",\r\n \"referencetype\": \"Subscription\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update usa\",\r\n \"Address2\": \"addr 2 update usa\",\r\n \"City\": \"city update usa\",\r\n \"State\": \"state update usa\",\r\n \"PostalCode\": \"29636\",\r\n \"Country\": \"US\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Jan 2024 06:36:16 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"eb4efc5cbc9a5b00\",\n \"memberaccountid\": \"cd0adf2adba2011c\",\n \"issuedate\": \"2024-01-24T17:36:14.907\",\n \"duedate\": \"2024-01-24T17:36:15.633\",\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 10,\n \"total\": 10,\n \"invoicenumber\": 142,\n \"status\": \"Pending\",\n \"currencycode\": \"USD\"\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_live_51MjXTGINFIsu1VM9JVHrWU3kxWokmJKXrNX7mF7exPdByryYVziz2BnWXBNa8vFPbDVKab5KKbfWtIRAumtgwAWn00juQFO095\",\n \"ConnectedAccountID\": \"acct_1ONSQvITn8N7IvCC\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"61d5d953-79e4-434f-af9e-00c503c8a78b"}],"id":"5fbae50f-3c2b-452a-9900-f376c9037729","description":"AddInvoice is the starting point for subscription checkouts. The response will provide details of the just added invoice as well as,
\nPays a pending state invoice.
\nRequest Elements
\nRequest Notes: Payment
\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":"849bb759-ac45-4406-98fe-13751051b525","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}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"invoicepayment\": {\r\n \"invoiceid\": \"{{HM_ServiceAPI_InvoiceID}}\",\r\n \"amount\": \"{{HM_ServiceAPI_InvoiceTotal}}\",\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-11-16T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Nov 2023 04:06:57 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"f2f337ec56f5c1b1\",\n \"memberaccountid\": \"3a519b04c8a54ab8\",\n \"issuedate\": \"2023-11-16T15:05:08.64\",\n \"duedate\": \"2023-11-16T15:05:08.64\",\n \"totaltax\": 2,\n \"subtotal\": 19.99,\n \"total\": 21.99,\n \"invoicenumber\": 164,\n \"status\": \"Processing\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutdetail\": {\n \"clientsecret\": \"pi_3OCwqyRDQDq9d3Yk0lmKRrfw_secret_ZfsYXGC6Ni4BwtnPKU1qV3INl\",\n \"checkoutconfirmtype\": \"Payment\"\n }\n}"},{"id":"cafcd138-76a8-4275-b0be-d28c62e9836f","name":"Pay Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"\r\n4\n The endpoint is the same, what differs a payment for Free Trial subscriptions is the object response attribute checkoutconfirmtype:
\nWhen = Setup then call stripe.confirmSetup()
\nRequest Elements
\nRequest Notes: Payment
\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":"c8794386-7d67-431c-a3b6-e6b47c4ab148","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}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"invoicepayment\": {\r\n \"invoiceid\": \"{{HM_ServiceAPI_InvoiceID}}\",\r\n \"amount\": \"{{HM_ServiceAPI_InvoiceTotal}}\",\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-11-16T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Nov 2023 04:47:56 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"0e6c504b61e6424d\",\n \"memberaccountid\": \"3a519b04c8a54ab8\",\n \"issuedate\": \"2023-11-16T15:47:47.987\",\n \"duedate\": \"2023-11-16T15:47:47.987\",\n \"totaltax\": 0,\n \"subtotal\": 0,\n \"total\": 0,\n \"invoicenumber\": 168,\n \"status\": \"Processing\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutdetail\": {\n \"clientsecret\": \"seti_1OCxUcRDQDq9d3YkmqMMZakx_secret_P0zTmiYuYSIy634WeVhKy3nU3cEuZiK\",\n \"checkoutconfirmtype\": \"Setup\"\n }\n}"}],"_postman_id":"eacf4e53-7e92-46f8-b1bc-2128ffacbdbf"}],"id":"4be2bf21-5240-4772-8097-65779a086959","description":"After mounting the checkout, validating a promotion code (when applies) and the user is ready to hit \"Subscribe\", StartFragmentcall the API PayInvoice() with a processing status invoice to get the invoice object response back, the clientSecret to securely complete the payment process and the checkoutconfirmtype (= Payment) to call Stripe.confirmPayment.
\nhttps://stripe.com/docs/payments/accept-a-payment-deferred?platform=web&type=subscription
\n","_postman_id":"4be2bf21-5240-4772-8097-65779a086959"},{"name":"Member Active and Expired Subscriptions Page","item":[{"name":"Get Member Details","event":[{"listen":"test","script":{"id":"5a81b195-83be-49dd-949f-ff70baf3a087","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataMemberAccountID = \"\";","var jsonDataMemberGroupID = \"\";","var jsonDataMemberGroupRegionID = \"\";","","if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataMemberAccountID = jsonData.responsemember.member.$.id;"," jsonDataMemberGroupID = jsonData.responsemember.member.$.membergroupid;"," jsonDataMemberGroupRegionID = jsonData.responsemember.member.$.membergroupregionid;","} else {"," jsonData = JSON.parse(responseBody);"," if (jsonData.Member !== null) {"," jsonDataMemberAccountID = jsonData.Member.ID;"," jsonDataMemberGroupID = jsonData.Member.MemberGroupID;"," jsonDataMemberGroupRegionID = jsonData.Member.MemberGroupRegionID;"," }","}","","console.log(\"HM_ServiceAPI_MemberAccountID set to \" + jsonDataMemberAccountID);","console.log(\"HM_ServiceAPI_MemberGroupID set to \" + jsonDataMemberGroupID);","console.log(\"HM_ServiceAPI_MemberGroupRegionID set to \" + jsonDataMemberGroupRegionID);","console.log(postman.getEnvironmentVariable(\"HM_ServiceAPI_MemberTokenIsLoggedMember\"));","","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberAccountID\", jsonDataMemberAccountID);","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberGroupID\", jsonDataMemberGroupID);","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberGroupRegionID\", jsonDataMemberGroupRegionID);","","if (postman.getEnvironmentVariable(\"HM_ServiceAPI_MemberTokenIsLoggedMember\") == \"true\") {"," postman.setNextRequest(\"Get Signle Sign-on Token\");","} else {"," postman.setNextRequest(\"Get Style Groups\");","}","",""],"type":"text/javascript"}}],"id":"82436f24-aed7-4d67-a0c5-f84d1a16bee5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{HM_ServiceAPI_URL}}/getmember/{{HM_ServiceAPI_MemberToken}}","description":"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":"b5816977-18e5-4d23-a09a-9b730ea5ab7b","name":"Get Member Details (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{HM_ServiceAPI_URL}}/getmember/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Aug 2023 05:47:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Member\": {\n \"ID\": \"3a519b04c8a54ab8\",\n \"FirstName\": \"Camila\",\n \"LastName\": \"Silva\",\n \"Email\": \"camila@harvestmedia.net\",\n \"Username\": \"camila@harvestmedia.net\",\n \"TermsAccept\": 0,\n \"DownloadFormat\": \"19b8f5935503adde\",\n \"SearchFormat\": 1,\n \"SearchSort\": 3,\n \"Company\": \"\",\n \"Production\": \"\",\n \"SubProduction\": \"\",\n \"Position\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Suburb\": \"\",\n \"State\": \"\",\n \"Postcode\": \"\",\n \"Country\": \"AU\",\n \"Phone\": \"\",\n \"SampleEnabled\": true,\n \"DownloadEnabled\": true,\n \"DownloadsRemaining\": \"NULL\",\n \"Status\": \"active\",\n \"RegionID\": \"96dba324ca1754fd\",\n \"PasswordType\": \"hmphashed_temporary\",\n \"ServiceInfoURLs\": {\n \"DirectDownloadURL\": \"http://elb-download-beta.harvestmedia.net/assets/downloads/{downloadtoken}\",\n \"TrackStreamURL\": \"https://elb-beta.harvestmedia.net/assets/samples/1faa1f7ec9fda97c20645796e0ddcb156b386b57/{id}\",\n \"ProfileImageURL\": \"https://elb-beta.harvestmedia.net/assets/memberprofile/1faa1f7ec9fda97c20645796e0ddcb156b386b57/3a519b04c8a54ab8/{width}/{height}\",\n \"AlbumMontageSampleURL\": \"https://elb-beta.harvestmedia.net/assets/samples/montage/1faa1f7ec9fda97c20645796e0ddcb156b386b57/{id}\",\n \"AlbumArtURL\": \"https://elb-beta.harvestmedia.net/assets/albumart/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"WaveformURL\": \"https://elb-beta.harvestmedia.net/assets/waveforms/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"MontageWaveformURL\": \"https://elb-beta.harvestmedia.net/assets/waveforms/montage/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"LibraryLogoUrl\": \"https://elb-beta.harvestmedia.net/assets/librarylogo/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"PlaylistArtUrl\": \"https://elb-beta.harvestmedia.net/assets/playlistart/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"PlaylistCategoryArtUrl\": \"https://elb-beta.harvestmedia.net/assets/playlistcategoryart/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"RightHolderProfileUrl\": \"https://elb-beta.harvestmedia.net/assets/rightholderprofile/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"WaveformDataPointUrl\": \"https://elb-beta.harvestmedia.net/assets/waveform_data/1faa1f7ec9fda97c20645796e0ddcb156b386b57/{id}/{dataformat}\",\n \"StyleArtUrl\": \"https://elb-beta.harvestmedia.net/assets/styleart/4602844410e877df7af7e52203e5fc2729cd68a2/{id}/{width}/{height}\",\n \"MemberGroupLogoUrl\": \"https://elb-beta.harvestmedia.net/assets/membergrouplogo/1faa1f7ec9fda97c20645796e0ddcb156b386b57/{id}/{width}/{height}\",\n \"MemberGroupArtUrl\": \"https://elb-beta.harvestmedia.net/assets/membergroupart/1faa1f7ec9fda97c20645796e0ddcb156b386b57/{id}/{width}/{height}\",\n \"MemberGroupProductionArtUrl\": \"https://elb-beta.harvestmedia.net/assets/membergroupproductionart/1faa1f7ec9fda97c20645796e0ddcb156b386b57/{id}/{width}/{height}\"\n },\n \"FileFormats\": [\n {\n \"ID\": \"19b8f5935503adde\"\n },\n {\n \"ID\": \"99dc08a83ff1671e\"\n }\n ],\n \"HasProfileImage\": false,\n \"DownloadEnabledType\": \"MemberGroup\",\n \"DownloadLimit\": \"NULL\",\n \"DownloadsUsed\": \"NULL\",\n \"DownloadStem\": false,\n \"MemberGroups\": [\n {\n \"ID\": \"615c8b956d8b558a\",\n \"Name\": \"Camila Silva - Commercial\",\n \"AssignedRegionID\": \"96dba324ca1754fd\",\n \"AssignedRegionChangeEnabled\": false,\n \"Type\": \"Primary\",\n \"ProductionsCount\": 0,\n \"HasLogoArtWork\": false,\n \"HasArtWork\": false\n }\n ]\n },\n \"MemberSubscription\": {\n \"SubscriptionID\": \"dc15e27d90cd9441\",\n \"Name\": \"Commercial\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 6,\n \"SignUpDate\": \"2023-08-17T15:40:21.14\",\n \"ExpiryDate\": \"2023-09-17T15:40:21.14\",\n \"Status\": \"Active\",\n \"PaymentMethod\": {\n \"FullName\": \"cs-test-card\",\n \"CardNumber\": \"**** **** **** 4242\",\n \"Expiry\": \"12/2025\",\n \"PromoCode\": \"\",\n \"TaxInfo\": \"\"\n },\n \"BillingDetails\": {\n \"FullName\": \"cs-test-card\",\n \"CompanyName\": \"company\",\n \"Address1\": \"addr 1\",\n \"Address2\": \"addr 2\",\n \"City\": \"city\",\n \"State\": \"state\",\n \"PostalCode\": \"postal\",\n \"Country\": \"AU\"\n }\n },\n \"ExpiredSubscriptions\": [\n {\n \"SubscriptionID\": \"a949ea2c90c5a683\",\n \"Name\": \"Individual\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": false,\n \"AllowedTeamMembers\": 0,\n \"SignUpDate\": \"2023-08-17T11:19:06.873\",\n \"ExpiryDate\": \"2023-09-17T11:19:06.873\",\n \"CancellationRequestDate\": \"2023-08-17T15:37:16.097\",\n \"Status\": \"Cancelled\"\n }\n ],\n \"MemberChannels\": []\n}"}],"_postman_id":"82436f24-aed7-4d67-a0c5-f84d1a16bee5"},{"name":"Update Payment Method","id":"7755d25d-b79c-4070-9223-ba5cb06ad437","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"BillingDetails\": {\r\n \"FullName\": \"Camila Change Payment Method\",\r\n \"CompanyName\": \"Test\",\r\n \"Address1\": \"test\",\r\n \"Address2\": \"testt\",\r\n \"City\": \"sao paulo\",\r\n \"State\": \"SP\",\r\n \"PostalCode\": \"12900000\",\r\n \"Country\": \"BR\"\r\n },\r\n \"cardinfo\": {\r\n \"number\": \"8b083425ba9e71a134a6ccfac3434493\",\r\n \"month\": \"99dc08a83ff1671e\",\r\n \"year\": \"fa24bebee2409643\",\r\n \"cvc\": \"813dc7a31b5f6b4e\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatepaymentmethod/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["updatepaymentmethod","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"100547a5-eb2f-4b94-99bc-048f73bde772","name":"Update Payment Method (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"BillingDetails\": {\r\n \"FullName\": \"Camila Change Payment Method\",\r\n \"CompanyName\": \"Test\",\r\n \"Address1\": \"test\",\r\n \"Address2\": \"testt\",\r\n \"City\": \"sao paulo\",\r\n \"State\": \"SP\",\r\n \"PostalCode\": \"12900000\",\r\n \"Country\": \"BR\"\r\n },\r\n \"cardinfo\": {\r\n \"number\": \"8b083425ba9e71a134a6ccfac3434493\",\r\n \"month\": \"99dc08a83ff1671e\",\r\n \"year\": \"fa24bebee2409643\",\r\n \"cvc\": \"813dc7a31b5f6b4e\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatepaymentmethod/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Tue, 15 Aug 2023 08:08:02 GMT","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"\nOK\nUpdates 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”.
\nRequest Notes: Member Channels
\n","urlObject":{"path":["updatemember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"32a6c297-5442-4f69-9870-bf1bb1034eda","name":"Update Member Details","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\":\"{{HM_ServiceAPI_MemberAccountID}}\",\r\n\t\t\"FirstName\":\"First\",\r\n\t\t\"LastName\":\"Last\",\r\n\t\t\"Email\":\"camila@harvestmedia.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\":\"{{HM_ServiceAPI_MemberUsername}}\",\r\n\t \"Password\":\"{{HM_ServiceAPI_MemberPassword}}\",\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\t},\r\n \"Channels\": [\r\n {\r\n \"platform\": \"youtube\",\r\n \"value\": \"youtube.com/cs-youtube-changed\"\r\n },\r\n {\r\n \"platform\": \"facebook\",\r\n \"value\": \"facebook.com/cs-test-new-facebook-changed\"\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/updatemember/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Sep 2023 07:29:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Set-Cookie","value":"AWSALBTG=eHJ12Gnmk7cnEUrqcKclmDf5RhcaYRynO+tpV0D0Q4+emYeH/wxj1i9djpencdCfLJGT/m9uBSl0kMswbuFsWX1QGYB5rL4iUHAGLMT5l1cpm5m/nLgNQA7QQEaiNfpsM+sbYZi+X/DOLorqsr6Kt0jjCGvhOrjH7hSYsJnNMLR/YQEsR70=; Expires=Wed, 13 Sep 2023 07:29:06 GMT; Path=/","enabled":true},{"key":"Set-Cookie","value":"AWSALBTGCORS=eHJ12Gnmk7cnEUrqcKclmDf5RhcaYRynO+tpV0D0Q4+emYeH/wxj1i9djpencdCfLJGT/m9uBSl0kMswbuFsWX1QGYB5rL4iUHAGLMT5l1cpm5m/nLgNQA7QQEaiNfpsM+sbYZi+X/DOLorqsr6Kt0jjCGvhOrjH7hSYsJnNMLR/YQEsR70=; Expires=Wed, 13 Sep 2023 07:29:06 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"MemberAccount\": {\n \"ID\": \"9a007f669be92e14\",\n \"FirstName\": \"First\",\n \"LastName\": \"Last\",\n \"Email\": \"camila@harvestmedia.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\": \"camila@harvestmedia.net\",\n \"TermsAccept\": \"true\",\n \"Subscribe\": \"true\",\n \"FileFormat\": \"19b8f5935503adde\",\n \"SearchFormat\": \"track\",\n \"SearchSort\": \"fav\",\n \"SampleEnabled\": \"true\",\n \"Status\": \"active\",\n \"RegionID\": \"e616f53a01ddd9e3\",\n \"ServiceInfoURLs\": {\n \"DirectDownloadURL\": \"https://cf.harvestmedia.net/assets/downloads/{downloadtoken}\",\n \"TrackStreamURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/ac6373252926edf5e433024cb2571902fc6a8dda/{id}\",\n \"ProfileImageURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/memberprofile/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\",\n \"AlbumMontageSampleURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/montage/ac6373252926edf5e433024cb2571902fc6a8dda/{id}\",\n \"AlbumArtURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/albumart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"WaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"MontageWaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/montage/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"LibraryLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/librarylogo/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"PlaylistArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"PlaylistCategoryArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistcategoryart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"RightHolderProfileUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/rightholderprofile/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"WaveformDataPointUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveform_data/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{dataformat}\",\n \"StyleArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/styleart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"MemberGroupLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergrouplogo/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\",\n \"MemberGroupArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupart/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\",\n \"MemberGroupProductionArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupproductionart/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\"\n },\n \"LanguageCode\": \"EN\",\n \"Salutation\": \"\",\n \"MemberTypeID\": \"\",\n \"FileFormats\": [],\n \"HasProfileImage\": false,\n \"PrivacyAccept\": \"true\",\n \"DownloadEnabled\": \"true\",\n \"DownloadsRemaining\": \"NULL\",\n \"DownloadEnabledType\": \"Member\",\n \"DownloadLimit\": \"NULL\",\n \"DownloadsUsed\": \"NULL\",\n \"DownloadStem\": false\n },\n \"MemberChannels\": [\n {\n \"Platform\": \"Youtube\",\n \"Value\": \"youtube.com/cs-youtube-changed\"\n },\n {\n \"Platform\": \"Facebook\",\n \"Value\": \"facebook.com/cs-test-new-facebook-changed\"\n }\n ]\n}"}],"_postman_id":"9b5be1de-dea4-4ed7-a342-799b8ceae422"}],"id":"fd2c6922-cb3e-4fc3-80ef-a4281802a02c","_postman_id":"fd2c6922-cb3e-4fc3-80ef-a4281802a02c","description":""},{"name":"Member Shopping Cart Page","item":[{"name":"Get Invoice","event":[{"listen":"test","script":{"id":"401a9ee5-4c3e-47de-bd82-db6f0d3edb75","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Pay Invoice\");"],"type":"text/javascript"}}],"id":"15e8b4a9-6e01-4140-ba76-46f71e7ca3b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n \"returnalbums\": true,\r\n\t\"returndiscounts\": false,\r\n \"returnsubscriptions\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":"df865f83-8ed3-478d-9bb9-04b37289a4cb","name":"Get 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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n \"returnalbums\": true,\r\n\t\"returndiscounts\": false,\r\n \"returnsubscriptions\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/10.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Date","value":"Thu, 25 Jan 2024 02:05:19 GMT","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"70365ef81c68245d\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-01-25T12:56:30.663\",\n \"duedate\": \"2024-01-25T12:56:30.81\",\n \"totaltax\": 0,\n \"subtotal\": 41,\n \"total\": 41,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - Telemetry Alert Accept Riser Stereo Communications\",\n \"quantity\": 1,\n \"track\": {\n \"trackid\": \"23bd9bc58e66b9f5c755c3313943a2d2\",\n \"albumid\": \"895034c175b0423c\",\n \"originalfilename\": \"COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav\",\n \"filename\": \"TLT1_001_COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav.wav\",\n \"title\": \"COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav\",\n \"displaytitle\": \"Telemetry Alert Accept Riser Stereo Communications\",\n \"tracknumber\": \"001\",\n \"duration\": 1,\n \"bitrate\": 1,\n \"frequency\": 0,\n \"description\": \"Telemetry Alert Accept Riser Stereo Communications\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n }\n },\n {\n \"amount\": 40,\n \"description\": \"Album Purchase - Telemetry Pack\",\n \"quantity\": 1,\n \"rate\": {\n \"id\": \"ba9387a8592a698e\",\n \"style\": 2,\n \"code\": \"ABM001\",\n \"description\": \"ABM001\",\n \"duration\": 0,\n \"fee\": 40\n },\n \"album\": {\n \"albumid\": \"895034c175b0423c\",\n \"title\": \"Telemetry\",\n \"displaytitle\": \"Telemetry Pack\",\n \"albumcode\": \"\",\n \"cdtitle\": \"Telemetry\",\n \"description\": \"A variety of synthesised Telemetry sounds ranging in pitch, modulation and notation.\"\n }\n }\n ],\n \"invoicenumber\": 54,\n \"status\": \"Pending\",\n \"invoiceproduction\": {\n \"client\": \"camila@harvestmedia.net\",\n \"title\": \"Production Name\",\n \"producer\": \"Producer Name\",\n \"productiondate\": \"2020-01-08T00:00:00\",\n \"length\": \"Total Production Length\",\n \"po\": \"Purchase Order Number\"\n },\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n },\n \"checkoutkeys\": {\n \"ConnectedAccountID\": \"acct_1OGxoVIYSStuzdEx\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"15e8b4a9-6e01-4140-ba76-46f71e7ca3b2"},{"name":"Void Invoice","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Expire Member Token\");"],"type":"text/javascript","id":"94fd20a7-af7f-4630-856c-e195687b4c2e"}}],"id":"1c9757d6-8f4f-4d28-a194-f4a6cde56581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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}}","description":"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":"2dc73517-73fe-4625-87ab-41291440ae25","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"1c9757d6-8f4f-4d28-a194-f4a6cde56581"}],"id":"819b58e5-04ef-4d2a-ba8b-8df5527a3d36","_postman_id":"819b58e5-04ef-4d2a-ba8b-8df5527a3d36","description":""},{"name":"Member Cancel Subscription","item":[{"name":"Cancel Member Subscription","id":"c0bb0dad-2423-43e9-b5ca-f36f94e7867f","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/cancelmembersubscription/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["cancelmembersubscription","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ef41282f-b667-4d44-829a-ecf2d9200f3d","name":"Cancel Member Subscription (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/cancelmembersubscription/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Aug 2023 06:00:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"c0bb0dad-2423-43e9-b5ca-f36f94e7867f"}],"id":"3f196b94-60ed-493b-b108-860f56091093","_postman_id":"3f196b94-60ed-493b-b108-860f56091093","description":""},{"name":"Member Manage Plan Users Page","item":[{"name":"Get Member Group Members","id":"8e2aef77-6726-4b63-9f80-dd86d2e2443c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupmembers/{{HM_ServiceAPI_MemberToken}}","description":"This endpoint returns all the members who's part of the member group for the subscription plan of the logged in member.
\n","urlObject":{"path":["getmembergroupmembers","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8da9185b-1bd9-4e6d-b083-736fcb1baf48","name":"Get Member Group Members (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"url":"{{HM_ServiceAPI_URL}}/getmembergroupmembers/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Aug 2023 06:00:01 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Members\": [\n {\n \"ID\": \"71c50a6bf6b69915\",\n \"MemberGroupID\": \"615c8b956d8b558a\",\n \"MemberAccountID\": \"3f615bda047521e2\",\n \"Username\": \"camila.schevenin@gmail.com\",\n \"FirstName\": \"Camila\",\n \"Surname\": \"Gmail\",\n \"FullName\": \"Camila Gmail\",\n \"Email\": \"camila.schevenin@gmail.com\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"Suburb\": \"\",\n \"State\": \"\",\n \"Country\": \"AU\",\n \"Phone\": \"\",\n \"Status\": \"Active\",\n \"VerifiedEmail\": \"\",\n \"IsOwner\": false\n },\n {\n \"ID\": \"c238b6c4ed75c42f\",\n \"MemberGroupID\": \"615c8b956d8b558a\",\n \"MemberAccountID\": \"3a519b04c8a54ab8\",\n \"Username\": \"camila@harvestmedia.net\",\n \"FirstName\": \"First\",\n \"Surname\": \"Last\",\n \"FullName\": \"First Last\",\n \"Email\": \"camila@harvestmedia.net\",\n \"Address1\": \"Address Line 1\",\n \"Address2\": \"Address Line 2\",\n \"Suburb\": \"Suburb\",\n \"State\": \"State\",\n \"Country\": \"AU\",\n \"Phone\": \"Phone\",\n \"Status\": \"Active\",\n \"VerifiedEmail\": \"\",\n \"IsOwner\": true\n }\n ]\n}"}],"_postman_id":"8e2aef77-6726-4b63-9f80-dd86d2e2443c"},{"name":"Invite Member Subscription","event":[{"listen":"test","script":{"id":"0a513f1c-9154-434c-9899-236e75a70447","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript"}}],"id":"a6f52d4e-c10d-4d71-b50b-66bbafd97aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"email\":\"camila.schevenin+2@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/invitemembersubscription/{{HM_ServiceAPI_MemberToken}}","description":"Invites a user to be part of a team for plans that allows team members.
\nIf the invited user is already registered on Harvest, they will receive a Login welcome email notifying they're now part of the team with a Login link.
\nIn case the invited user is not registered on Harvest, they will receive a Signup welcome email with a registration link notifying they need to finilize registration to be part of the team.
\nUpdates the invitation of a user
\nIn case the invited user is an active member on Harvest it is not possible to revoke the invitation. In this case, the most suitable endpoint is removesubscriptionmember/ to effectivelly remove the member from the team to open up room to a new invitation.
\nIn case the invited user is NOT an active member on Harvest, then it is possible to revoke the invitation via updatememberinvitation/ passing the invited memberaccountID (returned by getmembergroupmembers/) along with the email address of the new user to be invited.
\nDeletes an active member from the team informing the memberGroupID and the memberAccountID (both returned by getmembergroupmembers/) from the member to be removed.
\n","urlObject":{"path":["removesubscriptionmember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"12689bbf-d43f-4ea3-a492-2b1efd0732a5","name":"Remove Subscription 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 \"MemberGroupID\":\"3ee3c00341ce20f3\",\r\n \"MemberAccountID\":\"4dbb7f92a86867a2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/removesubscriptionmember/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 26 Oct 2023 05:19:00 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"}],"_postman_id":"03b84231-f53e-4828-a849-4d5e061366f1"},{"name":"Add Checkout Session","event":[{"listen":"test","script":{"id":"0a513f1c-9154-434c-9899-236e75a70447","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript","packages":{}}}],"id":"6ae870d7-5889-4ebb-8af6-6bbdc458ad3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL_Local}}/addcheckoutsession/{{HM_ServiceAPI_MemberToken}}","description":"Return all keys needed to load a checkout session using Stripe components:
\nStripe API Key
\nStripe Connected Account ID
\nClientSecret
\nRefer to following documentation to learn how to load a checkout session with the keys provided: https://docs.stripe.com/payments/checkout/subscriptions/update-payment-details
\n","urlObject":{"path":["addcheckoutsession","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL_Local}}"],"query":[],"variable":[]}},"response":[{"id":"7a03680f-57f7-4d22-9a65-01469c2f3b63","name":"Add Checkout Session (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}}/addcheckoutsession/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 03 May 2024 07:30:11 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_live_51MjXTGINFIsu1VM9JVHrWU3kxWokmJKXrNX7mF7exPdByryYVziz2BnWXBNa8vFPbDVKab5KKbfWtIRAumtgwAWn00juQFO095\",\n \"ConnectedAccountID\": \"acct_1NstsnREHvfJoFKj\",\n \"AccountCurrency\": \"USD\"\n },\n \"checkoutdetail\": {\n \"clientsecret\": \"cs_live_c1nobuMsAxXUzd7qOFGDpJ0k9jAjTVI80AfXNdCyroJeyJdcJfHVhprImz_secret_fidwbEhqYWAnPydgaGdgYWFgYScpJ2lkfGpwcVF8dWAnPyd2bGtiaWBaZmppcGhrJyknd2BhbHdgZnFKa0ZqaHVpYHFsamsnPydrYHNgdyd4JSUl\",\n \"checkoutconfirmtype\": \"Setup\"\n }\n}"}],"_postman_id":"6ae870d7-5889-4ebb-8af6-6bbdc458ad3d"}],"id":"7393328b-3ab6-4d1f-b0f4-9ac6840a91bb","description":"This section provides endpoints to manage the group members of the subscription plan owner.
\nAn invited member will receive a link with either,
\nFor registrations scenarios that requires a user to continue their registration process, use the following update member endpoint with the memberaccountid received by the email URL route sending the status of the new member as \"Active\".
\n","_postman_id":"c14892f7-09ec-43ac-b160-a03f1e23207b"},{"name":"Member All Orders Page","item":[{"name":"Search Invoice","event":[{"listen":"test","script":{"id":"0a513f1c-9154-434c-9899-236e75a70447","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript"}}],"id":"e5e532ed-1362-430a-ace7-2d7a082f73f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"fromamount\":0,\r\n\t\"fromdate\":\"2023-01-01T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2024-03-16T22:19:27.95\",\r\n\t\"limit\":10,\r\n\t\"skip\":0,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"\",\r\n \"Status\": \"Pending\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}","description":"Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["searchinvoices","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f1842ce9-7f42-4a47-9dbe-634a88955513","name":"Search 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\"fromamount\":0,\r\n\t\"fromdate\":\"2022-01-01T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2024-03-16T22:19:27.95\",\r\n\t\"limit\":2,\r\n\t\"skip\":0,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"Subscription\",\r\n \"Status\": \"\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 10:07:23 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoices\": [\n {\n \"id\": \"c6046f703d69aadb\",\n \"memberaccountid\": \"3ba56309c1506b53\",\n \"issuedate\": \"2024-02-14T18:20:43.17\",\n \"duedate\": \"2024-02-14T18:20:43.58\",\n \"UTCOffset\": 11,\n \"totaltax\": 0,\n \"subtotal\": 1,\n \"total\": 1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Member Subscription - Company (Monthly)\",\n \"quantity\": 1,\n \"amounttax\": 0,\n \"subscription\": {\n \"id\": \"5a2f797f4a3d59a5\",\n \"planname\": \"Company\",\n \"period\": \"Monthly\",\n \"downloadlimit\": \"Unlimited\",\n \"allowteam\": true,\n \"teammembers\": 4,\n \"channellimitsetting\": \"Unlimited\"\n }\n }\n ],\n \"invoicenumber\": 428,\n \"paidamount\": 0,\n \"status\": \"Pending\",\n \"membername\": \"Company - First Last (camila+1@harvestmedia.net)\",\n \"currencycode\": \"USD\",\n \"billingdetails\": {\n \"FullName\": \"Camila Schevenin da Silva\",\n \"CompanyName\": \"Harvest\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"GU16 7HF\",\n \"Country\": \"AU\"\n }\n },\n {\n \"id\": \"05e60ee0f23c38ce\",\n \"memberaccountid\": \"3ba56309c1506b53\",\n \"issuedate\": \"2024-02-13T19:20:45.33\",\n \"duedate\": \"2024-02-13T19:20:46.05\",\n \"UTCOffset\": 11,\n \"totaltax\": 0,\n \"subtotal\": 1,\n \"total\": 1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Member Subscription - Company (Monthly)\",\n \"quantity\": 1,\n \"amounttax\": 0,\n \"subscription\": {\n \"id\": \"5a2f797f4a3d59a5\",\n \"planname\": \"Company\",\n \"period\": \"Monthly\",\n \"downloadlimit\": \"Unlimited\",\n \"allowteam\": true,\n \"teammembers\": 4,\n \"channellimitsetting\": \"Unlimited\"\n }\n }\n ],\n \"invoicenumber\": 417,\n \"paidamount\": 0,\n \"status\": \"Pending\",\n \"membername\": \"Company - First Last (camila+1@harvestmedia.net)\",\n \"currencycode\": \"USD\",\n \"billingdetails\": {\n \"FullName\": \"Camila Schevenin da Silva\",\n \"CompanyName\": \"Harvest\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"2017\",\n \"Country\": \"AU\"\n }\n }\n ],\n \"total\": 2\n}"}],"_postman_id":"e5e532ed-1362-430a-ace7-2d7a082f73f2"},{"name":"Get Invoice Download URL","event":[{"listen":"test","script":{"id":"0a513f1c-9154-434c-9899-236e75a70447","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript"}}],"id":"cf75a66c-b9a3-4156-8e7a-0d07580d553b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getinvoicedownloadurl/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_InvoiceID}}","description":"Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getinvoicedownloadurl","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_InvoiceID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6b95f751-89c5-4c00-8490-97eb04092153","name":"Get Invoice Download URL","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}}/getinvoicedownloadurl/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_InvoiceID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Feb 2024 05:34:09 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Url\": \"https://d2zsljmk3mm9kv.cloudfront.net/CDN/downloads/invoices/e072a9105fd2f362/bd394687-3f7f-4c09-80e6-56a9393f6202/CAMILA_SCHEVENIN DA SILVA_HTN-INV137.pdf\"\n}"}],"_postman_id":"cf75a66c-b9a3-4156-8e7a-0d07580d553b"}],"id":"facaac6a-14d5-4338-8d06-d75acf6c3c03","_postman_id":"facaac6a-14d5-4338-8d06-d75acf6c3c03","description":""},{"name":"Enterprise","item":[{"name":"Authenticate Member, Generate Persistent Member Token & Check Pending Invoices","event":[{"listen":"test","script":{"id":"96bedff0-63bb-453c-a378-e0f65ab429a7","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataToken = \"\";","var jsonDataPersistentToken = \"\";","","var jsonInvoiceData = null;","var jsonDataInvoiceID = \"\";","var jsonDataInvoiceTotal = \"\";","","if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataToken = jsonData.responsemembertoken.membertoken.$.value;"," jsonDataPersistentToken = jsonData.responsemembertoken.persistentlogintoken.$.token;",""," jsonInvoiceData = jsonData.invoices"," jsonDataInvoiceID = jsonInvoiceData.id;"," jsonDataInvoiceTotal = jsonInvoiceData.total;","} else {"," jsonData = JSON.parse(responseBody)"," jsonDataToken = jsonData.MemberToken.Value;"," jsonDataPersistentToken = jsonData.PersistentLoginToken.Token;",""," jsonInvoiceData = jsonData.Invoices[0];"," jsonDataInvoiceID = jsonInvoiceData.id;"," jsonDataInvoiceTotal = jsonInvoiceData.total;","}","","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberToken\", jsonDataToken);","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberPersistentToken\", jsonDataPersistentToken);","postman.setEnvironmentVariable(\"HM_ServiceAPI_MemberTokenIsLoggedMember\", \"true\");","postman.setEnvironmentVariable(\"HM_ServiceAPI_EnterpriseInvoiceID\", jsonDataInvoiceID);","postman.setEnvironmentVariable(\"HM_ServiceAPI_EnterpriseInvoiceTotal\", jsonDataInvoiceTotal);","","","console.log(\"HM_ServiceAPI_MemberToken set to \" + jsonDataToken);","console.log(\"HM_ServiceAPI_MemberPersistentToken set to \" + jsonDataPersistentToken);","console.log(\"HM_ServiceAPI_MemberTokenIsLoggedMember set to true\");","","console.log(\"HM_ServiceAPI_EnterpriseInvoiceID set to \" + jsonDataInvoiceID);","console.log(\"HM_ServiceAPI_EnterpriseInvoiceTotal set to \" + jsonDataInvoiceTotal);","","postman.setNextRequest(\"Get Member Details\");",""],"type":"text/javascript"}}],"id":"b74c0dfd-6331-4a0f-9f87-dfa33836b5f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_MemberUsername}}\",\r\n\t\"Password\":\"{{HM_ServiceAPI_MemberPassword}}\",\r\n\t\"PersistentLogin\":true,\r\n\t\"ReturnMemberDetails\":false,\r\n \"ReturnMemberSubscriptionDetails\":true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmembertoken/{{HM_IntegrationAPI_Token}}","description":"The following method should be used for member login.
\nIt will return a member token as well as a persistent login token if if requested by passing 'true' to <persistentlogin> element in the request body.
The persistent login token can be saved to member's cookie for reuse in future site accesses.
\nRequest Elements
\n","urlObject":{"path":["getmembertoken","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3ec1da7f-0c87-4f85-99c2-955f71e35816","name":"Authenticate Member, Generate Persistent Member Token & Check Pending Invoices (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\":\"{{HM_ServiceAPI_MemberUsername}}\",\r\n\t\"Password\":\"{{HM_ServiceAPI_MemberPassword}}\",\r\n\t\"PersistentLogin\":true,\r\n\t\"ReturnMemberDetails\":false,\r\n \"ReturnMemberSubscriptionDetails\":true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getmembertoken/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Oct 2023 00:07:12 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"MemberToken\": {\n \"Value\": \"a00054fce9fcf8f89cd3c3bc145bd287\",\n \"Expiry\": \"2023-10-28T11:07:12.443\",\n \"UTCOffset\": 11,\n \"Type\": \"MemberToken\",\n \"IsOfSingleUse\": false\n },\n \"PersistentLoginToken\": {\n \"Token\": \"b1d5b183a1304fb883d11359ec71a72c\",\n \"Expiry\": \"2024-01-25T11:07:12.477\",\n \"UTCOffset\": 11\n },\n \"MemberAccount\": {\n \"HasProfileImage\": false,\n \"DownloadEnabledType\": \"Member\"\n },\n \"ExpiredSubscriptions\": [\n {\n \"SubscriptionID\": \"f005ea25ae1dd914\",\n \"Name\": \"Individual\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": false,\n \"AllowedTeamMembers\": 0,\n \"SignUpDate\": \"2023-10-23T17:09:04.337\",\n \"ExpiryDate\": \"2023-11-23T17:09:04.337\",\n \"CancellationRequestDate\": \"2023-10-23T18:18:53.427\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"\"\n },\n {\n \"SubscriptionID\": \"f005ea25ae1dd914\",\n \"Name\": \"Individual\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": false,\n \"AllowedTeamMembers\": 0,\n \"SignUpDate\": \"2023-10-23T18:19:46.707\",\n \"ExpiryDate\": \"2023-11-23T18:19:46.707\",\n \"CancellationRequestDate\": \"2023-10-23T20:57:30.517\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-24T09:48:12.5\",\n \"ExpiryDate\": \"2023-11-24T09:48:12.5\",\n \"CancellationRequestDate\": \"2023-10-24T10:10:40.677\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-24T10:11:35.973\",\n \"ExpiryDate\": \"2023-11-24T10:11:35.973\",\n \"CancellationRequestDate\": \"2023-10-24T14:52:45.463\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-24T14:53:06.143\",\n \"ExpiryDate\": \"2023-11-24T14:53:06.143\",\n \"CancellationRequestDate\": \"2023-10-24T17:25:58.117\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"Cancelled by member\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-24T17:26:25.337\",\n \"ExpiryDate\": \"2023-11-24T17:26:25.337\",\n \"CancellationRequestDate\": \"2023-10-26T10:46:24.003\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"Cancelled by admin\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-26T10:55:28.58\",\n \"ExpiryDate\": \"2023-11-26T10:55:28.58\",\n \"CancellationRequestDate\": \"2023-10-26T12:12:30.487\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"Cancelled by admin\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-26T14:41:18.283\",\n \"ExpiryDate\": \"2023-11-26T14:41:18.283\",\n \"CancellationRequestDate\": \"2023-10-26T15:55:14.84\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"Cancelled by admin\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-26T15:56:09.86\",\n \"ExpiryDate\": \"2023-11-26T15:56:09.86\",\n \"CancellationRequestDate\": \"2023-10-26T16:12:44.153\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"Cancelled by member\"\n },\n {\n \"SubscriptionID\": \"75dede2132980b59\",\n \"Name\": \"Teams\",\n \"Period\": \"Monthly\",\n \"Description\": \"\",\n \"IsFeatured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"Channels\": \"\",\n \"DownloadLimit\": \"Unlimited\",\n \"AllowTeam\": true,\n \"AllowedTeamMembers\": 2,\n \"SignUpDate\": \"2023-10-26T16:13:11.627\",\n \"ExpiryDate\": \"2023-11-26T16:13:11.627\",\n \"CancellationRequestDate\": \"2023-10-27T10:00:43.36\",\n \"Status\": \"Cancelled\",\n \"CancellationReason\": \"Cancelled by admin\"\n }\n ],\n \"Invoices\": [\n {\n \"id\": \"beca679179f5b090\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-10-24T09:41:19.48\",\n \"duedate\": \"2023-10-24T09:41:19.48\",\n \"totaltax\": 1.5,\n \"subtotal\": 15,\n \"total\": 16.5,\n \"invoicelineitems\": [\n {\n \"amount\": 15,\n \"description\": \"Member Subscription - Individual (Monthly)\",\n \"quantity\": 1,\n \"amounttax\": 1.5,\n \"subscription\": {\n \"id\": \"f005ea25ae1dd914\",\n \"planname\": \"Individual\",\n \"period\": \"Monthly\",\n \"downloadlimit\": \"Unlimited\",\n \"allowteam\": false,\n \"teammembers\": 0,\n \"channellimitsetting\": \"Disabled\"\n }\n }\n ],\n \"invoicenumber\": 115,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"cs-test-card\",\n \"CompanyName\": \"company\",\n \"Address1\": \"addr 1\",\n \"Address2\": \"addr 2\",\n \"City\": \"city\",\n \"State\": \"state\",\n \"PostalCode\": \"postal\",\n \"Country\": \"AU\"\n }\n },\n {\n \"id\": \"9c444d40e76a3522\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-10-27T10:01:07.803\",\n \"duedate\": \"2023-11-03T10:01:07.803\",\n \"totaltax\": 1,\n \"subtotal\": 9.99,\n \"total\": 10.99,\n \"invoicelineitems\": [\n {\n \"amount\": 9.99,\n \"description\": \"Group (Monthlhy)\",\n \"quantity\": 1,\n \"amounttax\": 1,\n \"subscription\": {\n \"id\": \"7907138b683424f4\",\n \"planname\": \"Group\",\n \"period\": \"Monthly\",\n \"downloadlimit\": \"Unlimited\",\n \"allowteam\": true,\n \"teammembers\": 2,\n \"channellimitsetting\": \"Disabled\"\n }\n }\n ],\n \"invoicenumber\": 126,\n \"status\": \"Pending\",\n \"currencycode\": \"\",\n \"billingdetails\": {\n \"FullName\": \"Camila Schevenin\",\n \"CompanyName\": \"harvest\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"AU\"\n }\n }\n ],\n \"MemberChannels\": []\n}"}],"_postman_id":"b74c0dfd-6331-4a0f-9f87-dfa33836b5f1"},{"name":"Pay Invoice","event":[{"listen":"test","script":{"id":"daa1a982-c9f6-47a9-a621-51b142d6ae5f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Search Invoice\");"],"type":"text/javascript"}}],"id":"d671bbed-a313-493d-be61-f3ba6504c5b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoicepayment\": {\r\n \"invoiceid\": \"{{HM_ServiceAPI_InvoiceID}}\",\r\n \"amount\": \"{{HM_ServiceAPI_InvoiceTotal}}\",\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-10-27T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Paid\",\r\n \"cardinfo\": {\r\n \"number\": \"5555555555554444\",\r\n \"month\": \"10\",\r\n \"year\": \"2027\",\r\n \"cvc\": \"123\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":"bbb1f585-c72d-4c07-a765-a00f8f637306","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 \"invoicepayment\": {\r\n \"invoiceid\": \"{{HM_ServiceAPI_InvoiceID}}\",\r\n \"amount\": \"{{HM_ServiceAPI_InvoiceTotal}}\",\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-10-27T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Paid\",\r\n \"cardinfo\": {\r\n \"number\": \"5555555555554444\",\r\n \"month\": \"10\",\r\n \"year\": \"2027\",\r\n \"cvc\": \"123\"\r\n }\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Oct 2023 00:07:42 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"beca679179f5b090\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-10-24T09:41:19.48\",\n \"duedate\": \"2023-10-24T09:41:19.48\",\n \"totaltax\": 1.5,\n \"subtotal\": 15,\n \"total\": 16.5,\n \"invoicenumber\": 115,\n \"status\": \"Paid\",\n \"currencycode\": \"AUD\"\n }\n}"}],"_postman_id":"d671bbed-a313-493d-be61-f3ba6504c5b7"},{"name":"Update Member Details","event":[{"listen":"test","script":{"id":"db08cb3a-d0e9-471c-9df7-fe14c569fb7d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Update Member Details (MT)\");"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"ab8a07bc-ff4a-4233-b418-2859e84cde11","exec":["var newUsername = postman.getEnvironmentVariable(\"HM_ServiceAPI_Token\") + \"-user-u\";","","postman.setEnvironmentVariable(\"HM_ServiceAPI_NewMemberUsername\", newUsername);"],"type":"text/javascript"}}],"id":"130e387a-da9e-4078-9ec1-dc6340eac903","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"MemberAccount\": {\r\n \"ID\": \"{{HM_ServiceAPI_MemberAccountID}}\",\r\n \"FirstName\": \"First\",\r\n \"LastName\": \"Last\",\r\n \"Email\": \"{{HM_ServiceAPI_MemberUsername}}\",\r\n \"Company\": \"Company\",\r\n \"Production\": \"Production\",\r\n \"SubProduction\": \"Sub Production\",\r\n \"Position\": \"Position\",\r\n \"Address1\": \"Address Line 1\",\r\n \"Address2\": \"Address Line 2\",\r\n \"Suburb\": \"Suburb\",\r\n \"State\": \"State\",\r\n \"Postcode\": \"1234\",\r\n \"Country\": \"AU\",\r\n \"Phone\": \"Phone\",\r\n \"TermsAccept\": \"true\",\r\n \"UserName\": \"{{HM_ServiceAPI_MemberUsername}}\",\r\n \"Password\": \"{{HM_ServiceAPI_MemberPassword}}\",\r\n \"PrivacyAccept\": \"true\",\r\n \"Subscribe\": \"true\",\r\n \"FileFormat\": \"mp3\",\r\n \"SearchFormat\": \"Track\",\r\n \"SearchSort\": \"New\",\r\n \"Status\": \"Active\"\r\n },\r\n \"Channels\": []\r\n}"},"url":"{{HM_ServiceAPI_URL}}/updatemember/{{HM_IntegrationAPI_Token}}","description":"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”.
\nRequest Notes: Member Channels
\n","urlObject":{"path":["updatemember","{{HM_IntegrationAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"753ce7da-5cee-4bab-befa-8363614b442b","name":"Update Member Details (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\":\"3a5fo20b4827354281\",\r\n\t\t\"FirstName\":\"First\",\r\n\t\t\"LastName\":\"Last\",\r\n\t\t\"Email\":\"email@domain.com\",\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\":\"1234\",\r\n\t\t\"Country\":\"AU\",\r\n\t\t\"Phone\":\"Phone\",\r\n\t\t\"TermsAccept\":\"true\",\r\n \"UserName\":\"email@domain.com\",\r\n\t \"Password\":\"Password\",\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 \"Status\": \"Active\"\r\n\t},\r\n \"Channels\": [\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updatemember/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Oct 2023 04:14:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"MemberAccount\": {\n \"ID\": \"3a5fo20b4827354281\",\n \"FirstName\": \"First\",\n \"LastName\": \"Last\",\n \"Email\": \"email@domain.com\",\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\": \"1234\",\n \"Country\": \"AU\",\n \"Phone\": \"Phone\",\n \"Username\": \"email@domain.com\",\n \"TermsAccept\": \"true\",\n \"Subscribe\": \"true\",\n \"FileFormat\": \"19b8f591355e02afde\",\n \"SearchFormat\": \"track\",\n \"SearchSort\": \"fav\",\n \"SampleEnabled\": \"true\",\n \"Status\": \"active\",\n \"RegionID\": \"88f83791e713cf07d1\",\n \"ServiceInfoURLs\": {},\n \"LanguageCode\": \"\",\n \"Salutation\": \"\",\n \"MemberTypeID\": \"\",\n \"FileFormats\": [],\n \"HasProfileImage\": false,\n \"PrivacyAccept\": \"true\",\n \"DownloadEnabled\": \"true\",\n \"DownloadsRemaining\": \"NULL\",\n \"DownloadEnabledType\": \"MemberGroup\",\n \"DownloadLimit\": \"NULL\",\n \"DownloadsUsed\": \"NULL\",\n \"DownloadStem\": false,\n \"MemberGroups\": [\n {\n \"ID\": \"32e3c00341acfe20f3\",\n \"Name\": \"No Price\",\n \"AssignedRegionID\": \"88f83791e713cf07d1\",\n \"AssignedRegionChangeEnabled\": false,\n \"Type\": \"Primary\",\n \"ProductionsCount\": 0,\n \"HasLogoArtWork\": false,\n \"HasArtWork\": false\n }\n ]\n },\n \"MemberChannels\": []\n}"}],"_postman_id":"130e387a-da9e-4078-9ec1-dc6340eac903"}],"id":"2477bfcf-0562-47f4-87e5-3b2d6c3a98fb","description":"Enterprise users will be subscribed via Admin and there are 2 different ways for payment management:
\nPayment managed by Harvest, meaning Harvest is responsible to run payment charges every billing cycle
\nPayment managed by the Client, meaning we're not involved/responsible for the charges or control payment invoices; the member has the capability to make use of their plan right away.
\nAfter completing payment via payinvoice/, the user can be redirect to their profile page to input white listing channels, as shown on updatememberdetails/, following the rules for channels as their plan allows to.
\n","_postman_id":"2477bfcf-0562-47f4-87e5-3b2d6c3a98fb"},{"name":"Upgrade Subscription","item":[{"name":"Get Subscription Plans for Upgrade","event":[{"listen":"test","script":{"id":"fd3c666b-341a-4d94-81a8-3702fd2d8abe","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;\r","\r",""],"type":"text/javascript"}}],"id":"1ec984b9-0eef-46c4-8cbd-99eededf25a9","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getsubscriptionplans/{{HM_ServiceAPI_MemberToken}}","description":"Request Elements
\n","urlObject":{"path":["getsubscriptionplans","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cebb8b6e-35b8-4a84-bfd6-28d283e76f38","name":"Get Subscription Plans (JSON)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"url":"{{HM_ServiceAPI_URL}}/getsubscriptionplans/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Nov 2023 23:09:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"SubscriptionPlans\": [\n {\n \"ID\": \"272f1d66c82967de\",\n \"Name\": \"Individual\",\n \"Description\": \"Individual plan for single user\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-09-04T13:25:52\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"272f1d66c82967de\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"e5153b3e6e5ba804\",\n \"Price\": 24.99,\n \"StartDate\": \"2023-11-23T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n },\n {\n \"ID\": \"4d3ddcd6da8eed45\",\n \"Name\": \"Enterprise\",\n \"Description\": \"Please contact us for pricing\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Unlimited\",\n \"AllowTeam\": true,\n \"TeamMembers\": 15,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-09-04T13:26:30\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": true,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": []\n },\n {\n \"ID\": \"9e4d309244851779\",\n \"Name\": \"Free-trial\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-10-10T11:13:04\",\n \"HasFreeTrial\": true,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"19ecbe6bedcfa645\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"19ecbe6bedcfa645\",\n \"Price\": 5,\n \"StartDate\": \"2023-10-10T00:00:00\",\n \"Status\": 1\n }\n ],\n \"FreeTrial\": {\n \"ID\": \"5a2f797f4a3d59a5\",\n \"Period\": \"Trial\",\n \"PeriodDays\": 14,\n \"TrialDownloadLimit\": 20,\n \"RolloverSubscriptionID\": \"19ecbe6bedcfa645\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": []\n }\n }\n ]\n },\n {\n \"ID\": \"0dabdb1ee6f7b545\",\n \"Name\": \"AllowTeam\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": true,\n \"TeamMembers\": 2,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-10-10T14:11:35\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"bce3cac31bcb8576\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"5a2f797f4a3d59a5\",\n \"Price\": 20,\n \"StartDate\": \"2023-10-10T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n },\n {\n \"ID\": \"f4df85b9b479ca70\",\n \"Name\": \"Daily\",\n \"Description\": \"Test for daily invoice check\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": true,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-10-24T17:35:11\",\n \"HasFreeTrial\": true,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [\n {\n \"ID\": \"d0b8ba29471595bf\",\n \"Description\": \"Test\",\n \"OrderID\": 0,\n \"IsHeader\": true,\n \"Status\": \"Active\"\n },\n {\n \"ID\": \"19b8f5935503adde\",\n \"Description\": \"Feature 1\",\n \"OrderID\": 1,\n \"IsHeader\": false,\n \"Status\": \"Active\"\n }\n ],\n \"Subscriptions\": [\n {\n \"ID\": \"0dabdb1ee6f7b545\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"9e4d309244851779\",\n \"Price\": 5,\n \"StartDate\": \"2023-10-24T00:00:00\",\n \"Status\": 1\n }\n ],\n \"FreeTrial\": {\n \"ID\": \"82193ff640dd7d69\",\n \"Period\": \"Trial\",\n \"PeriodDays\": 1,\n \"TrialDownloadLimit\": 20,\n \"RolloverSubscriptionID\": \"0dabdb1ee6f7b545\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": []\n }\n }\n ]\n },\n {\n \"ID\": \"96f153356899e5c5\",\n \"Name\": \"Individual Upgrade\",\n \"Description\": \"\",\n \"Status\": \"Active\",\n \"Featured\": true,\n \"AllowBadges\": false,\n \"BadgeDisplayTitle\": \"\",\n \"PlatformHandleType\": \"Disabled\",\n \"AllowTeam\": false,\n \"TeamMembers\": 0,\n \"DownloadLimit\": \"Unlimited\",\n \"DateCreated\": \"2023-11-28T16:02:30\",\n \"HasFreeTrial\": false,\n \"RequestQuote\": false,\n \"SubscriptionInclusions\": [],\n \"Subscriptions\": [\n {\n \"ID\": \"733cf072013be8c4\",\n \"Period\": \"Monthly\",\n \"PeriodDays\": 0,\n \"TrialDownloadLimit\": 0,\n \"RolloverSubscriptionID\": \"\",\n \"Status\": \"Active\",\n \"SubscriptionPrices\": [\n {\n \"ID\": \"3b7e990361490e50\",\n \"Price\": 38,\n \"StartDate\": \"2023-11-28T00:00:00\",\n \"Status\": 1\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"1ec984b9-0eef-46c4-8cbd-99eededf25a9"},{"name":"Create Invoice For Upgrade","event":[{"listen":"test","script":{"id":"07931462-9b4b-4220-bf48-fe6cb6749f7e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataInvoiceID = \"\";","var jsonDataInvoiceTotal = \"\";","","if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataInvoiceID = jsonData.responseinvoice.invoice.id;"," jsonDataInvoiceTotal = jsonData.responseinvoice.invoice.total;","} else {"," jsonData = JSON.parse(responseBody)"," if (jsonData.invoice !== null) {"," jsonDataInvoiceID = jsonData.invoice.id;"," jsonDataInvoiceTotal = jsonData.invoice.total;"," }","}","","console.log(\"HM_ServiceAPI_InvoiceID set to \" + jsonDataInvoiceID);","","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceID\", jsonDataInvoiceID);","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceTotal\", jsonDataInvoiceTotal);","","postman.setNextRequest(\"Get Invoice\");"],"type":"text/javascript"}}],"id":"32234d6f-ef95-41f0-9908-0151f1f063ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoice\": {\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"fdf24422bf73526e\",\r\n \"referencetype\": \"Subscription\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB-UPGRADE\",\r\n \"productiondate\": \"2023-08-14T00:00:00\",\r\n \"producer\": \"CS TEST SUB UPGRADE\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB UPGRADE\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-11-30T23:59:59\",\r\n \"issuedate\": \"2023-11-30T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Invoices for upgrade will return a total with the proration calculation based on the usage of the current plan.
\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":"94c1069c-18ef-4717-953d-ad5e53f7b1b7","name":"Create Invoice For Upgrade (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 \"invoice\": {\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"bce3cac31bcb8576\",\r\n \"referencetype\": \"Subscription\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"{{email}}\",\r\n \"title\": \"{{title}}\",\r\n \"productiondate\": \"2024-03-15T00:00:00\",\r\n \"producer\": \"{{producer}}\",\r\n \"length\": \"\",\r\n \"po\": \"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2024-03-16T23:59:59\",\r\n \"issuedate\": \"2024-03-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2024 06:07:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"5e22da4e25ad0058\",\n \"memberaccountid\": \"4b6904ca95e109a0\",\n \"issuedate\": \"2024-03-15T17:07:25.693\",\n \"duedate\": \"2024-03-15T17:07:26.243\",\n \"UTCOffset\": 11,\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 538.89,\n \"total\": 538.89,\n \"invoicenumber\": 692,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"FullName\",\n \"CompanyName\": \"CompanyName\",\n \"Address1\": \"Address1\",\n \"Address2\": \"Address2\",\n \"City\": \"City\",\n \"State\": \"State\",\n \"PostalCode\": \"Postalcode\",\n \"Country\": \"AU\"\n }\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_live_StripeKey\",\n \"ConnectedAccountID\": \"acct_StripeAccountID\",\n \"AccountCurrency\": \"USD\"\n }\n}"}],"_postman_id":"32234d6f-ef95-41f0-9908-0151f1f063ff"},{"name":"Update Invoice","id":"fd5bc7fd-9f34-4f83-a098-4e0663ce56a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"67577f49b74d0253\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-14T23:59:59\",\r\n \"issuedate\": \"2023-12-14T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"amount\": 0,\r\n \"amounttax\": 0,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"b20aada17ffad8f7\",\r\n \"referencetype\": \"Subscription\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Updates 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\".
\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.
\nRequest Notes: BillingDetails
\nPostalCode only is required to run payments for members located in US.
\n**
Response Notes**
On 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":["updateinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"59281048-29e2-4e3e-b014-f7de692ae3b8","name":"Update Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"eb4efc5cbc9a5b00\",\r\n \"currencycode\": \"USD\",\r\n \"duedate\": \"2024-01-27T23:59:59\",\r\n \"issuedate\": \"2024-01-24T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"amount\": 0,\r\n \"amounttax\": 0,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"07615de0da9a3d50\",\r\n \"referencetype\": \"Subscription\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update usa\",\r\n \"Address2\": \"addr 2 update usa\",\r\n \"City\": \"city update usa\",\r\n \"State\": \"state update usa\",\r\n \"PostalCode\": \"29636\",\r\n \"Country\": \"US\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Jan 2024 06:36:16 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"eb4efc5cbc9a5b00\",\n \"memberaccountid\": \"cd0adf2adba2011c\",\n \"issuedate\": \"2024-01-24T17:36:14.907\",\n \"duedate\": \"2024-01-24T17:36:15.633\",\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 10,\n \"total\": 10,\n \"invoicenumber\": 142,\n \"status\": \"Pending\",\n \"currencycode\": \"USD\"\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_live_51MjXTGINFIsu1VM9JVHrWU3kxWokmJKXrNX7mF7exPdByryYVziz2BnWXBNa8vFPbDVKab5KKbfWtIRAumtgwAWn00juQFO095\",\n \"ConnectedAccountID\": \"acct_1ONSQvITn8N7IvCC\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"fd5bc7fd-9f34-4f83-a098-4e0663ce56a3"},{"name":"Pay Invoice For Upgrade","event":[{"listen":"test","script":{"id":"daa1a982-c9f6-47a9-a621-51b142d6ae5f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Search Invoice\");"],"type":"text/javascript"}}],"id":"172c3890-d609-4df5-abd0-959e91a5ec61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoicepayment\": {\r\n \"invoiceid\": \"c6f3f00a38f5a659\",\r\n \"amount\": 69.97,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-11-30T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Pays a pending state invoice.
\nRequest Elements
\nRequest Notes: Payment
\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":"4ae8f9a3-da92-4e60-80c6-d3cfcc1378d7","name":"Pay Invoice For Upgrade (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"invoicepayment\": {\r\n \"invoiceid\": \"cb27f427373f0935\",\r\n \"amount\": 18.44,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-11-30T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Nov 2023 23:22:22 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"cb27f427373f0935\",\n \"memberaccountid\": \"3a519b04c8a54ab8\",\n \"issuedate\": \"2023-11-30T10:21:32.703\",\n \"duedate\": \"2023-11-30T10:21:33.213\",\n \"totaltax\": 1.68,\n \"subtotal\": 16.76,\n \"total\": 18.44,\n \"invoicenumber\": 211,\n \"status\": \"Processing\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutdetail\": {\n \"clientsecret\": \"pi_3OHx5FRDQDq9d3Yk1hWlbZry_secret_ssX8or1psKJisFnXhDSQYOgjb\",\n \"checkoutconfirmtype\": \"Payment\"\n }\n}"},{"id":"d11b0e16-e7e1-4fc4-88b7-99656d1a8a4d","name":"Pay Invoice For Upgrade (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"invoicepayment\": {\r\n \"invoiceid\": \"550c6d85703960a0\",\r\n \"amount\": 41.80,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-11-30T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 29 Nov 2023 23:41:14 GMT","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"\nFirst step for upgrade subscriptions is to get the list of plans that the user is allowed to upgrade/downgrade to via getsubscriptionplans/ informing the logged in member token.
\nInvoices for upgrade will return a total with the proration calculation based on the usage of the current plan.
\nInvoices for downgrade won't generate credits, the user will pay the full price to shift ito a cheaper plan.
\nThe following section outlines the Subscription solution that is available through the Harvest Media Public API.
\nAt a top level, what this solution offers is as follows;
\nThe ability to retrieve a list of Subscription Plans based on what has been setup on our Admin
\nThe ability for a member to start the checkout process after choosing the best subscription to suit them
\nThe ability to validate coupons code that might give discounts
\nThe ability to pay for a subscription plan
\nThe ability to cancel an ongoing subscription plan
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE2: Use ReturnRates to get the rates for album or album track
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE2: Use ReturnRates to get the rates for album or album track
\nNOTE: Use ReturnRates to get the track rate on the response
\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":"7dbe7506-1448-4dc3-8fe7-35a87a57a0b2","name":"Create 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 \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"9894b0262715fdb8\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"8c36ab94a3bc6ea1\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-11-16T23:59:59\",\r\n \"issuedate\": \"2023-11-16T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 00:23:13 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"4628e0fa73666edb\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-11T11:23:13.343\",\n \"duedate\": \"2023-12-11T11:23:13.37\",\n \"totaltax\": 0,\n \"subtotal\": 10,\n \"total\": 10,\n \"invoicenumber\": 183,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1Nseu6IGENCfkRK2\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"5465f938-7d12-434a-a4d6-28c2268f3e96","name":"Create Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"9894b0262715fdb8\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"8c36ab94a3bc6ea1\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-11-16T23:59:59\",\r\n \"issuedate\": \"2023-11-16T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 11 Dec 2023 00:59:43 GMT","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"\nWhen the cart is empty, a new invoice needs to be created to start off the checkout process. Send the TrackID plus the RateID on the invoice reference line items and get the response back with the total invoice amount
\n","_postman_id":"91d59bca-add9-4af6-93dd-58c32124b32d"},{"name":"Filled in Shopping Cart","item":[{"name":"Get Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Pay Invoice\");"],"type":"text/javascript"}}],"id":"b8f6aef2-fac9-4781-858e-09565018922c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":"22492bc2-f343-4760-b053-454923022695","name":"Get 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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n \"returnalbums\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/10.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Date","value":"Thu, 25 Jan 2024 02:09:21 GMT","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"70365ef81c68245d\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-01-25T12:56:30.663\",\n \"duedate\": \"2024-01-25T12:56:30.81\",\n \"totaltax\": 0,\n \"subtotal\": 41,\n \"total\": 41,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - Telemetry Alert Accept Riser Stereo Communications\",\n \"quantity\": 1,\n \"track\": {\n \"trackid\": \"23bd9bc58e66b9f5c755c3313943a2d2\",\n \"albumid\": \"895034c175b0423c\",\n \"originalfilename\": \"COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav\",\n \"filename\": \"TLT1_001_COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav.wav\",\n \"title\": \"COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav\",\n \"displaytitle\": \"Telemetry Alert Accept Riser Stereo Communications\",\n \"tracknumber\": \"001\",\n \"duration\": 1,\n \"bitrate\": 1,\n \"frequency\": 0,\n \"description\": \"Telemetry Alert Accept Riser Stereo Communications\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n }\n },\n {\n \"amount\": 40,\n \"description\": \"Album Purchase - Telemetry Pack\",\n \"quantity\": 1,\n \"rate\": {\n \"id\": \"ba9387a8592a698e\",\n \"style\": 2,\n \"code\": \"ABM001\",\n \"description\": \"ABM001\",\n \"duration\": 0,\n \"fee\": 40\n },\n \"album\": {\n \"albumid\": \"895034c175b0423c\",\n \"title\": \"Telemetry\",\n \"displaytitle\": \"Telemetry Pack\",\n \"albumcode\": \"\",\n \"cdtitle\": \"Telemetry\",\n \"description\": \"A variety of synthesised Telemetry sounds ranging in pitch, modulation and notation.\"\n }\n }\n ],\n \"invoicenumber\": 54,\n \"status\": \"Pending\",\n \"invoiceproduction\": {\n \"client\": \"camila@harvestmedia.net\",\n \"title\": \"Production Name\",\n \"producer\": \"Producer Name\",\n \"productiondate\": \"2020-01-08T00:00:00\",\n \"length\": \"Total Production Length\",\n \"po\": \"Purchase Order Number\"\n },\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n },\n \"checkoutkeys\": {\n \"ConnectedAccountID\": \"acct_1OGxoVIYSStuzdEx\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"b8f6aef2-fac9-4781-858e-09565018922c"},{"name":"Update Invoice","id":"a7e90fbc-b4b4-44dd-8c8a-17532dd0e1e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"3ed96cbee349345f\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2024-01-20T23:59:59\",\r\n \"issuedate\": \"2024-01-20T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"23bd9bc58e66b9f5c755c3313943a2d2\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"50c7165591e2efc7\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"ff22bfbc2c027f5ccc662bcd19e272b0\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"50c7165591e2efc7\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Updates 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\".
\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":["updateinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7d458001-404f-414b-87a9-448b3c6d4094","name":"Update Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"3ed96cbee349345f\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2024-01-20T23:59:59\",\r\n \"issuedate\": \"2024-01-20T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"23bd9bc58e66b9f5c755c3313943a2d2\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"50c7165591e2efc7\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"ff22bfbc2c027f5ccc662bcd19e272b0\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"50c7165591e2efc7\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Jan 2024 07:34:39 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"3ed96cbee349345f\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-01-24T18:34:39.13\",\n \"duedate\": \"2024-01-24T18:34:39.13\",\n \"totaltax\": 0,\n \"subtotal\": 2,\n \"total\": 2,\n \"invoicenumber\": 35,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_live_51MjXTGINFIsu1VM9JVHrWU3kxWokmJKXrNX7mF7exPdByryYVziz2BnWXBNa8vFPbDVKab5KKbfWtIRAumtgwAWn00juQFO095\",\n \"ConnectedAccountID\": \"acct_1OGxoVIYSStuzdEx\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"a7e90fbc-b4b4-44dd-8c8a-17532dd0e1e6"},{"name":"Void Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Pay Invoice\");"],"type":"text/javascript"}}],"id":"8a1684b2-239d-4da8-ba3f-fce66364a5d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":[],"_postman_id":"8a1684b2-239d-4da8-ba3f-fce66364a5d0"}],"id":"7aceb2c9-a55f-48d9-aca8-d14da5273d5e","description":"When the user has already started a shopping cart and still want to add more items, then you need to updateinvoice() sending through all of the previous reference line items plus the new ones added.
\n","_postman_id":"7aceb2c9-a55f-48d9-aca8-d14da5273d5e"}],"id":"c079c55a-3e1c-4a85-92a8-55b9a2ec3896","_postman_id":"c079c55a-3e1c-4a85-92a8-55b9a2ec3896","description":""},{"name":"Checkout Confirmation Page","item":[{"name":"Pay Invoice","event":[{"listen":"test","script":{"id":"daa1a982-c9f6-47a9-a621-51b142d6ae5f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Search Invoice\");"],"type":"text/javascript"}}],"id":"1195ed3c-b82c-44b7-9511-d9d8ef631557","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoicepayment\": {\r\n \"invoiceid\": \"b553f80de383466d\",\r\n \"amount\": 1.10,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2024-02-07T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Pays a pending state invoice.
\nRequest Elements
\nRequest Notes: Payment
\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":"6316044d-123b-4485-bde2-3b81ad16a41a","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 \"invoicepayment\": {\r\n \"invoiceid\": \"4628e0fa73666edb\",\r\n \"amount\": 15.00,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-12-11T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 01:10:20 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"4628e0fa73666edb\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-11T12:00:32.123\",\n \"duedate\": \"2023-12-11T12:00:32.137\",\n \"totaltax\": 0,\n \"subtotal\": 15,\n \"total\": 15,\n \"invoicenumber\": 183,\n \"status\": \"Processing\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutdetail\": {\n \"clientsecret\": \"pi_3OLy0lIGENCfkRK204bsv1Hf_secret_v5erMRdpDoMKjrK2H0Jzs82QE\",\n \"checkoutconfirmtype\": \"Payment\"\n }\n}"}],"_postman_id":"1195ed3c-b82c-44b7-9511-d9d8ef631557"}],"id":"61a701fd-2ca9-44f7-8f4a-16ccff919aec","_postman_id":"61a701fd-2ca9-44f7-8f4a-16ccff919aec","description":""},{"name":"Member Profile Page","item":[{"name":"Get Member Details","event":[{"listen":"test","script":{"id":"2efe7b8a-4c54-4a50-b233-8f408918664b","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"1f0ba0a6-cba4-4a83-a26f-fa98becbabd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmember/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["getmember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f0ba0a6-cba4-4a83-a26f-fa98becbabd3"},{"name":"Request Password Change","event":[{"listen":"test","script":{"id":"23208e14-709a-4caa-8cfc-31b0cbc43ed3","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"a710e7af-a488-4841-9d93-94cb5bf1e3f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\": \"test@test.com\",\r\n\t\"LanguageCode\": \"EN\",\r\n\t\"ResetLink\":\"https://yourdomain.com/reset?token={token}\",\r\n\t\"TokenMergeString\": \"{token}\",\r\n\t\"UseShortUrl\": false,\r\n\t\"ResetTokenExpiryHours\": 2\r\n}"},"url":"{{HM_ServiceAPI_URL}}/sendpasswordresetlinkemail/{{HM_ServiceAPI_Token}}","urlObject":{"path":["sendpasswordresetlinkemail","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a710e7af-a488-4841-9d93-94cb5bf1e3f0"}],"id":"2abd2f0b-3564-4434-a9a4-a198b495c67c","_postman_id":"2abd2f0b-3564-4434-a9a4-a198b495c67c","description":""},{"name":"My Music","item":[{"name":"Search Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript"}}],"id":"de00b830-323f-43e1-ba30-1abb8ff7f5e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"fromamount\":0,\r\n\t\"fromdate\":\"2023-12-08T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2024-12-16T22:19:27.95\",\r\n\t\"limit\":2,\r\n\t\"skip\":0,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"Album\",\r\n \"Status\": \"Pending\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}","description":"Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["searchinvoices","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"dea04ceb-f4b7-4afa-a907-36027af13d19","name":"Search Invoice","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\"fromamount\":0,\r\n\t\"fromdate\":\"2023-12-08T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2024-12-16T22:19:27.95\",\r\n\t\"limit\":5,\r\n\t\"skip\":0,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"Album\",\r\n \"Status\": \"Pending\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 10:08:29 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoices\": [\n {\n \"id\": \"ed551a129ecef961\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-03-04T20:28:54.753\",\n \"duedate\": \"2024-03-04T20:28:55.117\",\n \"UTCOffset\": 11,\n \"totaltax\": 0.1,\n \"subtotal\": 1,\n \"total\": 1.1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - PP-19 Close & Distant 01\",\n \"quantity\": 1,\n \"amounttax\": 0.1,\n \"track\": {\n \"trackid\": \"d84fab3f77ab261ea11b06aafae9b741\",\n \"albumid\": \"c9614bd63c4e957a\",\n \"originalfilename\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"filename\": \"FA1_001_GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav.wav\",\n \"title\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"displaytitle\": \"PP-19 Close & Distant 01\",\n \"tracknumber\": \"001\",\n \"duration\": 14,\n \"bitrate\": 14,\n \"frequency\": 0,\n \"description\": \"PP-19 Close & Distant 01\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n },\n \"album\": {\n \"albumid\": \"c9614bd63c4e957a\",\n \"title\": \"Firearms\",\n \"displaytitle\": \"Firearms\",\n \"albumcode\": \"\",\n \"cdtitle\": \"Firearms\",\n \"description\": \"Guns from the battle field at various perspectives and distances, including handling and trigger sounds.\"\n }\n }\n ],\n \"invoicenumber\": 479,\n \"paidamount\": 0,\n \"status\": \"Pending\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n },\n {\n \"id\": \"467356bc5d7e49f6\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-03-04T16:55:35.87\",\n \"duedate\": \"2024-03-04T16:55:36.04\",\n \"UTCOffset\": 11,\n \"totaltax\": 0.1,\n \"subtotal\": 1,\n \"total\": 1.1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Album Purchase - Firearms\",\n \"quantity\": 1,\n \"amounttax\": 0.1,\n \"rate\": {\n \"id\": \"cc683a508e588e2f\",\n \"style\": 2,\n \"code\": \"TST\",\n \"description\": \"TST\",\n \"duration\": 0,\n \"fee\": 1\n },\n \"album\": {\n \"albumid\": \"c9614bd63c4e957a\",\n \"title\": \"Firearms\",\n \"displaytitle\": \"Firearms\",\n \"albumcode\": \"\",\n \"cdtitle\": \"Firearms\",\n \"description\": \"Guns from the battle field at various perspectives and distances, including handling and trigger sounds.\"\n }\n }\n ],\n \"invoicenumber\": 478,\n \"paidamount\": 0,\n \"status\": \"Pending\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n }\n ],\n \"total\": 2\n}"}],"_postman_id":"de00b830-323f-43e1-ba30-1abb8ff7f5e6"},{"name":"Get Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Pay Invoice\");"],"type":"text/javascript"}}],"id":"7a4111c8-2332-42ea-b741-c0448d5c5f47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":"c630c998-587c-413e-bf76-f4b4c47f0bff","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 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":"b6540276-94a5-4543-8198-c7751d3ba7c6"},{"name":"Implementation Guide - Stems","id":"8a072e81-6159-4acb-8d93-c8d38bd99173","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":"8a072e81-6159-4acb-8d93-c8d38bd99173"},{"name":"Validate Music Download","id":"cf32559b-389f-4348-8b21-ed2b2d63eea0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"Identifier\":\"b553f80de383466d\",\r\n\t\"ContentIDs\":\"\",\r\n\t\"DownloadType\":\"track\",\r\n\t\"Format\":[\"19b8f5935503adde\"],\r\n\t\"TrimEndSecs\":0,\r\n\t\"TrimStartSecs\":0,\r\n\t\"IncludeVersionCheck\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost/hmp_service/HMP-WS.svc/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":{"protocol":"http","path":["hmp_service","HMP-WS.svc","getmusicdownload","{{HM_ServiceAPI_MemberToken}}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"b4946335-1db1-4834-87bc-d3cf2abc9783","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\t\"Identifier\":\"1f9345scb3836e55c3\",\r\n\t\"DownloadType\":\"track\",\r\n\t\"Format\":\"mp3\",\r\n\t\"TrimStartSecs\":0,\r\n\t\"TrimEndSecs\":0,\r\n\t\"Email\":\"email@domain.com\",\r\n\t\"IsShare\":false,\r\n\t\"Message\":\"\",\r\n\t\"SenderEmail\":\"\",\r\n\t\"ForceEmail\":false,\r\n\t\"IncludeVersions\":false,\r\n\t\"VersionFolderName\":\"\",\r\n\t\"DownloadFileName\":\"\",\r\n\t\"CuesheetFileName\":\"\"\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","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 01:39:32 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Content-Length","value":"199","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"RequestSent\": false,\n \"DownloadTokens\": [\n {\n \"TokenValue\": \"37ecc842dac353708v941e8e09vf42c3l0\"\n }\n ],\n \"BlockedContentIDs\": []\n}"},{"id":"209bb1a3-aebb-4024-b782-99480bff7b06","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.
Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getinvoicedownloadurl","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_InvoiceID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"378db561-e2ee-47e4-9005-73cc0d5b8a0d","name":"Get Invoice Download URL","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}}/getinvoicedownloadurl/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_InvoiceID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Feb 2024 05:37:18 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Url\": \"https://cf.harvestmedia.net/CDN/downloads/invoices/7f9ad20a0fbc0524/6961e7f1-68d2-4c17-b56e-e85db56eb88b/.pdf\"\n}"}],"_postman_id":"f0599ef9-410a-454f-a3f1-63242ab6cded"}],"id":"1e6d66ec-a797-4413-961a-292c31840ad5","_postman_id":"1e6d66ec-a797-4413-961a-292c31840ad5","description":""},{"name":"My History","item":[{"name":"Get Member Download History","id":"7fdbca4c-cdf1-4334-a63d-eb83ffe32a79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getdownloadhistorybymembertoken/{{HM_ServiceAPI_MemberToken}}?startdate={startDate}&enddate={endDate}&skip={{HM_ServiceAPI_Skip}}&limit={{HM_ServiceAPI_Limit}}","description":"Returns 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 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":"5594bfbf-64f9-472c-b859-0662279b03b9","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"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":"cee6dae8-c0ed-49b4-bfe1-fbe03d64620c","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":"829ba197-2b80-4508-bc82-6513bed29db2","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"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":"1af41af6-474a-4b7f-9818-3e54e4985310","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":"039f5650-61a3-4b2e-a994-a1648c9bc97f","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"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":"6afcef86-250a-4523-bdb7-92655b557e8e","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":"7093991b-374d-4493-a9dc-ccf755aa0108","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:06:12 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"b3e71257-9773-41e7-a5cc-1d5077f6ed43","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","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:07:12 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"2d08118a-94f5-4bee-8f51-426c6be47226","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:08:36 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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 \"Tags\": []\n }\n ]\n }\n ]\n}"},{"id":"018ca9fa-0848-4d93-9e72-0e4f4ad00121","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","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:11:01 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"09d6b9c8-50cd-4926-889d-8ca085171940","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:13:34 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"dc52a81f-ca50-406e-be58-6f76d264a87b","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","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:14:27 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"6dca1d04-a933-4ed4-af83-f314b8135950","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:27:46 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"d88753d2-c90c-4f5c-84b2-59cfc1b2e2fe","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","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 04:28:51 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"e65d6444-38a8-46b5-aaa2-6da50257687c","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 03:44:00 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"93e245be-113d-4d46-ac4f-befce999c15f","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","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 03:46:31 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"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":"5fc9f4ff-9769-4dea-a81c-abe62312f104","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","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 03:48:48 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"OK\"\n}"},{"id":"597bbef3-a455-424b-a5fb-1d62927c0ce4","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","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 03:49:51 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"transfer-encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"\nOK\nFor Album/Tracks purchases, cloudsearch/ needs to be hit with a \"ReturnRates=true\" so the response will return back the rates associated with the album or the album track, depending on the request View type.
\n","_postman_id":"043290c9-9b55-46f8-9c5f-40fb2d6681a0"},{"name":"Ecom Single Licensing Track","item":[{"name":"Core Search","item":[{"name":"Get Search Default","event":[{"listen":"test","script":{"id":"64394e88-1776-4974-872e-e1478d42f6c8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"53721b69-2112-424a-9da9-c766e35e3e76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"SaveSearchHistory\": \"false\",\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 \"NearestBPM\": \"false\",\r\n \"NearestDuration\": \"false\",\r\n \"NearestAlternate\": \"false\",\r\n \"ParentSearchHistoryID\": \"\",\r\n \"SearchTermBundle\": {\r\n \"St_Keyword_Aggregated\": {\r\n \"ExactPhrase\": \"false\",\r\n \"Wildcard\": \"true\",\r\n \"DisableKeywordGroup\": \"false\",\r\n \"OrOperation\": \"false\",\r\n \"Keywords\": \"%\",\r\n \"Negative\": \"false\"\r\n }\r\n },\r\n \"ResultView\": {\r\n \"View\": \"Track\",\r\n \"Sort_Predefined\": \"ReleaseDate_Desc\",\r\n \"RankExpression\": \"\",\r\n \"Skip\": \"0\",\r\n \"Limit\": \"10\",\r\n \"Facet_Library\": \"true\",\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\": \"true\",\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\": \"true\",\r\n \"Facet_Duration\": \"true\",\r\n \"Facet_ReleaseYear\": \"false\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/cloudsearch/{{HM_ServiceAPI_MemberToken}}","description":"NOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE2: Use ReturnRates to get the rates for album or album track
\nNOTE: Use the facets to load the BPM, Duration, Label, Mood, Instrument etc panels
\nNOTE2: Use ReturnRates to get the rates for album or album track
\nNOTE: Use ReturnRates to get the track rate on the response
\nReturns 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.
\nFor Single License, please filter the response based either using
\nPricingGroupID - this will return all rates based on a specific group. See request above (getpricinggroups/) to see how to get the ID, or
\nUsage tags - will will return all the rates under many different groups as long as the group has the usage tags in it. *Use comma to request multiple tags. I.e., SFX,Music.
\nGetRates will return all the rates configured in the Admin System. To get only single license type of rates, please filter the response from the parent rate description by getting only \"Single License\" rates.
Creates 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":"e5be4d34-95e8-4fa6-8b2a-b213b6145c31","name":"Create 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 \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"9894b0262715fdb8\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"8c36ab94a3bc6ea1\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-11-16T23:59:59\",\r\n \"issuedate\": \"2023-11-16T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 00:23:13 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"4628e0fa73666edb\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-11T11:23:13.343\",\n \"duedate\": \"2023-12-11T11:23:13.37\",\n \"totaltax\": 0,\n \"subtotal\": 10,\n \"total\": 10,\n \"invoicenumber\": 183,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1Nseu6IGENCfkRK2\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"67653465-7187-452b-bf41-81cecf558a22","name":"Create Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"9894b0262715fdb8\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"8c36ab94a3bc6ea1\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-11-16T23:59:59\",\r\n \"issuedate\": \"2023-11-16T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 11 Dec 2023 00:59:43 GMT","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"\nWhen the cart is empty, a new invoice needs to be created to start off the checkout process. Send the TrackID plus the RateID on the invoice reference line items and get the response back with the total invoice amount
\n","_postman_id":"77a1566a-c6aa-4830-9030-26e3bc8c74b0"},{"name":"Filled in Shopping Cart","item":[{"name":"Get Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Pay Invoice\");"],"type":"text/javascript"}}],"id":"fefedc19-9926-4415-84e1-a604a8b35758","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":"347aa33c-5159-4d25-b909-f50fed3a6650","name":"Get 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\":\"4628e0fa73666edb\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 01:14:13 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"4628e0fa73666edb\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-11T12:00:32.123\",\n \"duedate\": \"2023-12-11T12:00:32.137\",\n \"totaltax\": 0,\n \"subtotal\": 15,\n \"total\": 15,\n \"invoicelineitems\": [\n {\n \"amount\": 5,\n \"description\": \"Track Purchase - Little Victories\",\n \"quantity\": 1,\n \"amounttax\": 0,\n \"track\": {\n \"trackid\": \"ba87dae384dfeddd\",\n \"albumid\": \"e6ee57b732ce88b2\",\n \"originalfilename\": \"CHALK_LITTLE_VICTORIES_A_Sam_Clunie_Daniel_Marantz.wav\",\n \"filename\": \"CHALK014_002_Little Victories.wav\",\n \"title\": \"Little Victories\",\n \"displaytitle\": \"Little Victories\",\n \"tracknumber\": \"002\",\n \"duration\": 148,\n \"bitrate\": 148,\n \"frequency\": 0,\n \"description\": \"Diligent tasking cue with unwavering staccato strings, warm cello pizzicato and glassy percussive elements\"\n },\n \"rate\": {\n \"id\": \"2b9267ab6c349659\",\n \"style\": 2,\n \"code\": \"FLAT001\",\n \"description\": \"FLAT001\",\n \"duration\": 0,\n \"fee\": 5\n }\n },\n {\n \"amount\": 5,\n \"description\": \"Track Purchase - Dawn Chorus\",\n \"quantity\": 1,\n \"track\": {\n \"trackid\": \"9894b0262715fdb8\",\n \"albumid\": \"e6ee57b732ce88b2\",\n \"originalfilename\": \"CHALK_DAWN_CHORUS_A_Elijah_Hudson_Daniel_Marantz.wav\",\n \"filename\": \"CHALK014_001_Dawn Chorus.wav\",\n \"title\": \"Dawn Chorus\",\n \"displaytitle\": \"Dawn Chorus\",\n \"tracknumber\": \"001\",\n \"duration\": 162,\n \"bitrate\": 162,\n \"frequency\": 0,\n \"description\": \"Sprightly pizzicato string plucks are joined by joyful, delicate processed piano and light percussion, creating an air of hopeful, emotive beauty\"\n },\n \"rate\": {\n \"id\": \"2b9267ab6c349659\",\n \"style\": 2,\n \"code\": \"FLAT001\",\n \"description\": \"FLAT001\",\n \"duration\": 0,\n \"fee\": 5\n }\n },\n {\n \"amount\": 5,\n \"description\": \"Track Purchase - Light Activity\",\n \"quantity\": 1,\n \"track\": {\n \"trackid\": \"8c36ab94a3bc6ea1\",\n \"albumid\": \"e6ee57b732ce88b2\",\n \"originalfilename\": \"CHALK_LIGHT_ACTIVITY_A_Paul_Timothy_Carr_Daniel_Marantz.wav\",\n \"filename\": \"CHALK014_005_Light Activity.wav\",\n \"title\": \"Light Activity\",\n \"displaytitle\": \"Light Activity\",\n \"tracknumber\": \"005\",\n \"duration\": 131,\n \"bitrate\": 131,\n \"frequency\": 0,\n \"description\": \"Animated pizzicato string plucks and cautious staccato string melodies join with light percussion to form a gently energetic cue\"\n },\n \"rate\": {\n \"id\": \"2b9267ab6c349659\",\n \"style\": 2,\n \"code\": \"FLAT001\",\n \"description\": \"FLAT001\",\n \"duration\": 0,\n \"fee\": 5\n }\n }\n ],\n \"invoicenumber\": 183,\n \"status\": \"Processing\",\n \"invoiceproduction\": {\n \"client\": \"camila@harvestmedia.net\",\n \"title\": \"CS-TEST-SUB\",\n \"producer\": \"CS TEST SUB\",\n \"productiondate\": \"2023-08-15T00:00:00\",\n \"length\": \"TEST SUB Length\",\n \"po\": \"Purchase Order Number SUB\"\n },\n \"currencycode\": \"AUD\"\n }\n}"}],"_postman_id":"fefedc19-9926-4415-84e1-a604a8b35758"},{"name":"Update Invoice","id":"1fdff2fd-7919-4a17-925a-36f41aff39b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"{{HM_ServiceAPI_InvoiceID}}\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-08-15T23:59:59\",\r\n \"issuedate\": \"2023-08-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"amount\": 0,\r\n \"amounttax\": 0,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\": [\r\n {\r\n \"referenceid\": \"7026280a00766607\",\r\n \"referencetype\": \"Subscription\"\r\n },\r\n {\r\n \"referenceid\": \"4d3ddcd6da8eed45\",\r\n \"referencetype\": \"SubscriptionDiscount\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Updates 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\".
\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":["updateinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d0b64ea8-f22e-4e62-849f-e458f87a645c","name":"Update Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"4628e0fa73666edb\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-11T23:59:59\",\r\n \"issuedate\": \"2023-12-11T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"amount\": 0,\r\n \"amounttax\": 0,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[\r\n {\r\n \"referenceid\":\"ba87dae384dfeddd\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"9894b0262715fdb8\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"8c36ab94a3bc6ea1\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 00:28:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"4628e0fa73666edb\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-11T11:28:54.613\",\n \"duedate\": \"2023-12-11T11:28:54.63\",\n \"totaltax\": 0,\n \"subtotal\": 15,\n \"total\": 15,\n \"invoicenumber\": 183,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1Nseu6IGENCfkRK2\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"f9c6308f-7d28-475c-8592-26e0b37befad","name":"Update Invoice (XML)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/xml"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"4628e0fa73666edb\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-11T23:59:59\",\r\n \"issuedate\": \"2023-12-11T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"amount\": 0,\r\n \"amounttax\": 0,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[\r\n {\r\n \"referenceid\":\"ba87dae384dfeddd\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"9894b0262715fdb8\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"8c36ab94a3bc6ea1\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"2b9267ab6c349659\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 11 Dec 2023 01:00:32 GMT","enabled":true},{"key":"Content-Type","value":"application/xml","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"\nWhen the user has already started a shopping cart and still want to add more items, then you need to updateinvoice() sending through all of the previous reference line items plus the new ones added.
\n","_postman_id":"3a730413-249e-44d4-9fc0-2b6e8b294f5e"},{"name":"Checkout Confirmation Page","item":[{"name":"Pay Invoice","event":[{"listen":"test","script":{"id":"daa1a982-c9f6-47a9-a621-51b142d6ae5f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Search Invoice\");"],"type":"text/javascript"}}],"id":"fff790c1-4619-4941-9a89-6391a10be72e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoicepayment\": {\r\n \"invoiceid\": \"HM4628e0fa73666edb\",\r\n \"amount\": 15.00,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-12-11T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Pays a pending state invoice.
\nRequest Elements
\nRequest Notes: Payment
\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":"1758028d-64de-4ebc-ac24-1bcccc3c0887","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 \"invoicepayment\": {\r\n \"invoiceid\": \"4628e0fa73666edb\",\r\n \"amount\": 15.00,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-12-11T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 01:10:20 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"4628e0fa73666edb\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-11T12:00:32.123\",\n \"duedate\": \"2023-12-11T12:00:32.137\",\n \"totaltax\": 0,\n \"subtotal\": 15,\n \"total\": 15,\n \"invoicenumber\": 183,\n \"status\": \"Processing\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutdetail\": {\n \"clientsecret\": \"pi_3OLy0lIGENCfkRK204bsv1Hf_secret_v5erMRdpDoMKjrK2H0Jzs82QE\",\n \"checkoutconfirmtype\": \"Payment\"\n }\n}"}],"_postman_id":"fff790c1-4619-4941-9a89-6391a10be72e"}],"id":"baecb519-355c-44aa-a2c5-e54b8f4d0c35","_postman_id":"baecb519-355c-44aa-a2c5-e54b8f4d0c35","description":""},{"name":"Member Profile Page","item":[{"name":"Member Whitelisting Page Copy","item":[{"name":"Update Member Details","event":[{"listen":"test","script":{"id":"db08cb3a-d0e9-471c-9df7-fe14c569fb7d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Update Member Details (MT)\");"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"ab8a07bc-ff4a-4233-b418-2859e84cde11","exec":["var newUsername = postman.getEnvironmentVariable(\"HM_ServiceAPI_Token\") + \"-user-u\";","","postman.setEnvironmentVariable(\"HM_ServiceAPI_NewMemberUsername\", newUsername);"],"type":"text/javascript"}}],"id":"8db76eb0-f728-4418-8ad6-3bde94c5a4cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_MemberAccountID}}\",\r\n\t\t\"FirstName\":\"First\",\r\n\t\t\"LastName\":\"Last\",\r\n\t\t\"Email\":\"camila@harvestmedia.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\":\"{{HM_ServiceAPI_MemberUsername}}\",\r\n\t \"Password\":\"{{HM_ServiceAPI_MemberPassword}}\",\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\t},\r\n \"Channels\": [\r\n {\r\n \"platform\": \"youtube\",\r\n \"value\": \"youtube.com/cs-youtube-changed\"\r\n },\r\n {\r\n \"platform\": \"facebook\",\r\n \"value\": \"facebook.com/cs-test-new-facebook-changed\"\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/updatemember/{{HM_ServiceAPI_MemberToken}}","description":"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”.
\nRequest Notes: Member Channels
\n","urlObject":{"path":["updatemember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"127b1f69-1f3e-4ef4-ab9a-53d0c41d81ae","name":"Update Member Details","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\":\"{{HM_ServiceAPI_MemberAccountID}}\",\r\n\t\t\"FirstName\":\"First\",\r\n\t\t\"LastName\":\"Last\",\r\n\t\t\"Email\":\"camila@harvestmedia.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\":\"{{HM_ServiceAPI_MemberUsername}}\",\r\n\t \"Password\":\"{{HM_ServiceAPI_MemberPassword}}\",\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\t},\r\n \"Channels\": [\r\n {\r\n \"platform\": \"youtube\",\r\n \"value\": \"youtube.com/cs-youtube-changed\"\r\n },\r\n {\r\n \"platform\": \"facebook\",\r\n \"value\": \"facebook.com/cs-test-new-facebook-changed\"\r\n }\r\n ]\r\n}"},"url":"{{HM_ServiceAPI_URL}}/updatemember/{{HM_IntegrationAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Sep 2023 07:29:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Set-Cookie","value":"AWSALBTG=eHJ12Gnmk7cnEUrqcKclmDf5RhcaYRynO+tpV0D0Q4+emYeH/wxj1i9djpencdCfLJGT/m9uBSl0kMswbuFsWX1QGYB5rL4iUHAGLMT5l1cpm5m/nLgNQA7QQEaiNfpsM+sbYZi+X/DOLorqsr6Kt0jjCGvhOrjH7hSYsJnNMLR/YQEsR70=; Expires=Wed, 13 Sep 2023 07:29:06 GMT; Path=/","enabled":true},{"key":"Set-Cookie","value":"AWSALBTGCORS=eHJ12Gnmk7cnEUrqcKclmDf5RhcaYRynO+tpV0D0Q4+emYeH/wxj1i9djpencdCfLJGT/m9uBSl0kMswbuFsWX1QGYB5rL4iUHAGLMT5l1cpm5m/nLgNQA7QQEaiNfpsM+sbYZi+X/DOLorqsr6Kt0jjCGvhOrjH7hSYsJnNMLR/YQEsR70=; Expires=Wed, 13 Sep 2023 07:29:06 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"MemberAccount\": {\n \"ID\": \"9a007f669be92e14\",\n \"FirstName\": \"First\",\n \"LastName\": \"Last\",\n \"Email\": \"camila@harvestmedia.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\": \"camila@harvestmedia.net\",\n \"TermsAccept\": \"true\",\n \"Subscribe\": \"true\",\n \"FileFormat\": \"19b8f5935503adde\",\n \"SearchFormat\": \"track\",\n \"SearchSort\": \"fav\",\n \"SampleEnabled\": \"true\",\n \"Status\": \"active\",\n \"RegionID\": \"e616f53a01ddd9e3\",\n \"ServiceInfoURLs\": {\n \"DirectDownloadURL\": \"https://cf.harvestmedia.net/assets/downloads/{downloadtoken}\",\n \"TrackStreamURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/ac6373252926edf5e433024cb2571902fc6a8dda/{id}\",\n \"ProfileImageURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/memberprofile/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\",\n \"AlbumMontageSampleURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/samples/montage/ac6373252926edf5e433024cb2571902fc6a8dda/{id}\",\n \"AlbumArtURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/albumart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"WaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"MontageWaveformURL\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveforms/montage/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"LibraryLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/librarylogo/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"PlaylistArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"PlaylistCategoryArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/playlistcategoryart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"RightHolderProfileUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/rightholderprofile/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"WaveformDataPointUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/waveform_data/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{dataformat}\",\n \"StyleArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/styleart/21765449be9e4e8c3ea8fe97997f7e5d9e8c8ec9/{id}/{width}/{height}\",\n \"MemberGroupLogoUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergrouplogo/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\",\n \"MemberGroupArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupart/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\",\n \"MemberGroupProductionArtUrl\": \"https://d2zsljmk3mm9kv.cloudfront.net/assets/membergroupproductionart/ac6373252926edf5e433024cb2571902fc6a8dda/{id}/{width}/{height}\"\n },\n \"LanguageCode\": \"EN\",\n \"Salutation\": \"\",\n \"MemberTypeID\": \"\",\n \"FileFormats\": [],\n \"HasProfileImage\": false,\n \"PrivacyAccept\": \"true\",\n \"DownloadEnabled\": \"true\",\n \"DownloadsRemaining\": \"NULL\",\n \"DownloadEnabledType\": \"Member\",\n \"DownloadLimit\": \"NULL\",\n \"DownloadsUsed\": \"NULL\",\n \"DownloadStem\": false\n },\n \"MemberChannels\": [\n {\n \"Platform\": \"Youtube\",\n \"Value\": \"youtube.com/cs-youtube-changed\"\n },\n {\n \"Platform\": \"Facebook\",\n \"Value\": \"facebook.com/cs-test-new-facebook-changed\"\n }\n ]\n}"}],"_postman_id":"8db76eb0-f728-4418-8ad6-3bde94c5a4cf"}],"id":"fea0ab3c-5725-4072-be51-64168d5d054c","_postman_id":"fea0ab3c-5725-4072-be51-64168d5d054c","description":""},{"name":"Get Member Details","event":[{"listen":"test","script":{"id":"2efe7b8a-4c54-4a50-b233-8f408918664b","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"46c670a8-10c7-4908-8f76-487428fb53a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getmember/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["getmember","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"46c670a8-10c7-4908-8f76-487428fb53a5"},{"name":"Request Password Change","event":[{"listen":"test","script":{"id":"23208e14-709a-4caa-8cfc-31b0cbc43ed3","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"089b0981-38f0-4638-908f-15102f25c8ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\": \"test@test.com\",\r\n\t\"LanguageCode\": \"EN\",\r\n\t\"ResetLink\":\"https://yourdomain.com/reset?token={token}\",\r\n\t\"TokenMergeString\": \"{token}\",\r\n\t\"UseShortUrl\": false,\r\n\t\"ResetTokenExpiryHours\": 2\r\n}"},"url":"{{HM_ServiceAPI_URL}}/sendpasswordresetlinkemail/{{HM_ServiceAPI_Token}}","urlObject":{"path":["sendpasswordresetlinkemail","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"089b0981-38f0-4638-908f-15102f25c8ac"}],"id":"d6c47cb8-afe7-4d15-bb7a-37c27acbe8ff","_postman_id":"d6c47cb8-afe7-4d15-bb7a-37c27acbe8ff","description":""},{"name":"My Music","item":[{"name":"Search Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript","packages":{}}}],"id":"503d98f4-69cd-4b25-984d-221841e3e9e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"fromamount\":0,\r\n\t\"fromdate\":\"2020-01-08T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2026-05-16T22:19:27.95\",\r\n\t\"limit\":10,\r\n\t\"skip\":0,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"\",\r\n \"Status\": \"Paid\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}","description":"Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["searchinvoices","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cc28b61c-50fe-424f-a8e1-67ef7c1ca3eb","name":"Search Invoice","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\"fromamount\":0,\r\n\t\"fromdate\":\"2020-01-08T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2025-01-12T22:19:27.95\",\r\n\t\"limit\":2,\r\n\t\"skip\":1,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"Track\",\r\n \"Status\": \"Paid\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 06:06:14 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoices\": [\n {\n \"id\": \"fe2657bd58706174\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-03-04T15:12:12.967\",\n \"duedate\": \"2024-03-04T15:12:13.133\",\n \"UTCOffset\": 11,\n \"totaltax\": 0.1,\n \"subtotal\": 1,\n \"total\": 1.1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Album Purchase - Firearms\",\n \"quantity\": 1,\n \"amounttax\": 0.1,\n \"rate\": {\n \"id\": \"cc683a508e588e2f\",\n \"style\": 2,\n \"code\": \"TST\",\n \"description\": \"TST\",\n \"duration\": 0,\n \"fee\": 1\n },\n \"album\": {\n \"albumid\": \"c9614bd63c4e957a\",\n \"title\": \"Firearms\",\n \"displaytitle\": \"Firearms\",\n \"albumcode\": \"\",\n \"cdtitle\": \"Firearms\",\n \"description\": \"Guns from the battle field at various perspectives and distances, including handling and trigger sounds.\"\n }\n }\n ],\n \"invoicenumber\": 477,\n \"paidamount\": 0,\n \"status\": \"Paid\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n },\n {\n \"id\": \"21cb9c1f926d9658\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-02-27T19:30:56.777\",\n \"duedate\": \"2024-02-27T19:30:56.87\",\n \"UTCOffset\": 11,\n \"totaltax\": 0.1,\n \"subtotal\": 1,\n \"total\": 1.1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - PP-19 Close & Distant 01\",\n \"quantity\": 1,\n \"amounttax\": 0.1,\n \"track\": {\n \"trackid\": \"d84fab3f77ab261ea11b06aafae9b741\",\n \"albumid\": \"c9614bd63c4e957a\",\n \"originalfilename\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"filename\": \"FA1_001_GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav.wav\",\n \"title\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"displaytitle\": \"PP-19 Close & Distant 01\",\n \"tracknumber\": \"001\",\n \"duration\": 14,\n \"bitrate\": 14,\n \"frequency\": 0,\n \"description\": \"PP-19 Close & Distant 01\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n }\n }\n ],\n \"invoicenumber\": 435,\n \"paidamount\": 0,\n \"status\": \"Paid\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n }\n ],\n \"InvoicesTotal\": [\n {\n \"InvoiceReferenceType\": \"Track\",\n \"Total\": 1,\n \"InvoicesTotalStatus\": [\n {\n \"status\": \"Paid\",\n \"total\": 1\n }\n ]\n },\n {\n \"InvoiceReferenceType\": \"Album\",\n \"Total\": 1,\n \"InvoicesTotalStatus\": [\n {\n \"status\": \"Paid\",\n \"total\": 1\n }\n ]\n },\n {\n \"InvoiceReferenceType\": \"Subscription\",\n \"Total\": 0\n }\n ]\n}"},{"id":"29ae92b9-9937-47f9-a35a-3f38a11f1124","name":"Search Invoice","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\"fromamount\":0,\r\n\t\"fromdate\":\"2020-01-08T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2024-03-12T22:19:27.95\",\r\n\t\"limit\":10,\r\n\t\"skip\":0,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"Track\",\r\n \"Status\": \"Paid\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 10:09:09 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoices\": [\n {\n \"id\": \"21cb9c1f926d9658\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-02-27T19:30:56.777\",\n \"duedate\": \"2024-02-27T19:30:56.87\",\n \"UTCOffset\": 11,\n \"totaltax\": 0.1,\n \"subtotal\": 1,\n \"total\": 1.1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - PP-19 Close & Distant 01\",\n \"quantity\": 1,\n \"amounttax\": 0.1,\n \"track\": {\n \"trackid\": \"d84fab3f77ab261ea11b06aafae9b741\",\n \"albumid\": \"c9614bd63c4e957a\",\n \"originalfilename\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"filename\": \"FA1_001_GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav.wav\",\n \"title\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"displaytitle\": \"PP-19 Close & Distant 01\",\n \"tracknumber\": \"001\",\n \"duration\": 14,\n \"bitrate\": 14,\n \"frequency\": 0,\n \"description\": \"PP-19 Close & Distant 01\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n }\n }\n ],\n \"invoicenumber\": 435,\n \"paidamount\": 0,\n \"status\": \"Paid\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n },\n {\n \"id\": \"b6095d07d2b4844c\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-02-27T18:51:19.923\",\n \"duedate\": \"2024-02-27T18:51:19.993\",\n \"UTCOffset\": 11,\n \"totaltax\": 0.1,\n \"subtotal\": 1,\n \"total\": 1.1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - PP-19 Close & Distant 01\",\n \"quantity\": 1,\n \"amounttax\": 0.1,\n \"track\": {\n \"trackid\": \"d84fab3f77ab261ea11b06aafae9b741\",\n \"albumid\": \"c9614bd63c4e957a\",\n \"originalfilename\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"filename\": \"FA1_001_GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav.wav\",\n \"title\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"displaytitle\": \"PP-19 Close & Distant 01\",\n \"tracknumber\": \"001\",\n \"duration\": 14,\n \"bitrate\": 14,\n \"frequency\": 0,\n \"description\": \"PP-19 Close & Distant 01\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n }\n }\n ],\n \"invoicenumber\": 434,\n \"paidamount\": 0,\n \"status\": \"Paid\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n },\n {\n \"id\": \"d3e7c4110f13418a\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-02-27T18:32:35.62\",\n \"duedate\": \"2024-02-27T18:32:35.773\",\n \"UTCOffset\": 11,\n \"totaltax\": 0.1,\n \"subtotal\": 1,\n \"total\": 1.1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - PP-19 Close & Distant 01\",\n \"quantity\": 1,\n \"amounttax\": 0.1,\n \"track\": {\n \"trackid\": \"d84fab3f77ab261ea11b06aafae9b741\",\n \"albumid\": \"c9614bd63c4e957a\",\n \"originalfilename\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"filename\": \"FA1_001_GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav.wav\",\n \"title\": \"GUNAuto_EPICGUNS_PP-19_Close & Distant 01_AMPLAR.wav\",\n \"displaytitle\": \"PP-19 Close & Distant 01\",\n \"tracknumber\": \"001\",\n \"duration\": 14,\n \"bitrate\": 14,\n \"frequency\": 0,\n \"description\": \"PP-19 Close & Distant 01\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n }\n }\n ],\n \"invoicenumber\": 433,\n \"paidamount\": 0,\n \"status\": \"Paid\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n },\n {\n \"id\": \"1117b3ae87c43601\",\n \"memberaccountid\": \"c8c0e81091a77f09\",\n \"issuedate\": \"2024-02-01T20:12:24.297\",\n \"duedate\": \"2024-02-01T20:12:24.307\",\n \"UTCOffset\": 11,\n \"totaltax\": 0,\n \"subtotal\": 1,\n \"total\": 1,\n \"invoicelineitems\": [\n {\n \"amount\": 1,\n \"description\": \"Track Purchase - Telemetry Alert Accept Riser Stereo Communications\",\n \"quantity\": 1,\n \"track\": {\n \"trackid\": \"23bd9bc58e66b9f5c755c3313943a2d2\",\n \"albumid\": \"895034c175b0423c\",\n \"originalfilename\": \"COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav\",\n \"filename\": \"TLT1_001_COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav.wav\",\n \"title\": \"COMTelm_Telemetry_Alert_Accept_Riser_Stereo_Communications_AMPLAR.wav\",\n \"displaytitle\": \"Telemetry Alert Accept Riser Stereo Communications\",\n \"tracknumber\": \"001\",\n \"duration\": 1,\n \"bitrate\": 1,\n \"frequency\": 0,\n \"description\": \"Telemetry Alert Accept Riser Stereo Communications\"\n },\n \"rate\": {\n \"id\": \"50c7165591e2efc7\",\n \"style\": 2,\n \"code\": \"TRK001\",\n \"description\": \"TRK001\",\n \"duration\": 0,\n \"fee\": 1\n }\n }\n ],\n \"invoicenumber\": 362,\n \"paidamount\": 0,\n \"status\": \"Paid\",\n \"membername\": \"Company - Camila Silva (camila@harvestmedia.net)\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n }\n }\n ],\n \"total\": 4\n}"}],"_postman_id":"503d98f4-69cd-4b25-984d-221841e3e9e9"},{"name":"Get Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Pay Invoice\");"],"type":"text/javascript"}}],"id":"569f3fe4-343a-41b7-b35a-7df8c4157c3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":"9f85a897-da1b-406d-bc35-93cda3d3d64a","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 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":"45cbddee-5a00-492a-b65f-f69790d79e59"},{"name":"Implementation Guide - Stems","id":"1831c989-f99d-494c-84c7-884adb85c079","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":"1831c989-f99d-494c-84c7-884adb85c079"},{"name":"Validate Music Download","id":"695601fb-b678-4d39-80ad-68ca4abd5189","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"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":"d3a3f744-8816-4c18-b23a-e92330a4f3bd","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\t\"Identifier\":\"1f9345scb3836e55c3\",\r\n\t\"DownloadType\":\"track\",\r\n\t\"Format\":\"mp3\",\r\n\t\"TrimStartSecs\":0,\r\n\t\"TrimEndSecs\":0,\r\n\t\"Email\":\"email@domain.com\",\r\n\t\"IsShare\":false,\r\n\t\"Message\":\"\",\r\n\t\"SenderEmail\":\"\",\r\n\t\"ForceEmail\":false,\r\n\t\"IncludeVersions\":false,\r\n\t\"VersionFolderName\":\"\",\r\n\t\"DownloadFileName\":\"\",\r\n\t\"CuesheetFileName\":\"\"\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","enabled":true},{"key":"Date","value":"Fri, 23 Aug 2019 01:39:32 GMT","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Content-Length","value":"199","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"RequestSent\": false,\n \"DownloadTokens\": [\n {\n \"TokenValue\": \"37ecc842dac353708v941e8e09vf42c3l0\"\n }\n ],\n \"BlockedContentIDs\": []\n}"},{"id":"c9edd623-b73c-4261-908e-72b52a701561","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.
Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getinvoicedownloadurl","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_InvoiceID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f1250d06-bb3b-4658-8d67-1c875afa2631","name":"Get Invoice Download URL","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}}/getinvoicedownloadurl/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_InvoiceID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Feb 2024 05:39:56 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Url\": \"https://cf.harvestmedia.net/CDN/downloads/invoices/7f9ad20a0fbc0524/a1c1433f-70d0-4f9b-91ca-3475accdb59b/.pdf\"\n}"}],"_postman_id":"90f86486-61d9-4c43-a9b3-951993640ce0"}],"id":"4e50fa0d-24c4-4cd2-ad1d-dc1f1b9103dd","_postman_id":"4e50fa0d-24c4-4cd2-ad1d-dc1f1b9103dd","description":""},{"name":"My History","item":[{"name":"Get Member Download History","id":"ca6eaca7-bb39-4354-913b-fee045688a95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getdownloadhistorybymembertoken/{{HM_ServiceAPI_MemberToken}}?startdate={startDate}&enddate={endDate}&skip={Skip}&limit={Limit}","description":"Returns 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 dateTo licensing a track after selecting from a search list, it is needed to call GetRates() informing the style flat and the account currency and filter the response by the parent type \"Single License\". When the user makes their selection, create the invoice and continue normally to the checkout process by sending the trackID and the chosen rateID.
This endpoint returns one or multiple rates that applies, depending on the tags provided in the request.
\n","urlObject":{"path":["getratesbytags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"disabled":true,"key":"Authentication","value":"{{HM_ServiceAPI_AuthToken}}"}],"variable":[]}},"response":[{"id":"f7d5f44c-6803-4372-97d4-4dadd16bdf7c","name":"Get Rates By Tags (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Style\": \"Drop\",\r\n \"PricingGroupID\": \"{{HM_ServiceAPI_GroupID_Local}}\",\r\n \"currencycode\":\"AUD\",\r\n \"Tags\": [\r\n \"internal\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HM_ServiceAPI_URL_Local}}/getratesbytags/{{HM_ServiceAPI_Token}}?Authentication={{HM_ServiceAPI_AuthToken}}","host":["{{HM_ServiceAPI_URL_Local}}"],"path":["getratesbytags","{{HM_ServiceAPI_Token}}"],"query":[{"key":"Authentication","value":"{{HM_ServiceAPI_AuthToken}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/10.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Date","value":"Wed, 05 Jun 2024 02:57:10 GMT","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Rates\": [\n {\n \"ID\": \"e3d5c96d4eb8982b\",\n \"Style\": \"Drop\",\n \"Code\": \"DRP005\",\n \"Title\": \"Promo/PSA / Program\",\n \"Description\": \"Local Internal\",\n \"Fee\": 150,\n \"FeeWithTax\": 0,\n \"DatetimeStamp\": \"2024-05-23 16:38:42\",\n \"OrderID\": \"2002\",\n \"CurrencyCode\": \"AUD\",\n \"ParentRate\": {\n \"ID\": \"b33dac4210a13a28\",\n \"Code\": \"\",\n \"Description\": \"Local\",\n \"Fee\": 0,\n \"FeeWithTax\": 0,\n \"OrderID\": \"1995\",\n \"DescriptionNotes\": \"Local\"\n },\n \"Tags\": \",9977,\"\n }\n ]\n}"}],"_postman_id":"4692bb20-bcdf-457f-989a-eec9ab5bca26"}],"id":"249081ee-f820-416c-b7b0-f07ac4aac6e1","_postman_id":"249081ee-f820-416c-b7b0-f07ac4aac6e1","description":""},{"name":"My Music","item":[{"name":"Search Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript","packages":{}}}],"id":"3c33cf06-6503-4879-b707-4013728ab244","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"fromamount\":0,\r\n\t\"fromdate\":\"2020-01-08T22:19:27.95\",\r\n\t\"toamount\":1000,\r\n\t\"todate\":\"2026-05-16T22:19:27.95\",\r\n\t\"limit\":10,\r\n\t\"skip\":0,\r\n \"ReturnInvoiceItems\": \"true\",\r\n \"ReferenceLineItemType\": \"\",\r\n \"Status\": \"Paid\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/searchinvoices/{{HM_ServiceAPI_MemberToken}}","description":"Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["searchinvoices","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c33cf06-6503-4879-b707-4013728ab244"},{"name":"Get Invoice","event":[{"listen":"test","script":{"id":"b5ca7520-4b18-41d1-a7a4-0e9758017751","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Pay Invoice\");"],"type":"text/javascript"}}],"id":"920ce959-1759-44bf-96a5-23c28b5edd37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\":\"{{HM_ServiceAPI_InvoiceID}}\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/{{HM_ServiceAPI_MemberToken}}","description":"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":"3a6a2bcf-4bf4-4947-a5a9-5b91a3a1014b","name":"Get Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\r\n\t\"invoiceid\":\"\",\r\n\t\"returntracks\":true,\r\n\t\"returnrates\": true,\r\n\t\"returndiscounts\": true\r\n}"},"url":"{{HM_ServiceAPI_URL}}/getinvoice/HMP-WS.svc//getinvoice/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Jun 2024 08:26:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"a6da8aef24de5be1\",\n \"memberaccountid\": \"d3b0eae379e7e2d8\",\n \"issuedate\": \"2024-06-18T18:25:34.76\",\n \"duedate\": \"2024-06-18T18:25:35.353\",\n \"UTCOffset\": 10,\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 425,\n \"total\": 425,\n \"invoicelineitems\": [\n {\n \"amount\": 425,\n \"description\": \"Track Purchase - Track Display Title 01 from Album 01\",\n \"quantity\": 1,\n \"amounttax\": 0,\n \"track\": {\n \"trackid\": \"16ff21fe04dfec0c\",\n \"albumid\": \"227041b2179afa8f\",\n \"originalfilename\": \"Track01.wav\",\n \"filename\": \"Track01.wav\",\n \"title\": \"Track Title 01 from Album 01\",\n \"displaytitle\": \"Track Display Title 01 from Album 01\",\n \"tracknumber\": \"001\",\n \"duration\": 290,\n \"bitrate\": 290,\n \"frequency\": 0,\n \"description\": \"Track Description 01\"\n },\n \"rates\": [\n {\n \"id\": \"ec676789b1358444\",\n \"style\": 4,\n \"code\": \"DRP001\",\n \"title\": \"Promo/PSA / Program\",\n \"description\": \"Local Internet/Social\",\n \"fee\": 175,\n \"feewithtax\": 175\n },\n {\n \"id\": \"89b4e8664c662c05\",\n \"style\": 4,\n \"code\": \"DROP004\",\n \"title\": \"Promo/PSA / Program\",\n \"description\": \"Local Industrial\",\n \"fee\": 250,\n \"feewithtax\": 250\n }\n ]\n }\n ],\n \"invoicenumber\": 199,\n \"status\": \"Pending\",\n \"invoiceproduction\": {\n \"client\": \"camila@harvestmedia.net\",\n \"title\": \"Production Name\",\n \"producer\": \"Producer Name\",\n \"productiondate\": \"2020-01-08T00:00:00\",\n \"length\": \"Total Production Length\",\n \"po\": \"Purchase Order Number\"\n },\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n },\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"ConnectedAccountID\": \"acct_1ONSQvITn8N7IvCC\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"920ce959-1759-44bf-96a5-23c28b5edd37"}],"id":"4a081243-e3da-45c8-b7cc-1789b249db91","_postman_id":"4a081243-e3da-45c8-b7cc-1789b249db91","description":""},{"name":"Custom Forms","item":[{"name":"Send Custom Form Email","id":"d7a16297-263d-4dd3-9351-79bcfbe4c3df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"ToEmail\": [\"{{toemail1}}\", \"{{toemail2}}\"],\r\n \"BodyRequest\": \"{{bodyHTMLrequest}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendecomcustomformemail/{{HM_ServiceAPI_MemberToken}}","urlObject":{"path":["sendecomcustomformemail","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"87ca9521-d24d-4328-b663-ac6cd45304a4","name":"Send Custom Form Email - ServiceToken","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 \"ToEmail\": [\"{{toemail1}}\", \"{{toemail2}}\"],\r\n \"BodyRequest\": \"{{bodyHTMLrequest}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendecomcustomformemail/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 31 Jul 2025 04:31: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/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 \"Code\": \"OK\"\n}"},{"id":"ad2c234b-df40-4fc1-a280-07385dda1b1e","name":"Send Custom Form Email - MemberToken","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 \"ToEmail\": [\"{{toemail1}}\", \"{{toemail2}}\"],\r\n \"BodyRequest\": \"{{bodyHTMLrequest}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/sendecomcustomformemail/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 31 Jul 2025 04:32: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/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 \"Code\": \"OK\"\n}"}],"_postman_id":"d7a16297-263d-4dd3-9351-79bcfbe4c3df"}],"id":"a5221b9e-f9ae-4927-b3b5-848095997112","description":"The endpoint sendecomcustomformemail is able to receive:
\na list of recipient emails in \"ToEmail\"
\na HTML request containing the form to be sent.
\nAlong with the 'ToEmail' (which can be the admin account responsible for analyzing this form custom request), the logged-in member will also receive a notification that their form is being analyzed.
\n","_postman_id":"a5221b9e-f9ae-4927-b3b5-848095997112"},{"name":"Checkout","item":[{"name":"Pay Now","item":[{"name":"Pay Invoice","event":[{"listen":"test","script":{"id":"daa1a982-c9f6-47a9-a621-51b142d6ae5f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Search Invoice\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"57a1b937-03dc-4784-a138-05861810825f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoicepayment\": {\r\n \"invoiceid\": \"HM4628e0fa73666edb\",\r\n \"amount\": 15.00,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-12-11T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Pays a pending state invoice.
\nRequest Elements
\nRequest Notes: Payment
\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":"246086b3-be26-4261-b066-17de6383d366","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 \"invoicepayment\": {\r\n \"invoiceid\": \"4628e0fa73666edb\",\r\n \"amount\": 15.00,\r\n \"contactname\": \"camila@harvestmedia.net\",\r\n \"date\": \"2023-12-11T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"paymentreferencenumber\": \"\",\r\n \"paymentstatus\": \"Processing\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/payinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 01:10: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 \"invoice\": {\n \"id\": \"4628e0fa73666edb\",\n \"memberaccountid\": \"92662dfe696a497f\",\n \"issuedate\": \"2023-12-11T12:00:32.123\",\n \"duedate\": \"2023-12-11T12:00:32.137\",\n \"totaltax\": 0,\n \"subtotal\": 15,\n \"total\": 15,\n \"invoicenumber\": 183,\n \"status\": \"Processing\",\n \"currencycode\": \"AUD\"\n },\n \"checkoutdetail\": {\n \"clientsecret\": \"pi_3OLy0lIGENCfkRK204bsv1Hf_secret_v5erMRdpDoMKjrK2H0Jzs82QE\",\n \"checkoutconfirmtype\": \"Payment\"\n }\n}"}],"_postman_id":"57a1b937-03dc-4784-a138-05861810825f"}],"id":"8131c94c-cb90-4d51-af75-1fc86dbf0294","_postman_id":"8131c94c-cb90-4d51-af75-1fc86dbf0294","description":""},{"name":"Pay Later","item":[{"name":"Add Invoice","event":[{"listen":"test","script":{"id":"07931462-9b4b-4220-bf48-fe6cb6749f7e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataInvoiceID = \"\";","var jsonDataInvoiceTotal = \"\";","","if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataInvoiceID = jsonData.responseinvoice.invoice.id;"," jsonDataInvoiceTotal = jsonData.responseinvoice.invoice.total;","} else {"," jsonData = JSON.parse(responseBody)"," if (jsonData.invoice !== null) {"," jsonDataInvoiceID = jsonData.invoice.id;"," jsonDataInvoiceTotal = jsonData.invoice.total;"," }","}","","console.log(\"HM_ServiceAPI_InvoiceID set to \" + jsonDataInvoiceID);","","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceID\", jsonDataInvoiceID);","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceTotal\", jsonDataInvoiceTotal);","","postman.setNextRequest(\"Get Invoice\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"952cfe28-c891-45ac-b060-9e820c109142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"b3dcaa7fee44b05d0aa221b11bce8b66\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\",\r\n \"referenceoption\":\"Internet/Social, radio, industrial\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Creates 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":"c6b04446-2b5a-4b30-a6be-ef4330546fe7","name":"Add Invoice (PRO w blanket)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"LicensingFor\":\"7ef73e68361d5167\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"16ff21fe04dfec0c\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\",\r\n \"referenceoption\":\"Internet/Social, radio, industrial\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"e6b93746fb6e48d9\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\",\r\n \"referenceoption\":\"Internet/Social, radio, industrial\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"0a20acb59ba703b0df63efd52d9d1fd0\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\",\r\n \"referenceoption\":\"Internet/Social, radio, industrial\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"a7cafbf479f13964931a91b4c9bae962\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\",\r\n \"referenceoption\":\"Internet/Social, radio, industrial\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:28: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 \"invoice\": {\n \"id\": \"66993e7ef8fc4f64\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:28:54.323\",\n \"duedate\": \"2024-06-06T13:28:55.993\",\n \"UTCOffset\": 10,\n \"discount\": 480,\n \"totaltax\": 0,\n \"subtotal\": 1600,\n \"total\": 1120,\n \"invoicenumber\": 1654,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"85edf313-19de-4b1d-8fb9-b365b5e7e7e7","name":"Add Invoice (PRO no blanket)","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 \"invoice\": {\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Professional}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:28: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 \"invoice\": {\n \"id\": \"66993e7ef8fc4f64\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:28:54.323\",\n \"duedate\": \"2024-06-06T13:28:55.993\",\n \"UTCOffset\": 10,\n \"discount\": 480,\n \"totaltax\": 0,\n \"subtotal\": 1600,\n \"total\": 1120,\n \"invoicenumber\": 1654,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"2aa6e88f-bf15-488d-832d-f25da053b21a","name":"Add Invoice (PER w blanket)","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 \"invoice\": {\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Personal}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID2}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID3}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID4}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:43:00 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\": \"c580a29691600276\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:42:59.657\",\n \"duedate\": \"2024-06-06T13:43:00.003\",\n \"UTCOffset\": 10,\n \"discount\": 39.2,\n \"totaltax\": 0,\n \"subtotal\": 196,\n \"total\": 156.8,\n \"invoicenumber\": 1655,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"f07ba3b8-313e-44b7-815c-9bf56797732c","name":"Add Invoice (PER no blanket)","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 \"invoice\": {\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Personal}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:45: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 \"invoice\": {\n \"id\": \"8f2e53a2523ab03c\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:45:36.72\",\n \"duedate\": \"2024-06-06T13:45:37.293\",\n \"UTCOffset\": 10,\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 49,\n \"total\": 49,\n \"invoicenumber\": 1656,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"142a0420-2f87-4ee6-adc2-9e7d6980da22","name":"Add Invoice (w PromoCode)","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 \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"b3dcaa7fee44b05d0aa221b11bce8b66\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"207d9e094d264f78\",\r\n \"referencetype\":\"Discount\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Jul 2025 04:33:26 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 \"invoice\": {\n \"id\": \"6301a3ff036fe7cd\",\n \"memberaccountid\": \"d3b0eae379e7e2d8\",\n \"issuedate\": \"2025-07-10T14:33:25.87\",\n \"duedate\": \"2025-07-10T14:33:25.947\",\n \"UTCOffset\": 10,\n \"discount\": 157.5,\n \"totaltax\": 0,\n \"subtotal\": 175,\n \"total\": 17.5,\n \"refundedamount\": 0,\n \"invoicenumber\": 306,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n },\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_live_51MjXTGINFIsu1VM9JVHrWU3kxWokmJKXrNX7mF7exPdByryYVziz2BnWXBNa8vFPbDVKab5KKbfWtIRAumtgwAWn00juQFO095\",\n \"ConnectedAccountID\": \"acct_1ONSQvITn8N7IvCC\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"952cfe28-c891-45ac-b060-9e820c109142"}],"id":"0dad6ee7-b96f-4e07-92fb-e8e64d43fd1d","description":"When an account offers a \"Pay Later\" option, it means that the client won't be charged via usual Stripe checkout, and a new invoice \"addinvoice/\" with\" PaymentType=SalesForce\" (in case they're integrated with SF) needs to be triggered from FLEX to the Harvest API.
\n","_postman_id":"0dad6ee7-b96f-4e07-92fb-e8e64d43fd1d"},{"name":"Validate Promo Code","id":"cac6860c-bc2d-4f70-8a78-e1423a868d57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"RateID\":\"0cccbaf4941574b9\",\r\n \"PromoCode\":\"DEMO90\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/validatepromocode/{{HM_ServiceAPI_Token}}","urlObject":{"path":["validatepromocode","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2924448a-4686-4159-8bb4-9c1f6fd4d2e8","name":"Validate Promo Code (JSON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RateID\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"PromoCode\":\"JUN10\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HM_ServiceAPI_URL}}/validatepromocode/{{HM_ServiceAPI_Token}}?Authentication={{HM_ServiceAPI_AuthToken}}","host":["{{HM_ServiceAPI_URL}}"],"path":["validatepromocode","{{HM_ServiceAPI_Token}}"],"query":[{"key":"Authentication","value":"{{HM_ServiceAPI_AuthToken}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 04:12:01 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": \"Valid\",\n \"Discount\": {\n \"ID\": \"ba2ddc954bed2aa4\",\n \"Name\": \"PROMOTEST\",\n \"StartDate\": \"6/6/2024 12:00:00 AM\",\n \"Percentage\": 50,\n \"TriggerCode\": \"PROMOTEST\",\n \"UTCOffset\": 10\n }\n}"}],"_postman_id":"cac6860c-bc2d-4f70-8a78-e1423a868d57"},{"name":"Update Invoice","id":"5fed6b2f-a264-441a-8524-6a11e43c6516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"3ed96cbee349345f\",\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2024-01-20T23:59:59\",\r\n \"issuedate\": \"2024-01-20T00:00:00\",\r\n \"paymenttype\": \"CreditCard\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"23bd9bc58e66b9f5c755c3313943a2d2\",\r\n \"referencetype\":\"Track\"\r\n },\r\n {\r\n \"referenceid\":\"50c7165591e2efc7\",\r\n \"referencetype\":\"Rate\",\r\n \"referenceoption\":\"Internet/Social, radio, industrial\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"ff22bfbc2c027f5ccc662bcd19e272b0\",\r\n \"referencetype\":\"Track\",\r\n \"referenceoption\":\"Internet/Social, radio, industrial\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n },\r\n {\r\n \"referenceid\":\"50c7165591e2efc7\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"BillingDetails\": {\r\n \"FullName\": \"cs-test-card-update\",\r\n \"CompanyName\": \"company-update\",\r\n \"Address1\": \"addr 1 update\",\r\n \"Address2\": \"addr 2 update\",\r\n \"City\": \"city update\",\r\n \"State\": \"state update\",\r\n \"PostalCode\": \"postal update\",\r\n \"Country\": \"AU\"\r\n },\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\": \"CS-TEST-SUB\",\r\n \"productiondate\": \"2023-08-15T00:00:00\",\r\n \"producer\": \"CS TEST SUB\",\r\n \"length\": \"TEST SUB Length\",\r\n \"po\": \"Purchase Order Number SUB\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Updates 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\".
\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":["updateinvoice","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1e94905c-8780-44c7-819c-b9b74daa7eb3","name":"Update Invoice (PRO w Drop)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"{{InvoiceID}}\",\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Professional}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID2}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID3}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID4}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:33:37 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"66993e7ef8fc4f64\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:33:36.29\",\n \"duedate\": \"2024-06-06T13:33:36.65\",\n \"UTCOffset\": 10,\n \"discount\": 480,\n \"totaltax\": 0,\n \"subtotal\": 1600,\n \"total\": 1120,\n \"invoicenumber\": 1654,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"6d8066ac-b61b-4c61-a5a6-9bc9a4de7b94","name":"Update Invoice (PER w Drop)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"{{InvoiceID}}\",\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Personal}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:50:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"66993e7ef8fc4f64\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:50:48.263\",\n \"duedate\": \"2024-06-06T13:50:48.553\",\n \"UTCOffset\": 10,\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 49,\n \"total\": 49,\n \"invoicenumber\": 1654,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"a277641b-bb6d-494b-b174-e58fa991e562","name":"Update Invoice (PRO with COUPON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}","disabled":true},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"64298d0f0e0aa5cf\",\r\n \"LicensingFor\":\"b31e02b362421e6f\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"039f15ce5f1d5b6b\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"9409b022227aa90d\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"e3d5c96d4eb8982b\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"ba2ddc954bed2aa4\",\r\n \"referencetype\":\"Discount\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"aee17c071c893876\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"9409b022227aa90d\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"e3d5c96d4eb8982b\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"ba2ddc954bed2aa4\",\r\n \"referencetype\":\"Discount\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"a10abd77eaa542a1\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"9409b022227aa90d\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"e3d5c96d4eb8982b\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"ba2ddc954bed2aa4\",\r\n \"referencetype\":\"Discount\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"f652e54b33d734eb\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"9409b022227aa90d\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"e3d5c96d4eb8982b\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"ba2ddc954bed2aa4\",\r\n \"referencetype\":\"Discount\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 04:26:25 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"64298d0f0e0aa5cf\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T14:26:25.89\",\n \"duedate\": \"2024-06-06T14:26:25.95\",\n \"UTCOffset\": 10,\n \"discount\": 800,\n \"totaltax\": 0,\n \"subtotal\": 1600,\n \"total\": 800,\n \"invoicenumber\": 1660,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"56415e08-9a8e-4fca-a32a-1baf94af2474","name":"Update Invoice (PER with COUPON)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"id\": \"580777672371841f\",\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Personal}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"{{HM_Coupon10OFF}}\",\r\n \"referencetype\":\"Discount\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/updateinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 04:27:32 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"66993e7ef8fc4f64\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T14:27:32.5\",\n \"duedate\": \"2024-06-06T14:27:32.56\",\n \"UTCOffset\": 10,\n \"discount\": 9.8,\n \"totaltax\": 0,\n \"subtotal\": 49,\n \"total\": 39.2,\n \"invoicenumber\": 1654,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"5fed6b2f-a264-441a-8524-6a11e43c6516"},{"name":"Add Invoice","event":[{"listen":"test","script":{"id":"07931462-9b4b-4220-bf48-fe6cb6749f7e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = null;","var jsonDataInvoiceID = \"\";","var jsonDataInvoiceTotal = \"\";","","if (responseBody.indexOf(\"= 0) {"," jsonData = xml2Json(responseBody);"," jsonDataInvoiceID = jsonData.responseinvoice.invoice.id;"," jsonDataInvoiceTotal = jsonData.responseinvoice.invoice.total;","} else {"," jsonData = JSON.parse(responseBody)"," if (jsonData.invoice !== null) {"," jsonDataInvoiceID = jsonData.invoice.id;"," jsonDataInvoiceTotal = jsonData.invoice.total;"," }","}","","console.log(\"HM_ServiceAPI_InvoiceID set to \" + jsonDataInvoiceID);","","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceID\", jsonDataInvoiceID);","postman.setEnvironmentVariable(\"HM_ServiceAPI_InvoiceTotal\", jsonDataInvoiceTotal);","","postman.setNextRequest(\"Get Invoice\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c75e1fd7-c9f2-4b5d-af5e-f08799de08fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"a21c9c37e30fb517eefefa288b14270e\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"e796192591975e02\",\r\n \"referencetype\":\"Rate\",\r\n \"referenceoption\":\"Internet/Social\",\r\n \"referenceparentoptionid\":\"0ef87011d7454c73\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvest.music\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"USD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}","description":"Creates 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":"3da02a02-d5bf-484e-b9b7-09f1c5928cef","name":"Add Invoice (PRO w blanket)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\r\n \"invoice\": {\r\n \"LicensingFor\":\"7ef73e68361d5167\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"16ff21fe04dfec0c\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"e6b93746fb6e48d9\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"0a20acb59ba703b0df63efd52d9d1fd0\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"a7cafbf479f13964931a91b4c9bae962\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:28:56 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"66993e7ef8fc4f64\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:28:54.323\",\n \"duedate\": \"2024-06-06T13:28:55.993\",\n \"UTCOffset\": 10,\n \"discount\": 480,\n \"totaltax\": 0,\n \"subtotal\": 1600,\n \"total\": 1120,\n \"invoicenumber\": 1654,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"bfeac9a8-6363-4081-9090-cfc40be6cd1a","name":"Add Invoice (PRO no blanket)","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 \"invoice\": {\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Professional}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Local_InternetSocial}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:28:56 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"66993e7ef8fc4f64\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:28:54.323\",\n \"duedate\": \"2024-06-06T13:28:55.993\",\n \"UTCOffset\": 10,\n \"discount\": 480,\n \"totaltax\": 0,\n \"subtotal\": 1600,\n \"total\": 1120,\n \"invoicenumber\": 1654,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"bb562a98-7884-42c0-a9ac-5d29ce158a6b","name":"Add Invoice (PER w blanket)","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 \"invoice\": {\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Personal}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID2}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID3}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n },\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID4}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:43:00 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"c580a29691600276\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:42:59.657\",\n \"duedate\": \"2024-06-06T13:43:00.003\",\n \"UTCOffset\": 10,\n \"discount\": 39.2,\n \"totaltax\": 0,\n \"subtotal\": 196,\n \"total\": 156.8,\n \"invoicenumber\": 1655,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"fb4eb260-bdf0-484d-8e53-03b478325c9a","name":"Add Invoice (PER no blanket)","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 \"invoice\": {\r\n \"LicensingFor\":\"{{HM_ServiceAPI_LicensingFor_Personal}}\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"{{TrackID1}}\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"{{HM_Rate_Regional_Radio}}\",\r\n \"referencetype\":\"Rate\"\r\n }]\r\n }\r\n ],\r\n \r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Jun 2024 03:45:37 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.0","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": \"8f2e53a2523ab03c\",\n \"memberaccountid\": \"7172c8db5dcd6e02\",\n \"issuedate\": \"2024-06-06T13:45:36.72\",\n \"duedate\": \"2024-06-06T13:45:37.293\",\n \"UTCOffset\": 10,\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 49,\n \"total\": 49,\n \"invoicenumber\": 1656,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {},\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_test_51MjXTGINFIsu1VM9coCRmwphHaoHWhsKVYzGOqNCwNg7EArDLkFlO9bMQIbB6leGxZ8kvrhfha6dTwy8NLxR0CIg00KKMvSCPT\",\n \"ConnectedAccountID\": \"acct_1POAHTRNc4GHwYYw\",\n \"AccountCurrency\": \"AUD\"\n }\n}"},{"id":"d8160733-68a9-4f26-815e-382d6948303a","name":"Add Invoice (w PromoCode)","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 \"invoice\": {\r\n \r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\":\"b3dcaa7fee44b05d0aa221b11bce8b66\",\r\n \"referencetype\":\"Track\"\r\n }, {\r\n \"referenceid\":\"ec676789b1358444\",\r\n \"referencetype\":\"Rate\"\r\n }, {\r\n \"referenceid\":\"207d9e094d264f78\",\r\n \"referencetype\":\"Discount\"\r\n }]\r\n }\r\n ],\r\n \"invoiceproduction\": {\r\n \"client\": \"camila@harvestmedia.net\",\r\n \"title\":\"Production Name\",\r\n\t\t\t\"productiondate\":\"2020-01-08T00:00:00\",\r\n\t\t\t\"producer\":\"Producer Name\",\r\n\t\t\t\"length\":\"Total Production Length\",\r\n\t\t\t\"po\":\"Purchase Order Number\"\r\n },\r\n \"currencycode\": \"AUD\",\r\n \"duedate\": \"2023-12-15T23:59:59\",\r\n \"issuedate\": \"2023-12-15T00:00:00\",\r\n \"paymenttype\": \"CreditCard\"\r\n }\r\n}"},"url":"{{HM_ServiceAPI_URL}}/addinvoice/{{HM_ServiceAPI_MemberToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Jul 2025 04:33:26 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 \"invoice\": {\n \"id\": \"6301a3ff036fe7cd\",\n \"memberaccountid\": \"d3b0eae379e7e2d8\",\n \"issuedate\": \"2025-07-10T14:33:25.87\",\n \"duedate\": \"2025-07-10T14:33:25.947\",\n \"UTCOffset\": 10,\n \"discount\": 157.5,\n \"totaltax\": 0,\n \"subtotal\": 175,\n \"total\": 17.5,\n \"refundedamount\": 0,\n \"invoicenumber\": 306,\n \"status\": \"Pending\",\n \"currencycode\": \"AUD\",\n \"billingdetails\": {\n \"FullName\": \"\",\n \"CompanyName\": \"\",\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Country\": \"\"\n },\n \"blanketdiscount\": false\n },\n \"checkoutkeys\": {\n \"StripeAPIKey\": \"pk_live_51MjXTGINFIsu1VM9JVHrWU3kxWokmJKXrNX7mF7exPdByryYVziz2BnWXBNa8vFPbDVKab5KKbfWtIRAumtgwAWn00juQFO095\",\n \"ConnectedAccountID\": \"acct_1ONSQvITn8N7IvCC\",\n \"AccountCurrency\": \"AUD\"\n }\n}"}],"_postman_id":"c75e1fd7-c9f2-4b5d-af5e-f08799de08fb"},{"name":"Get Invoice Download URL","event":[{"listen":"test","script":{"id":"0a513f1c-9154-434c-9899-236e75a70447","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setNextRequest(\"Get Invoice Document\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"73233924-73e3-4ded-9434-3bf1434623ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"url":"{{HM_ServiceAPI_URL}}/getinvoicedownloadurl/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_InvoiceID}}","description":"Search invoices by amounts and dates.
\nRequest Elements
\nRequest Notes
\n","urlObject":{"path":["getinvoicedownloadurl","{{HM_ServiceAPI_MemberToken}}","{{HM_ServiceAPI_InvoiceID}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"aaf5b542-215f-46dd-ade8-ce9c325b9335","name":"Get Invoice Download URL","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}}/getinvoicedownloadurl/{{HM_ServiceAPI_MemberToken}}/{{HM_ServiceAPI_InvoiceID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Feb 2024 05:34: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 \"Url\": \"https://d2zsljmk3mm9kv.cloudfront.net/CDN/downloads/invoices/e072a9105fd2f362/bd394687-3f7f-4c09-80e6-56a9393f6202/CAMILA_SCHEVENIN DA SILVA_HTN-INV137.pdf\"\n}"}],"_postman_id":"73233924-73e3-4ded-9434-3bf1434623ae"}],"id":"7044d739-0aab-451b-a3a6-060d86c7ab24","_postman_id":"7044d739-0aab-451b-a3a6-060d86c7ab24","description":""},{"name":"Guest Checkout","item":[{"name":"Get Automatic Discounts","item":[{"name":"Get Licensing For","id":"159e5a33-98b0-4073-9754-18cfde98bb28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"url":"{{HM_ServiceAPI_URL}}/GetAutomaticDiscounts/{{HM_ServiceAPI_Token}}","urlObject":{"path":["GetAutomaticDiscounts","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"67c04941-a42d-4dd2-8af0-4dc482c9f706","name":"Get Licensing For","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"url":"{{HM_ServiceAPI_URL}}/GetAutomaticDiscounts/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Jan 2025 20:55:16 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 \"Discounts\": [\n {\n \"ID\": \"3460aac33d9d5974\",\n \"AccountID\": \"e072a9105fd2f362\",\n \"Name\": \"Personal\",\n \"StartDate\": \"2024-06-11 11:05:43\",\n \"Type\": \"Automatic\",\n \"Percentage\": 20,\n \"TriggerValue\": \"3.00\",\n \"TriggerRates\": [],\n \"ApplyToRates\": []\n },\n {\n \"ID\": \"7ef73e68361d5167\",\n \"AccountID\": \"e072a9105fd2f362\",\n \"Name\": \"Professional\",\n \"StartDate\": \"2024-06-11 00:00:00\",\n \"Type\": \"Automatic\",\n \"Percentage\": 30,\n \"TriggerValue\": \"4.00\",\n \"TriggerRates\": [],\n \"ApplyToRates\": []\n }\n ]\n}"}],"_postman_id":"159e5a33-98b0-4073-9754-18cfde98bb28"}],"id":"f59c5927-709a-4a47-bb6e-92a79889b1d7","_postman_id":"f59c5927-709a-4a47-bb6e-92a79889b1d7","description":""},{"name":"Get Pricing Group","item":[{"name":"Get Pricing Groups","id":"68e8499c-6f22-4a68-8534-59951ce801a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"url":"{{HM_ServiceAPI_URL}}/GetPricingGroups/{{HM_ServiceAPI_MemberToken}}?currencycode={{Currency}}","urlObject":{"path":["GetPricingGroups","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"key":"currencycode","value":"{{Currency}}"}],"variable":[]}},"response":[{"id":"80cf2f47-63c0-4d8d-9d48-860a1262b3a5","name":"Get Pricing Groups","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{HM_ServiceAPI_URL}}/GetPricingGroups/{{HM_ServiceAPI_MemberToken}}?currencycode=USD","host":["{{HM_ServiceAPI_URL}}"],"path":["GetPricingGroups","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"currencycode","value":"USD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Jan 2025 20:57: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/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 \"PricingGroups\": [\n {\n \"ID\": \"a89b1466396f7c0a\",\n \"Name\": \"Local\",\n \"Description\": \"Local\",\n \"OrderID\": \"1995\",\n \"Usage\": [\n {\n \"ID\": \"33dcc2c9e4c61682\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Branded Content\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"1f670d6cbb8a9a1b\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Commercial/Ad\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"7e08f8497f4d5497\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Podcast\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"06ae6c0be3f621bf\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Program\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"e67630c40ed47e94\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Promo/PSA\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n }\n ],\n \"Rates\": []\n },\n {\n \"ID\": \"7489bf7337910b83\",\n \"Name\": \"Regional\",\n \"Description\": \"Regional\",\n \"OrderID\": \"1996\",\n \"Usage\": [\n {\n \"ID\": \"33dcc2c9e4c61682\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Branded Content\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"1f670d6cbb8a9a1b\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Commercial/Ad\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"7e08f8497f4d5497\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Podcast\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"06ae6c0be3f621bf\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Program\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n },\n {\n \"ID\": \"e67630c40ed47e94\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Promo/PSA\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n }\n ],\n \"Rates\": []\n },\n {\n \"ID\": \"c1ed8dd27b09165c\",\n \"Name\": \"National/Global\",\n \"Description\": \"National/Global\",\n \"OrderID\": \"1997\",\n \"Usage\": [],\n \"Rates\": []\n },\n {\n \"ID\": \"8470186c6c481489\",\n \"Name\": \"WW Corporate\",\n \"Description\": \"World Wide Corporate\",\n \"OrderID\": \"1867\",\n \"Usage\": [\n {\n \"ID\": \"e76b42cba0034596\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Corporate\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n }\n ],\n \"Rates\": []\n },\n {\n \"ID\": \"9a6c4e855df91aba\",\n \"Name\": \"USA\",\n \"Description\": \"\",\n \"OrderID\": \"1868\",\n \"Rates\": []\n },\n {\n \"ID\": \"0bae631120111bd8\",\n \"Name\": \"WW Digital\",\n \"Description\": \"World Wide Digital\",\n \"OrderID\": \"1873\",\n \"Usage\": [\n {\n \"ID\": \"565d45b7b896e3d3\",\n \"GroupID\": \"3aafb445566fbe34\",\n \"ItemName\": \"Digital\",\n \"Locked\": false,\n \"GroupItemStatus\": \"Active\"\n }\n ],\n \"Rates\": []\n }\n ],\n \"RateTags\": []\n}"}],"_postman_id":"68e8499c-6f22-4a68-8534-59951ce801a5"}],"id":"24f042d8-88c7-4cab-a9f8-e9758e2d9dcd","_postman_id":"24f042d8-88c7-4cab-a9f8-e9758e2d9dcd","description":""},{"name":"Get Rates","item":[{"name":"Get Rates By Tags","id":"955045b4-24ef-46cb-ba4d-45964062290f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Style\": \"Drop\",\r\n \"PricingGroupID\": \"\",\r\n \"currencycode\":\"AUD\",\r\n \"Tags\": [\r\n \"non-monetized\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getratesbytags/{{HM_ServiceAPI_MemberToken}}","description":"This endpoint returns one or multiple rates that applies, depending on the tags provided in the request.
\n","urlObject":{"path":["getratesbytags","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[{"disabled":true,"key":"Authentication","value":"{{HM_ServiceAPI_AuthToken}}"}],"variable":[]}},"response":[{"id":"f46a34bf-e62f-442b-8d1e-d18457bb5ea7","name":"Get Rates By Tags","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Style\": \"Drop\",\r\n \"PricingGroupID\": \"\",\r\n \"currencycode\":\"AUD\",\r\n \"Tags\": [\r\n \"non-monetized\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HM_ServiceAPI_URL}}/getratesbytags/{{HM_ServiceAPI_MemberToken}}?Authentication={{HM_ServiceAPI_AuthToken}}","host":["{{HM_ServiceAPI_URL}}"],"path":["getratesbytags","{{HM_ServiceAPI_MemberToken}}"],"query":[{"key":"Authentication","value":"{{HM_ServiceAPI_AuthToken}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Jan 2025 21:00:10 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 \"Rates\": [\n {\n \"ID\": \"94f27cf3983f8a73\",\n \"Style\": \"Drop\",\n \"Code\": \"DRP015\",\n \"Title\": \"Non-Monetized\",\n \"Description\": \"No\",\n \"Fee\": 49,\n \"FeeWithTax\": 49,\n \"DatetimeStamp\": \"2024-05-24 21:41:38\",\n \"OrderID\": \"14\",\n \"CurrencyCode\": \"AUD\"\n }\n ]\n}"}],"_postman_id":"955045b4-24ef-46cb-ba4d-45964062290f"}],"id":"7913cea9-eff5-4c16-abc2-518f318adc0d","_postman_id":"7913cea9-eff5-4c16-abc2-518f318adc0d","description":""},{"name":"Preview Invoice","item":[{"name":"Preview Invoice","id":"c57cba2a-4141-4620-a0ff-c06ebd7be035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"CountryISO\":\"AU\",\r\n \"LicensingFor\":\"3a4c960a62e75e62\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\": \"3d90090edb748a45\",\r\n \"referencetype\": \"Track\"\r\n },\r\n {\r\n \"referenceid\": \"8e65c0fc032ae6b6\",\r\n \"referencetype\": \"Rate\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/previewinvoice/{{HM_ServiceAPI_Token}}","urlObject":{"path":["previewinvoice","{{HM_ServiceAPI_Token}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f1c57f92-b87f-4814-a966-74ffb5ba1541","name":"Preview Invoice (JSON)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{HM_ServiceAPI_AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"CountryISO\":\"AU\",\r\n \"LicensingFor\":\"3a4c960a62e75e62\",\r\n \"invoicelineitems\": [\r\n {\r\n \"quantity\": 1,\r\n \"description\": \"\",\r\n \"invoiceitemreferences\":[{\r\n \"referenceid\": \"3d90090edb748a45\",\r\n \"referencetype\": \"Track\"\r\n },\r\n {\r\n \"referenceid\": \"8e65c0fc032ae6b6\",\r\n \"referencetype\": \"Rate\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/previewinvoice/{{HM_ServiceAPI_Token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Mar 2025 05:50: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/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 \"issuedate\": \"2025-03-24T16:50:40.8357873+11:00\",\n \"UTCOffset\": 11,\n \"discount\": 0,\n \"totaltax\": 0,\n \"subtotal\": 49,\n \"total\": 49,\n \"blanketdiscount\": false\n}"}],"_postman_id":"c57cba2a-4141-4620-a0ff-c06ebd7be035"}],"id":"54ae9aad-9a66-41a9-a409-debc6071ef19","_postman_id":"54ae9aad-9a66-41a9-a409-debc6071ef19","description":""}],"id":"62085b02-84f7-4912-918c-4493b128e169","description":"Guests will be able to see rates before login so they can decide ahead which product fits best their interests.
\n","_postman_id":"62085b02-84f7-4912-918c-4493b128e169"}],"id":"97c7aa4b-8d64-410b-adbd-e2edf5bb869e","description":"To licensing multiple tracks with multiple rates.
\nHandle members' session provides the ability to store flexible objects as needed by the front-end as it will not be possible to start invoicing when selecting tracks because the rate is not known yet.
\nUse \"SetMemberSession\" to store selected tracks on the page or any other data that will be further needed. You need to provide self-generated GuidID that will be managed by your application.
\nUse \"GetMemberSession\" to retrieve the data stored by providing the GuidID
\nUse \"VoidMemberSession\" to cleanup the session
\nStart Licensing - choose details of the license to get the final rate(s)
\nUse \"GetLicensingFor\" to get options to who this license is for
\nUse \"GetPricingGroups\" to get details of
\nwhere this rate applies at (i.e. for VH, Production Type)
\nthe tags (i.e. for VH, Media Type)
\nWhen all options selected, use \"GetRatesByTags\" to informe the selections and, when applies, the ID of the response provided by \"GetLicensingFor\"
\nYou'll be provided with a single OR multiple rates to be start an invoice for this licensing
\nReponse
\nThe response will contain two URLs.
\nPresignedUploadUrl is the URL to upload the file to. This should be used when PUT the actual file.
ResourceUrl is the URL where the resultant file, once uploaded, will reside.
Allowed content-types are:
\n“.edl”
\nContentType == “text/plain““.csv”
\nContentType == “text/csv““.xml”
\nContentType == “application/xml““.json”
\nContentType == “application/jsonThe FileUrl value is the presigned url you received from Get Upload Url.
\nThe response here will contain an ID value - ObjectID. You will need this in the next step.
\n","urlObject":{"path":["confirmpresignedupload","{{HM_ServiceAPI_MemberToken}}"],"host":["{{HM_ServiceAPI_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f81c0b9f-0a7b-4b35-9f13-b5b537507af5"},{"name":"Get Cuesheet Matches","id":"b5689b3a-0b7b-44c5-9de2-d396b3a48ab2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\"CuesheetID\":\"{confirmUpload.response.objectID}\",\r\n\t\"OutputEmail\": \"peter@harvest.net\",\r\n \"OutputFileName\": \"matched_cuesheet.csv\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HM_ServiceAPI_URL}}/getcuesheetmatch/{{HM_ServiceAPI_MemberToken}}","description":"If the API detects that the request is going to take too long than the output CSV will be send via email to the user using the OutputEmail and OutputFileName. When this happens, the response will be:
\nResponseCode = OK
\nEmailSent = true
\nIf the API detects it can process the request in a timely manner, it will respond with:
\nResponseCode = OK
\nEmailSent = false
\nFullUrl =
\nIf something bad happens, then the response will contain:
\nResponseCode = Error
\nError =
\n