Expand All Collapse All

/icws/{sessionId}/directories/speed-dial

Feature Version
directories 10

POST

/icws/{sessionId}/directories/speed-dial

Create a speed dial directory.

Note

primaryNumber property and admin property of accessRights object should be ignored for creating the directory. For public access, read property of accessRights should be used. create/update/delete properties of accessRights object should be used to create/change/delete contact entries.

Feature Version
directories 10

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.

        Representations
        directoryParameters
        Expand AllCollapse All
        Property
        Value
        Comments
        name
        String

        Required

        The directory's name.
        read
        Boolean
        Permission to read a directory.
        create
        Boolean
        Permission to create a new directory.
        update
        Boolean
        Permission to update a directory.
        delete
        Boolean
        Permission to delete a directory.
        rename
        Boolean
        Permission to rename a directory.
        primaryNumber
        Boolean
        Permission to access a primary number designation.
        admin
        Boolean
        Administrative rights to a directory.

        Response

        201 - Created
        The speed dial directory was successfully created. The new speed dial's directoryId is returned in the response.
        directoryCreated
        Expand AllCollapse All
        Property
        Value
        Comments
        directoryId
        String

        Required

        The created directory's ID.
        403 - Forbidden
        The session user does not have permission to create a speed dial directory.
        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.
          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.