Music API

Section: Releases

This section performs operations against Releases

Available Resource List

Action Type Resource Description
Create Comment http://api.dmds.com/api/v1/music/releases/{releaseID}/comments Resource for creating a comment on a specific releaseID
Create Approval http://api.dmds.com/api/v1/music/releases/{releaseID}/approvals Resource for creating an approval on a specific releaseID
Set Organization Asset Status http://api.dmds.com/api/v1/music/releases/{releaseID}/files/{fileID}/organizationassetstatus Resource for setting an organization asset status (review status) specific to the releaseID, fileID, and organization.
Get File Status Information http://api.dmds.com/api/v1/music/releases/{releaseID}/files/{fileID}/filestatusinformation Resource for getting asset status (review status) and submission status specific to the releaseID, fileID.
Set House ID http://api.dmds.com/api/v1/music/releases/{releaseID}/files/{fileID}/houseid Resource for setting a house ID specific to the releaseID, fileID, and organization.


Create Comment

Http Operations Supported

  • POST

HTTP POST Resource URI

  • POST http://api.dmds.com/api/v1/music/releases/{releaseID}/comments

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Location Parameter Type Description Examples
releaseID URI Numeric The releaseID to create the comment for 11, 123
CommentPosterName POST Data String The optional commenter name. Defaults to the contact or organization name associated with the API Key. Max. of 50 Characters. John Smith, Jane Brown
CommentPosterText POST Data String The comment text data. Basic HTML tags are supported. Max. of 4000 characters. This is a test <em>comment<em>, Please <b>update<b> captions

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema





Create Approval

Http Operations Supported

  • POST

HTTP POST Resource URI

  • POST http://api.dmds.com/api/v1/music/releases/{releaseID}/approvals

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Location Parameter Type Description Examples
releaseID URI Numeric The releaseID to create the approval for 11, 123
CommentPosterName POST Data String The optional approver name. Defaults to the contact or organization name associated with the API Key. Max. of 50 Characters. John Smith, Jane Brown
CommentPosterText POST Data String The approval text data. Basic HTML tags are supported. Max. of 4000 characters. This is a test <em>approval<em>, This video is <b>approved<b>

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema





Set Organization Asset Status

Http Operations Supported

  • PUT

HTTP PUT Resource URI

  • PUT http://api.dmds.com/api/v1/music/releases/{releaseID}/files/{fileID}/organizationassetstatus

Resource Parameters

Parameter Location Parameter Type Description Examples
releaseID URI Numeric The releaseID to set the organization asset status for 11, 123
fileID URI Numeric The fileID (DMDS ID) to set the organization asset status for 11, 123
Status POST Data String The organization asset status being set. Must match an existing configured status in DMDS. Max. of 100 Characters. Reviewed, Submitted
Organizations (optional) POST Data String array The organization(s) to set the organization asset status for. Specified organizations must be set up for group access in DMDS. If not specified then it will be default to the organization directly associated with your API Key. Yangaroo, DMDS

Example Organization Asset Status XML Post Data

Posting status "Cleared" for organizations "Yangaroo" and "DMDS"

 
    <OrganizationAssetStatus>
	    <Status>Cleared</Status>
	    <Organizations>
		    <Organization>Yangaroo</Organization>
		    <Organization>DMDS</Organization>
	    </Organizations>
    </OrganizationAssetStatus>

Posting status "Accepted" without specifying an organization

 
    <OrganizationAssetStatus>
	    <Status>Accepted</Status>
    </OrganizationAssetStatus>




Get File Status Information

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/music/releases/{releaseID}/files/{fileID}/filestatusinformation

Resource Parameters

Parameter Location Parameter Type Description Examples
releaseID URI Numeric The releaseID to get the statuses for 11, 123
fileID URI Numeric The fileID (DMDS ID) to get the statuses for 11, 123




Set House ID

Http Operations Supported

  • PUT

HTTP PUT Resource URI

  • PUT http://api.dmds.com/api/v1/music/releases/{releaseID}/files/{fileID}/houseid

Resource Parameters

Parameter Location Parameter Type Description Examples
releaseID URI Numeric The releaseID to set the House ID for 11, 123
fileID URI Numeric The fileID (DMDS ID) to set the House ID for 11, 123
HouseID POST Data String The House ID being set. Max. of 25 Characters. Z12345678, ASDF1234
Organizations (optional) POST Data String array The organization(s) to set the house ID for. Specified organizations must be set up for group access in DMDS. If not specified then it will be default to the organization directly associated with your API Key. Yangaroo, DMDS

Example House ID XML Post Data

Posting house ID "ABC12345" for organizations "Yangaroo" and "DMDS"

 
    <HouseIDData>
	    <HouseID>ABC12345</HouseID>
	    <Organizations>
		    <Organization>Yangaroo</Organization>
		    <Organization>DMDS</Organization>
	    </Organizations>
    </HouseIDData>

Posting house ID "DEF09876" without specifying an organization

 
    <HouseIDData>
	    <HouseID>DEF09876</HouseID>
    </HouseIDData>




API Reference