Digital Files/Downloads
This is used to view, create, update and delete digital download files.
Digital Files Properties
| id |
{ "id" : 298713 }
The unique ID of the digital file |
| created |
{ "created": "Wed, 18 Jul 2018 07:08:24 +0000" }
The date the digital file was created |
| name |
{ "name": "Rita Ora - Anywhere" }
The name given to the digital file |
| extension |
{ "extension": "mp3" }
The file extension of the digital file |
| tag |
{ "tag": "Rita Ora" }
Any tags given to the digital file |
| sourceUrl |
{ "sourceUrl": "https://www.domain.com/files/rita-ora-anywhere.mp3" }
If the file is externally hosted, the URL of the file. Can only be set for externally hosted digital files |
| isUploaded |
{ "isUploaded": false }
Set to true if the digital file is uploaded to the platform, or false if it's externally hosted |
What you can do with digital files
GET /v1/digital-files
Receive a list of all digital files
GET /v1/digital-files/ID
Receive a single digital file
POST /v1/digital-files
Create a new digital file
PUT /v1/digital-files/ID
Update a digital file
DELETE /v1/digital-files/ID
Delete a digital-file
GET /v1/digital-files
Returns all digital files
GET /v1/digital-files
HTTP/1.1 200 OK
[
{
"id": 298713,
"created": "Wed, 18 Jul 2018 07:08:24 +0000",
"name": "Rita Ora - Anywhere",
"extension": "mp3",
"tag": "rita ora",
"sourceUrl": "https://www.domain.com/files/rita-ora-anywhere.mp3",
"isUploaded": false
},
{
"id": 274632,
"created": "Wed, 01 Jul 2018 20:55:49 +0000",
"name": "Rita Ora - I Will Never Let You Down",
"extension": "mp4",
"tag": "rita ora",
"sourceUrl": "",
"isUploaded": true
}
]
GET /v1/digital-files/ID
Returns a single digital file
GET /v1/digital-files/298713
HTTP/1.1 200 OK
{
"id": 298713,
"created": "Wed, 18 Jul 2018 07:08:24 +0000",
"name": "Rita Ora - Anywhere",
"extension": "mp3",
"tag": "rita ora",
"sourceUrl": "https://www.domain.com/files/rita-ora-anywhere.mp3",
"isUploaded": false
}
POST /v1/digital-files
Creates a new digital file. name, extension and sourceUrl are required.
| sourceUrl | Only externally hosted digital files can be created, sourceUrl cannot be empty |
| tag | Is optional |
POST /v1/digital-files
POST /v1/digital-files
{
"name": "Rita Ora - Your Song",
"extension": "mp4",
"tag": "rita ora",
"sourceUrl": "https://www.domain.com/files/rita-ora-your-song.mp4",
}
POST /v1/digital-files
HTTP/1.1 201 Created
{
"id": 298714,
"created": "Wed, 18 Jul 2018 09:18:29 +0000",
"name": "Rita Ora - Your Song",
"extension": "mp4",
"tag": "rita ora",
"sourceUrl": "https://www.domain.com/files/rita-ora-your-song.mp4",
"isUploaded": false
}
PUT /v1/digital-files/ID
Update a digital file
PUT /v1/digital-files/298714
PUT /v1/digital-files/298714
{
"sourceUrl": "https://www.domain.com/files/rita-ora-your-song-2.mp4"
}
PUT /v1/digital-files/298714
HTTP/1.1 200 OK
{
"id": 298714,
"created": "Wed, 18 Jul 2018 09:18:29 +0000",
"name": "Rita Ora - Your Song",
"extension": "mp4",
"tag": "rita ora",
"sourceUrl": "https://www.domain.com/files/rita-ora-your-song-2.mp4",
"isUploaded": false
}
DELETE /v1/digital-files/ID
Deletes an existing digital file.
Returns 204 No Content on success.