User—Get Wrap-Up Reason List

This API allows a user to get a list of all wrap-up reasons applicable for that user.

For more information about the WrapUpReason object, see WrapUpReason.

URI:

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

Example URI:

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

Security Constraints:

Administrators, agents, and supervisors can use this API.

To get a list of wrap-up reasons, a user must be signed in, or provide valid authorization credentials when challenged.

Only an administrator can get another user's list of wrap-up reasons.

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

HTTP Response:

200: Success

400: Finesse API Error (for example, the object does not exist, the object is stale, or violation of DB constraint)

401: Authorization Failure

401: Invalid Authorization User Specified

404: User Not Found

500: Internal Server Error

Example Response:

<WrapUpReasons>
  <WrapUpReason>
    <label>Successful tech support call</label>
    <forAll>true</forAll>
    <uri>/finesse/api/User/1234/WrapUpReason/12</uri>
  </WrapUpReason>
    ... more wrap-up reasons ...
</WrapUpReasons>

Example Failure Response:

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