Expand All Collapse All

/icws/web-callback/exit/{participantId}

POST

/icws/web-callback/exit/{participantId}

Disconnects a participant from an existing callback session.

Feature Version
web-callback 2

Request

Parameters
Type
Name
Comments
Template
participantId

Required

The participant ID on which the request is being made on behalf of.

    Response

    204 - No Content
    The disconnect was successful.
    400 - Bad Request
    This may indicate that the disconnect from the callback was not able to be processed.

    Error Responses

    Error Identifier
    Error Type
    Error Description
    error.request.webCallback.invalidParticipantId
    Type: urn:inin.com:common:error
    The request failed because the participant ID is unknown or invalid.
    error
    Provides additional detail for an error.
    Expand AllCollapse All
    Property
    Value
    Comments
    errorId
    String
    The error identifier that describes the current error.
    message
    String

    Required

    A message that describes the current error.
    410 - Gone
    This resource has been deprecated and removed from the API.
    error
    Provides additional detail for an error.
    Expand AllCollapse All
    Property
    Value
    Comments
    errorId
    String
    The error identifier that describes the current error.
    message
    String

    Required

    A message that describes the current error.
    500 - Internal Server Error
    An unexpected error occurred while processing the request.
    error
    Provides additional detail for an error.
    Expand AllCollapse All
    Property
    Value
    Comments
    errorId
    String
    The error identifier that describes the current error.
    message
    String

    Required

    A message that describes the current error.