User—Get Reason Code

This API allows an agent or supervisor to get an individual Not Ready or Sign Out reason code, which is already defined and stored in the Finesse database (and that is applicable to the agent or supervisor).

Users can select the reason code to display on their desktops when they change their state to NOT_READY or LOGOUT.

For more information about the ReasonCode object, see section on ReasonCode.

URI:

https://<FQDN>/finesse/api/User/<id>/ReasonCode/<reasonCodeId>

Example URI:

https://finesse1.xyz.com/finesse/api/User/1234/ReasonCode/12

Security Constraints:

Administrators, agents, and supervisors can use this API.

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

The reason code must be global (forAll parameter set to true) or be assigned to a team to which the user belongs.

Only an administrator can get another user's reason codes.

HTTP Method:

GET

Content Type:

—

Input/Output Format:

XML

HTTP Request:

—

HTTP Response:

200: Success

400: Bad Request

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 reason code does not exist or has been deleted)

500: Internal Server Error

Example Response: 

<ReasonCode>
   <uri>finesse/api/ReasonCode/1</uri>
   <category>NOT_READY</category>
   <code>12</code>
   <label>Lunch</label>
   <forAll>true</forAll>
</ReasonCode>

Example Failure Response: 

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