Expand All Collapse All

/icws/{sessionId}/configuration/defaults/recording-beep-tone

GET

/icws/{sessionId}/configuration/defaults/recording-beep-tone

Returns an initialized recordingBeepTone object with default values.
Feature Version
configuration 1

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Response

        200 - OK
        An initialized recordingBeepTone object with defaults is in the response.
        recordingBeepTone
        Represents the recordingBeepTone configuration object.
        Expand AllCollapse All
        Property
        Value
        Comments
        id
        String

        Required

        The unique identifier used to reference this configuration object.
        displayName
        String
        The display name of this configuration object.

        This property can be null.

        uri
        Uri
        A URI used to access this configuration object.
        createdDate
        DateTime
        The date this configuration object was created.

        This is a read only property and can not be changed with PUT or POST operations.

        This property can be null.

        name
        String

        Required

        The key identifying this pair.
        value
        String

        Required

        The value of this pair.

        This property can be null.

        lastModifiedDate
        DateTime
        The date this configuration object was last modified.

        This is a read only property and can not be changed with PUT or POST operations.

        This property can be null.

        notes
        String
        The notes for this configuration object.

        This property can be null.

        toneAmplitudeOne
        Int
        Defines the volume of the first beep in decibels. The value must conform to all of these criteria:
        • Is a value from -33 to 6.

        This property is required to be present in POST operations.

        toneAmplitudeTwo
        Int
        Defines the volume of the second beep in decibels. The value must conform to all of these criteria:
        • Is a value from -33 to 6.

        This property is required to be present in POST operations.

        toneDuration
        Int
        Defines how long in milliseconds that this beep tone will last. The value must conform to all of these criteria:
        • Is a value from 160 to 240.

        This property is required to be present in POST operations.

        toneFrequencyOne
        Int
        Defines the frequency of the first beep in Hertz. The value must conform to all of these criteria:
        • Is a value from 1260 to 1540.

        This property is required to be present in POST operations.

        toneFrequencyTwo
        Int
        Defines the frequency of the second beep in Hertz. The value must conform to at least one of these criteria:
        • Is a value from 1260 to 1540.
        • Is a value from 0 to 0.

        This property is required to be present in POST operations.

        toneInterval
        Int
        Defines the interval between the beeps in the recordings. The value must conform to all of these criteria:
        • Is a value from 10 to 20.

        This property is required to be present in POST operations.

        500 - Internal Server Error
        An unexpected error occurred while processing the request.

        Error Responses

        Error Identifier
        Error Type
        Error Description
        error.request.internalServerError
        Type: urn:inin.com:common:error
        The server encountered an unexpected, internal error.
        Feature Version
        configuration 2
        error.request.timeout
        Type: urn:inin.com:common:error
        The request timed out.
        Feature Version
        configuration 2
        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.
        400 - Bad Request
        The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing 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.
        401 - Unauthorized
        The specified session token is missing, invalid, or has expired.
        Parameters
        Type
        Name
        Comments
        Header
        WWW-Authenticate

        Required

        Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

        WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

          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.