updateSoundFiles

Request Method: PUT

Description: Updates one or more SoundFile(s)

URL: https://api.iovox.com:444/SoundFiles?v=3&method=updateSoundFiles

The following parameters must be sent in the querystring:

ParameterDescriptionDefault ValueData TypeMandatory
vAPI version to use
INTEGERYES

Payload

The following XML payload must be sent with an updateSoundFiles request:

<?xml version="1.0" encoding="utf-8"?>
<request>

   <sound_file>
     <sound_label>Sound File 1</sound_label>
     <new_sound_label>Sound File 1 Updated</new_sound_label>
     <sound_group>Sound Group 1</sound_group>
     <new_sound_group>Sound Group 1 Updated</new_sound_group>
     <!-- sound_file will contain the binary data, base64 encoded, of the sound file you want to create. //-->
     <sound_file></sound_file>
     <notes>Updated notes are even more awesome!</notes>
   </sound_file>
   <sound_file>
     <sound_label>Sound File 1</sound_label>
     <new_sound_label>Sound File 1 Updated</new_sound_label>
     <sound_group>Sound Group 1</sound_group>
     <notes>New notes!!!!!</notes>
   </sound_file>
   <sound_file>
     ...
   </sound_file>
   ...

 </request>

Payload Description:

Node NameDescriptionDefault ValueData TypeMandatory
sound_file > sound_label Together with the sound group this will be the identifier of the existing sound file
STRINGYES
sound_file > new_sound_label A new, updated sound label
STRINGNO
sound_file > sound_group Together with the sound label this will be the identifier of the existing sound file
STRINGNO
sound_file > new_sound_group A new, updated sound group
STRINGNO
sound_file > sound_file Base64 encoded binary data of the updated sound file
STRINGNO
sound_file > notesAny notes associated with the sound file
STRINGNO

Result

Error Result

HTTP CodeError StringResolution
400API Version EmptyAdd a value for the v parameter in the query string
400API Version InvalidCorrect v parameter
400Request Method must be PUT. x attemptedSwitch request method x to PUT
400XML EmptyAdd xml to the request body
400XML parse error. x at line y, column zCorrect XML at point x on line y, column z
400Request EmptyAdd at least one contact to the request
400Sound Label x of y Empty Add sound_label to sound_file x (item) of y (total)
400Sound File x of y Does not exist Create or remove sound file x (item) of y (total)
400Sound Label x of y already exists in Sound Group Remove or change sound_label x (item) of y (total)
400Sound Group x of y Forbidden Change sound_group x (item) of y (total)
400Sound File x of y Empty Add in sound_file base64 encoded binary data for sound_file x (item) of y (total)
400Sound File x of y Exceeds maximum allowed filesize Change sound_file x (item) of y (total) to a smaller filesize file
400Duplicate Sound File Received Remove any duplicate sound_label and sound_group combinations from the XML
500Internal Server ErrorRetry later

Success Result

HTTP/1.1 204 No Content