Get Prompts of Application

HTTPS Method

GET

URI

https://<server>/adminapi/application/<ApplicationName>/prompts

https://<server>adminapi/application/<ApplicationName>/prompts?expandFolders

Example URI

https://uccx-server/adminapi/application/CareApplication/prompts

https://uccx-server/adminapi/application/CareApplication/prompts?expandFolders

Accept

Application/XML, Application/JSON

HTTPS Success Code

200

HTTPS Failure Codes

400, 401, 403, 404, 500

Error Codes

Note

Use "expandFolders" query parameter when you want to get all the files that are in the assigned folders.

Success Response


<Prompts>
  <Prompt>
    <Path>nameWithFullPath</Path>
    <Type>file</Type>
  </Prompt>
  <Prompt>
    <Path>nameWithFullPath</Path>
    <Type>folder</Type>
  </Prompt>
</Prompts>

Example without "expandFolders" query parameter


<Prompts>
  <Prompt>
    <Path>en_US/prompt1.wav</Path>
    <Type>file</Type>
  </Prompt>
  <Prompt>
    <Path>en_AU</Path>
    <Type>folder</Type>
  </Prompt>
</Prompts>

Example with "expandFolders" query parameter


<Prompts>
  <Prompt>
    <Path>en_US/prompt1.wav</Path>
    <Type>file</Type>
  </Prompt>
  <Prompt>
    <Path>en_AU</Path
    <Type>folder</Type>
  </Prompt>
  <Prompt>
    <Path>en_AU/prompt2.wav</Path>
    <Type>file</Type>
  </Prompt>
</Prompts>