Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

Info

The information on this page applies to iSymphony 3.1+.

Description

The user contact configuration REST resource allows access to the configuration for user's contact information. This resource allows changing of the user's contact information (e.g. first name last name, email, alternative phone numbers, ect.).

 

Panel
titleOn this page:

Table of Contents
maxLevel2
indent1
 

Root Resource Path

Code Block
communication_manager/rest/config/contact/{coreServerId}/users

JSON Representation

Code Block
{
    "id": "7f822459-7728-4887-a6fd-aaffdba3a426",
    "firstName": "Steve",
    "lastName": "S (desk)",
    "userConfigurationId": "56cf70a3-1ee0-4b09-8f40-297430eeeddf"
}
PropertyTypeDescription
id
String

Configuration id of the user contact information.

firstNameStringFirst name of the user.
lastNameStringLast name of the user.
userConfigurationId
StringConfiguration id of the user the contact information is for.

Resource Paths

communication_manager/rest/config/contact/{coreServerId}/users
DescriptionAccesses the contact information for all users in the core server.
GET Gets the contact information for all users in the core server.
 
communication_manager/rest/config/contact/{coreServerId}/users/{userId}
Description

Accesses the contact information for a specific user.

Parameters:

  • userId: The configuration id of the user to get the contact information for.
GET

Gets the contact information of the specified user.

Errors:

  • 404 'A user with the given id does not exist': Returned if no user exists with the given id.
PUT

Updates the contact information of a specific user.

Errors:

  • 404 'A user with the given id does not exist': Returned if no user exists with the given id.

Sub/Child Resource Paths

communication_manager/rest/config/contact/{coreServerId}/users/{userId}/phoneNumbers
Description

Access the sub/child resource for the alternative phone numbers of the contact.

Parameters:

  • userId: The configuration id of the user to get the contact information for.

Errors:

  • 404 'A user with the given id does not exist': Returned if no user exists with the given id.

See Phone Numbers for more information.

 
communication_manager/rest/config/contact/{coreServerId}/users/{userId}/emailAddresses
Description

Access the sub/child resource for the email addresses of the contact.

Parameters:

  • userId: The configuration id of the user to get the contact information for.

Errors:

  • 404 'A user with the given id does not exist': Returned if no user exists with the given id.

See Email Addresses for more information.

Curl Examples

Get contact information for all users in the core server

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/contact/ee828da8-5ee6-412d-82ac-1273f598659d/users

Get the contact information for a specific user

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/contact/ee828da8-5ee6-412d-82ac-1273f598659d/users/56cf70a3-1ee0-4b09-8f40-297430eeeddf

Update contact information for a specific user

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"bef84e6f-6b0c-4537-9534-81d0e3744c03","firstName":"Oprah","lastName":"Winfrey","userConfigurationId":"56cf70a3-1ee0-4b09-8f40-297430eeeddf"}' http://localhost:58080/communication_manager/rest/config/contact/ee828da8-5ee6-412d-82ac-1273f598659d/users/56cf70a3-1ee0-4b09-8f40-297430eeeddf