User—Get Wrap-Up Reason

This API allows a user to get a WrapUpReason object.

For more information about the WrapUpReason object, see WrapUpReason.

URI:

http://<FQDN>/finesse/api/User/<id>/WrapUpReason/<wrapUpReasonId>

Example URI:

http://finesse1.xyz.com/finesse/api/User/1234/WrapUpReason/1001

Security Constraints:

Administrators, agents, and supervisors can use this API.

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

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

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

HTTP Response:

200: Success

400: Bad Request (the request body is invalid)

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: Not Found (for example, the wrap-up reason does not exist or has been deleted)

500: Internal Server Error

Example Response:

<WrapUpReason>
   <uri>finesse/api/User/1234/WrapUpReason/205</uri>
   <label>Product Question</label>
   <forAll>true</forAll>
</WrapUpReason>

Example Failure Response:

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