McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 67

↗ View in doc context
page
67
source
finesse/v12.5/developer-guide/developer-guide.md
chunk_id
finesse::v12.5::developer-guide::developer-guide::51

Users can only act on their own User objects. Security Constraints: PUT HTTP Method: Application/XML Content Type: XML Input/Output Format: <User> <state>NOT_READY</state> <reasonCodeId>1001</reasonCodeId> </User> HTTP Request: id (required): The ID of the user reasonCodeID (required if reason codes are configured for the given state): The database ID for the reason code state (required): The new state the user wants to be in (NOT_READY, LOGOUT) Request Parameters: 202: Successfully Accepted 400: Parameter Missing 400: Invalid Input 400: Invalid State 401: Authorization Failure (for example, the user is not authenticated in the Web Session) 401: Invalid Authorization Specified (for example, the authenticated user tried to make a request for another user) HTTP Response: <ApiErrors> <ApiError> <ErrorType>Parameter Missing</ErrorType> <ErrorData>state</ErrorData> <ErrorMessage>State Parameter missing</ErrorMessage> </ApiError> </ApiErrors> Example Failure Response: User notification Notifications Triggered: 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. https://<FQDN>/finesse/api/User/<id>/ReasonCode/<reasonCodeId> URI: https://finesse1.xyz.com/finesse/api/User/1234/ReasonCode/12 Example URI: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 51 Cisco Finesse Desktop APIs User—Get Reason Code