/mcpPath Parameter A path parameter is included in the path of the URI. In the following example, dialogId is a path parameter. https://<FQDN>:<port>/finesse/api/Dialog/<dialogId> Query Parameter A query parameter is passed in a query string on the end of the URI you are calling. The query parameter is preceded by a question mark. Multiple query parameters are connected by an ampersand (&). In the following example, category is a query parameter. https://<FQDN>:<port>/finesse/api/User/<id>/ReasonCodes?category=NOT_READY Data Types The following table lists the data types used in API parameters and notification message fields. Description Type A logical data type that has one of two values: true or false. Boolean A 32-bit wide integer. Integer A 64-bit wide integer. Long A variable-length string. If a maximum length exists, it is listed with the parameter description. String Cisco Finesse API Errors Error codes for Cisco Finesse are categorized as follows: • 4xx—Client-related error • 5xx—Server-related error Each error includes a failure response, error type, error message, and error data. The following is an example of a failure message format: <ApiErrors> <ApiError> <ErrorType>Authentication Failure</ErrorType> <ErrorMessage>UNAUTHORIZED</ErrorMessage> <ErrorData>jsmith</ErrorData> </ApiError> </ApiErrors> In addition to Cisco Finesse API errors, a response may return a CTI error or an HTTP error. Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 10 Introduction Cisco Finesse API Errors