Package com.mypurecloud.sdk.v2.model

Class UserRoutingStatusErrorInfo

java.lang.Object
com.mypurecloud.sdk.v2.model.UserRoutingStatusErrorInfo
All Implemented Interfaces:
Serializable
public class UserRoutingStatusErrorInfo extends Object implements Serializable
Error information that the Public API will receive in a response body. This allows backend services to pass an error message to consumers of the Public API.
See Also:

  • Constructor Details

    • UserRoutingStatusErrorInfo

      public UserRoutingStatusErrorInfo()

    • UserRoutingStatusErrorInfo

      public UserRoutingStatusErrorInfo(Boolean initWithEmptyList)

  • Method Details

    • errorCode

      public UserRoutingStatusErrorInfo errorCode(String errorCode)
      A code unique to this error. Typically prefixed with the service that originated the error. For example CONFIG_USER_NOT_FOUND

    • getErrorCode

      public String getErrorCode()

    • setErrorCode

      public void setErrorCode(String errorCode)

    • status

      public UserRoutingStatusErrorInfo status(Long status)
      The HTTP status code for this message. If left blank the status code from the HTTP response is used.

    • getStatus

      public Long getStatus()

    • setStatus

      public void setStatus(Long status)

    • correlationId

      public UserRoutingStatusErrorInfo correlationId(String correlationId)
      The correlation Id or context Id for this message. If left blank the Public API will look at the HTTP response header 'ININ-Correlation-Id' instead.

    • getCorrelationId

      public String getCorrelationId()

    • setCorrelationId

      public void setCorrelationId(String correlationId)

    • userMessage

      public UserRoutingStatusErrorInfo userMessage(String userMessage)
      A customer friendly message. This should be a complete sentence, use proper grammar and only include information useful to a customer. This is not a dev message and should not include things like Org Id

    • getUserMessage

      public String getUserMessage()

    • setUserMessage

      public void setUserMessage(String userMessage)

    • userParamsMessage

      public UserRoutingStatusErrorInfo userParamsMessage(String userParamsMessage)
      This is the same as userMessage except it uses template fields for variable replacement. For instance: 'User {username} was not found'

    • getUserParamsMessage

      public String getUserParamsMessage()

    • setUserParamsMessage

      public void setUserParamsMessage(String userParamsMessage)

    • userParams

      public UserRoutingStatusErrorInfo userParams(List<UserRoutingStatusUserParam> userParams)
      Used in conjunction with userParamsMessage. These are the template parameters. For instance: UserParam.key = 'username', UserParam.value = 'chuck.pulfer'

    • getUserParams

      public List<UserRoutingStatusUserParam> getUserParams()

    • setUserParams

      public void setUserParams(List<UserRoutingStatusUserParam> userParams)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object