HierarchyNodeResource Resource

GET /hierarchynodes

Returns all hierarchy nodes optionally filtered by one or more available filtering options.

Request Parameters
name type description
hierarchyNodeIds query a String holding one or more hierarchy node ids (separated by comma) for which corresponding hierarchy nodes are to be returned.
Response Codes
code condition
200 Hierarchy nodes were returned.
400 One or more required arguments were not provided.
404 The provided library id does not correspond to an available library.
500 An error occured.
Response Body
media type data type description
application/xml;charset=utf-8 (custom) zero or more SerialHierarchyNode.

Example

Request
GET /hierarchynodes
Content-Type: */*
Accept: application/xml;charset=utf-8

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml;charset=utf-8

                
...
                
              

POST /hierarchynodes/{hierarchyNodeId}/prepare

Request an hierarchynode to be prepared for download

Request Parameters
name type description
X-Callback-Url header A full URL which will be requested using the GET method upon completion.
X-Company-Name header A base64 encoded company name which is to be written to audio file metadata
X-Composer-Prefix header A base64 encoded prefix to prepend to metadata composer details
X-External-User-ID header An integer representing an external user ID
X-File-Quality header The file AudioFile.Quality which is to be used. Defaults to High
X-File-Type header The file AudioFileType which is to be used. Defaults to MP3
X-Filename-Format header The FilenameFormat by which filenames will be generated. Defaults to Default
X-Filename-Prefix header A base64 encoded prefix to prepend to filenames
X-Territory-ID header A UUID representing the territory context representing an external user ID
X-Title header A base64 encoded title for the download preparation
hierarchyNodeId path a String holding an id which represents the hierarchynode which is to be prepared for download
Response Codes
code condition
202 The hierarchynode is being prepared for download
404 The hierarchynode does not exist
500 An error occured
Response Body
media type data type description
application/xml;charset=utf-8 (custom)

Example

Request
POST /hierarchynodes/{hierarchyNodeId}/prepare
Content-Type: */*
Accept: application/xml;charset=utf-8
X-Callback-Url: ...
X-Company-Name: ...
X-Composer-Prefix: ...
X-External-User-ID: ...
X-File-Quality: ...
X-File-Type: ...
X-Filename-Format: ...
X-Filename-Prefix: ...
X-Territory-ID: ...
X-Title: ...

                
...
                
              
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml;charset=utf-8

                
...