User—Get List of Dialogs

This API allows an agent or administrator to get a list of dialogs associated with a particular user.

For more information about the Dialog object, see Dialog.

URI:

http://<FQDN>/finesse/api/User/<id>/Dialogs

Example URI:

http://finesse1.xyz.com/finesse/api/User/1234/Dialogs

Security Constraints:

Agents can only get a list of their own dialogs. Administrators can get a list of dialogs associated with any user.

To get a list of dialogs, a user must be signed in, or provide valid authorization credentials when challenged.

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

HTTP Response:

200: Success

401: Authorization Failure

500: Internal Server Error

Example Response:

<Dialogs>
    <Dialog>
       ... Full Dialog Object ...
    </Dialog>
    <Dialog>
       ... Full Dialog Object ...
    </Dialog>
    <Dialog>
       ... Full Dialog Object ...
    </Dialog>
    <Dialog>
       ... Full Dialog Object ...
    </Dialog>
    <Dialog>
       ... Full Dialog Object ...
    </Dialog>
       ... Additional Dialogs...
</Dialogs>

Example Failure Response:

<ApiErrors>
   <ApiError>
      <ErrorType>Authorization Failure</ErrorType>
      <ErrorMessage>UNAUTHORIZED</ErrorMessage>
      <ErrorData>jsmith</ErrorData>
   </ApiError>
</ApiErrors>