Wiki source code of User Contact Configuration

Last modified by michaely on 2021/09/10 23:34
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 {{warning}}
5 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
6 {{/warning}}
7
8 {{info}}
9 The information on this page applies to **iSymphony 3.1+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 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.).
15
16
17 {{/layout-cell}}
18
19 {{layout-cell}}
20 {{panel title="On this page:"}}
21
22
23 {{toc maxLevel="2" indent="1"/}}
24 {{/panel}}
25 {{/layout-cell}}
26 {{/layout-section}}
27
28 {{layout-section ac:type="single"}}
29 {{layout-cell}}
30 = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) =
31
32 {{code}}
33 communication_manager/rest/config/contact/{coreServerId}/users
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "id": "7f822459-7728-4887-a6fd-aaffdba3a426",
41 "firstName": "Steve",
42 "lastName": "S (desk)",
43 "userConfigurationId": "56cf70a3-1ee0-4b09-8f40-297430eeeddf"
44 }
45 {{/code}}
46
47 |=(((
48 Property
49 )))|=(((
50 Type
51 )))|=(((
52 Description
53 )))
54 |(((
55 {{{id}}}
56 )))|(((
57 String
58 )))|(((
59 Configuration id of the user contact information.
60 )))
61 |(% colspan="1" %)(% colspan="1" %)
62 (((
63 firstName
64 )))|(% colspan="1" %)(% colspan="1" %)
65 (((
66 String
67 )))|(% colspan="1" %)(% colspan="1" %)
68 (((
69 First name of the user.
70 )))
71 |(% colspan="1" %)(% colspan="1" %)
72 (((
73 lastName
74 )))|(% colspan="1" %)(% colspan="1" %)
75 (((
76 String
77 )))|(% colspan="1" %)(% colspan="1" %)
78 (((
79 Last name of the user.
80 )))
81 |(% colspan="1" %)(% colspan="1" %)
82 (((
83 {{{userConfigurationId}}}
84 )))|(% colspan="1" %)(% colspan="1" %)
85 (((
86 String
87 )))|(% colspan="1" %)(% colspan="1" %)
88 (((
89 Configuration id of the user the contact information is for.
90 )))
91
92 = Resource Paths =
93
94 |=(% colspan="2" %)(% colspan="2" %)
95 (((
96 {{{communication_manager/rest/config/contact/{coreServerId}/users}}}
97 )))
98 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
99 (((
100 **Description**
101 )))|(((
102 Accesses the contact information for all users in the core server.
103 )))
104 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
105 (((
106 **GET**
107 )))|(((
108 Gets the contact information for all users in the core server.
109 )))
110 |(% colspan="2" %)(% colspan="2" %)
111 (((
112
113 )))
114 |=(% colspan="2" %)(% colspan="2" %)
115 (((
116 {{{communication_manager/rest/config/contact/{coreServerId}/users/{userId}}}}
117 )))
118 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
119 (((
120 **Description**
121 )))|(((
122 Accesses the contact information for a specific user.
123
124 **Parameters:**
125
126 * userId: The configuration id of the user to get the contact information for.
127 )))
128 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
129 (((
130 **GET**
131 )))|(((
132 Gets the contact information of the specified user.
133
134 **Errors:**
135
136 * 404 'A user with the given id does not exist': Returned if no user exists with the given id.
137 )))
138 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
139 (((
140 **PUT**
141 )))|(% colspan="1" %)(% colspan="1" %)
142 (((
143 Updates the contact information of a specific user.
144
145 **Errors:**
146
147 * 404 'A user with the given id does not exist': Returned if no user exists with the given id.
148 )))
149
150 = Sub/Child Resource Paths =
151
152 |=(% colspan="2" %)(% colspan="2" %)
153 (((
154 {{{communication_manager/rest/config/contact/{coreServerId}/users/{userId}/phoneNumbers}}}
155 )))
156 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
157 (((
158 **Description**
159 )))|(% colspan="1" %)(% colspan="1" %)
160 (((
161 Access the sub/child resource for the alternative phone numbers of the contact.
162
163 (% style="line-height: 1.42857;" %)**Parameters:**
164
165 * userId: The configuration id of the user to get the contact information for.
166
167 **Errors:**
168
169 * 404 'A user with the given id does not exist': Returned if no user exists with the given id.
170
171 See [[doc:Phone Numbers]] for more information.
172 )))
173 |(% colspan="2" %)(% colspan="2" %)
174 (((
175
176 )))
177 |=(% colspan="2" %)(% colspan="2" %)
178 (((
179 {{{communication_manager/rest/config/contact/{coreServerId}/users/{userId}/emailAddresses}}}
180 )))
181 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
182 (((
183 **Description**
184 )))|(% colspan="1" %)(% colspan="1" %)
185 (((
186 Access the sub/child resource for the email addresses of the contact.
187
188 **Parameters:**
189
190 * userId: The configuration id of the user to get the contact information for.
191
192 **Errors:**
193
194 * 404 'A user with the given id does not exist': Returned if no user exists with the given id.
195
196 See [[doc:Email Addresses]] for more information.
197 )))
198
199 = Curl Examples =
200
201 === Get contact information for all users in the core server ===
202
203 {{code language="bash"}}
204 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/contact/ee828da8-5ee6-412d-82ac-1273f598659d/users
205 {{/code}}
206
207 === Get the contact information for a specific user ===
208
209 {{code language="bash"}}
210 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
211 {{/code}}
212
213 === Update contact information for a specific user ===
214
215 {{code language="bash"}}
216 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
217 {{/code}}
218 {{/layout-cell}}
219 {{/layout-section}}
220 {{/layout}}

Search

Navigation

iSymphony