The audiofile object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this audiofile |
BusinessId: Id required |
Description: string optional |
Name: string required |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this audiofile |
SystemId: string optional api-only
User defined data about this audiofile. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"Description": "Abc123456",
"Name": "00001",
"UniqueId": "c44a03de-d3e0-4021-bc45-50dee8a75cae",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a AudioFile
This endpoint allows you to GET a list of audiofiles based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/content/audiofiles?...
π Requires role "AudioFile-List"
Pagination querystring parameters
Lets control how many records to return at a time and their order. |
page integer optional
?page=1 |
size integer optional default=25
Sets the maximum number of records to return each page of results. ?size=25 |
orderby string optional default=Id
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search audiofile records based on their different properties. |
Id number
?Id=12345678 |
AudioFile_Business Business
?AudioFile_Business=... |
AudioFile_Description string
?AudioFile_Description=... |
AudioFile_Name string
?AudioFile_Name=... |
Range search querystring parameters
Lets you search audiofile records based on a range of date or numeric values. |
To_AudioFile_CreatedOn date
?To_AudioFile_CreatedOn=2010-01-01T20:32 |
From_AudioFile_CreatedOn date
?From_AudioFile_CreatedOn=2010-01-01T20:32 |
To_AudioFile_UpdatedOn date
?To_AudioFile_UpdatedOn=2010-01-01T20:32 |
From_AudioFile_UpdatedOn date
?From_AudioFile_UpdatedOn=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/content/audiofiles?AudioFile_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "00001",
"Description": "Abc123456",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "d286656c-1b5f-45b6-96f8-1ed12d5ceeac",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 25,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 60,
"TotalPages": 3
}
Find AudioFiles by IDs
Gets one or more audiofile records based on their Id.GET https://spaces.nexudus.com/api/content/audiofiles?AudioFile_Id=[:id1,:id2,...]
π Requires role "AudioFile-List"
Querystring parameters |
AudioFile_Id: array requried
?AudioFile_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/content/audiofiles?AudioFile_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "00001",
"Description": "Abc123456",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "f5920817-e29c-41be-8ed6-0913069ba1d4",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single AudioFile by Id
Gets one audiofile record by its Id.GET https://spaces.nexudus.com/api/content/audiofiles/:Id
π Requires role "AudioFile-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/content/audiofiles/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"Description": "Abc123456",
"Name": "00001",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "e21ef237-12fb-452e-9a43-d678dcd9d057",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new AudioFile
Creates a new audiofile.POST https://spaces.nexudus.com/api/content/audiofiles
π Requires role "AudioFile-Create"
Body parameters |
BusinessId: number required |
Name: string required |
Description: string optional |
Example request
POST https://spaces.nexudus.com/api/content/audiofiles Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "00001",
"Description": "Abc123456",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully created.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Update AudioFile
Updates an existing audiofile.PUT https://spaces.nexudus.com/api/content/audiofiles
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "AudioFile-Edit"
Body parameters |
Id: number required
The unique Id of the audiofile to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
Description: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/content/audiofiles Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "00001",
"Description": "Abc123456",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully updated.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Delete AudioFile
Deletes an existing audiofile by its Id.DELETE https://spaces.nexudus.com/api/content/audiofiles/:Id
π Requires role "AudioFile-Delete"
URL parameters |
Id: number required
The unique Id of the audiofile to update. |
Example request
DELETE https://spaces.nexudus.com/api/content/audiofiles/12345678 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "The record was deleted successfully.",
"Value": null,
"OpenInDialog": false,
"RedirectURL": null,
"JavaScript": null,
"Errors": null
}
Commands
Commands allow to perform actions against one or more audiofile records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.Get Commands
Get all commands available to run for audiofile records.GET https://spaces.nexudus.com/api/content/audiofiles/commands
Example request
GET https://spaces.nexudus.com/api/content/audiofiles/commands Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
[
{
"Key": "COMMAND_KEY_1",
"Name": "Command 1 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": false,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": false,
"NeedsEntitiesToRun": true,
"Order": 2,
"RequiresParameters": []
},
{
"Key": "COMMAND_KEY_2",
"Name": "Command 2 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": true,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": true,
"NeedsEntitiesToRun": true,
"Order": 10,
"RequiresParameters":
[
{
"Name": "Parameter 1 description",
"Type": "string",
},
{
"Name": "Parameter 2 description",
"Type": "Boolean",
}
]
},
...
]
Run Command
Runs a command based on its Key and one or more audiofile record IDs.POST https://spaces.nexudus.com/api/content/audiofiles/runacommandπ Requires role "AudioFile-Edit"
Example request
POST https://spaces.nexudus.com/api/content/audiofiles/runcommand Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Ids":[1329961649],
"Parameters":
[
{
"Type": "string"
"Value":987654321
},
{
"Type": "Boolean",
"Value":true
},
...
],
"Key":"COMMAND_KEY_2"
}
Example valid response
{
"Errors": null
"JavaScript": null
"Message": "Result description"
"OpenInDialog": false
"OpenInWindow": false
"RedirectURL": null
"Status": 200
"UpdatedBy": "email@example.net"
"UpdatedOn: "2020-06-04T11:40:20Z"
"Value: {Id: 12345678}
"WasSuccessful: true
}
Binary files
The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.
Audio
GET https://spaces.nexudus.com/api/content/audiofiles/getaudio/:id
URL parameters |
Id: number required
The id of the AudioFile to get the audio for. |
Comments
Please sign in to leave a comment.