/icws/{sessionId}/directories/contacts/{directoryID}/{entryID}

PUT

/icws/{sessionId}/directories/contacts/{directoryID}/{entryID}

Update a directory contact entry.
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.

        Template
        directoryID

        Required

        The directory's ID.

          Template
          entryID

          Required

          The directory contact's entry ID.

            Representations
            editableContactEntry
            Property
            Value
            Comments
            __type
            "urn:inin.com:directories:editableContactEntry"

            Required

            The JSON type representing this option.
            read
            Boolean
            Permission to read a contact entry.
            create
            Boolean
            Permission to create a contact entry.
            update
            Boolean
            Permission to update a contact entry.
            delete
            Boolean
            Permission to delete a contact entry.
            assistant
            String
            The name of the contact's assistant or subordinate.
            businessAddress
            String
            The contact's business address.
            businessCity
            String
            The contact's business city.
            businessCountry
            String
            The contact's business country.
            businessEmail
            String
            The contact's business email address.
            businessState
            String
            The contact's business state.
            businessZipCode
            String
            The contact's business zip code.
            company
            String
            The company that this contact works for.
            department
            String
            The department that this contact works in.
            displayName
            String
            The contact's display name. Usually this is Lastname, Firstname.
            firstName
            String
            The contact's first name.
            homeAddress
            String
            The contact's number and street, apartment, etc.
            homeCity
            String
            The home address city.
            homeCountry
            String
            The country associated with the contact's home address.
            homeEmail
            String
            The contact's personal Email address.
            homeState
            String
            The state where the home is located.
            homeZipCode
            String
            The home address zip code.
            lastName
            String
            The contact's last name.
            notes
            String
            The note text, if any, that is stored in this contact entry.
            none
            -1
            Identifies that there is no default phone number designated.
            Feature Version
            directories 7
            extension
            0
            Identifies the extension field as the default phone number.
            businessPhone
            1
            Identifies the business phone field as the default phone number.
            businessPhone2
            2
            Identifies the business phone 2 field as the default phone number.
            homePhone
            3
            Identifies the home phone field as the default phone number.
            homePhone2
            4
            Identifies the home phone 2 field as the default phone number.
            mobilePhone
            5
            Identifies the mobile phone field as the default phone number.
            faxPhone
            6
            Identifies the fax phone field as the default phone number.
            pagerPhone
            7
            Identifies the page phone field as the default phone number.
            assistantPhone
            8
            Identifies the assistant phone field as the default phone number.
            statusURI
            String
            The contact's Status URI.
            title
            String
            The contact's job title.
            baseNumber
            String
            The phone number.
            extension
            String
            The extension.
            autoDialable
            Boolean
            Whether or not the extension is a auto dialable.
            readOnlyContactEntryId
            String

            Required

            The readOnlyEntryId is a unique identifier for a contact in the given directoryId. It is not globally unique across all directories. This is used when adding contacts to workgroup and speed dial directories. These types of directories contain only entries that are actually contacts in another directory, i.e. the Company Directory, or IC Public/Private Contacts.
            readOnlyDirectoryId
            String

            Required

            The ID of the directory that actually contains the readOnlyEntryId.
            none
            -1
            Identifies that there is no default phone number designated.
            Feature Version
            directories 7
            extension
            0
            Identifies the extension field as the default phone number.
            businessPhone
            1
            Identifies the business phone field as the default phone number.
            businessPhone2
            2
            Identifies the business phone 2 field as the default phone number.
            homePhone
            3
            Identifies the home phone field as the default phone number.
            homePhone2
            4
            Identifies the home phone 2 field as the default phone number.
            mobilePhone
            5
            Identifies the mobile phone field as the default phone number.
            faxPhone
            6
            Identifies the fax phone field as the default phone number.
            pagerPhone
            7
            Identifies the page phone field as the default phone number.
            assistantPhone
            8
            Identifies the assistant phone field as the default phone number.

            Response

            204 - No Content
            The directory contact entry was successfully updated.
            403 - Forbidden
            The session user does not have permission to update this contact entry.
            Feature Version
            directories 8
            error
            Provides additional detail for an error.
            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.
            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.
              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.
              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.
              Property
              Value
              Comments
              errorId
              String
              The error identifier that describes the current error.
              message
              String

              Required

              A message that describes the current error.

              DELETE

              /icws/{sessionId}/directories/contacts/{directoryID}/{entryID}

              Delete a directory contact entry.
              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.

                    Template
                    directoryID

                    Required

                    The directory's ID.

                      Template
                      entryID

                      Required

                      The directory contact's entry ID.

                        Response

                        204 - No Content
                        The directory contact entry was successfully deleted.
                        403 - Forbidden
                        The session user does not have permission to delete this contact entry.
                        Feature Version
                        directories 8
                        error
                        Provides additional detail for an error.
                        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.
                        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.
                          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.
                          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.
                          Property
                          Value
                          Comments
                          errorId
                          String
                          The error identifier that describes the current error.
                          message
                          String

                          Required

                          A message that describes the current error.