1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/**
\defgroup ods_module_instance ODS App Instance Management API
Provides procedures for instance management like creating a new instance or retrieving an instance id.
\section ods_instance_id ODS App Instance Ids
Each application instance in ODS which has been created though instance.create() has a unique numerical id. This id is required
as parameter in many methods throughout the ODS API.
There are two ways to discover the id of an instance through the ODS API:
-# If the name of the instance is known a simple call to instance.get.id() is sufficient.
-# If the exact name is not known the instance can be searched via instance.search().
FIXME: we need a method to list all instances with an optional type restriction.
*/
/**
\defgroup ods_module_user ODS User Profile Management API
The user management API provides procedures for user lookup, creation, and manipulation.
\attention User names in ODS are case-sensitive!
\section ods_user_privacy ODS User Privacy Settings
Most details of a user profile are subject to privacy settings. There are three settings:
- public - visible to all
- private - visible to no-one
- ACL - Fine grained control over who is allowed to read or write the data.
FIXME: add links to the important methods that deal with privacy.
\section ods_resource_types ODS Resource Types
\subsection ods_user_profile_resource ODS User Profile Resource
In the ODS HTTP API a user profile is described as follows:
\code
{
"userName": {string},
"mail": {string},
"mail.share": {string},
"nickName": {string},
"nickName.share": {string},
"title": {string},
"title.share": {string},
"firstName": {string},
"firstName.share": {string},
"lastName": {string},
"lastName.share": {string},
"fullName": {string},
"fullName.share": {string},
"gender": {string},
"gender.share": {string},
"birthday": {date},
"birthday.share": {string},
"summary": {string},
"summary.share": {string},
"interests": [
{
"name": {string},
"url": {string},
"share": {string}
}
],
"topicInterests": [
{
"name": {string},
"url": {string},
"share": {string}
}
],
"mailSignature": {string},
"webIDs": [ {string} ],
"openID": {string},
"secretQuestion": {string},
"secretAnswer": {string},
"personal": {contact},
"business": {contact},
"business.industry": {string},
"business.industry.share": {string},
"business.organization": {string},
"business.organization.share": {string},
"business.job": {string},
"business.job.share": {string},
"business.regNo": {string},
"business.regNo.share": {string},
"business.career": {string},
"business.career.share": {string},
"business.employees": {string},
"business.employees.share": {string},
"business.vendor": {string},
"business.vendor.share": {string},
"business.service": {string},
"business.service.share": {string},
"business.resume": {string},
"business.resume.share": {string},
"photo": {string},
"photo.share": {string},
"audio": {string}
"audio.share": {string},
}
\endcode
\subsubsection ods_user_profile_contact_resource ODS User Profile Contact Resource
\code
{
"address": {address},
"phoneNumber": [
{
"name": {string},
"num": {string},
"ext": {string},
"share": {string}
}
],
"homePage": {string},
"homePage.share": {string},
"messaging": [
{
"name": {string},
"uid": {string},
"share": {string}
}
],
"onlineAccount": [
{
"name": {string},
"url": {string},
"id": {string},
"share": {string}
}
],
}
\endcode
\subsubsection ods_user_profile_address_resource ODS User Profile Address Resource
An address resource is defined as follows:
\code
{
"country": {string},
"country.share": {string},
"state": {string},
"state.share": {string},
"city": {string},
"city.share": {string},
"postalCode": {string},
"postalCode.share": {string},
"address1": {string},
"address1.share": {string},
"address2": {string},
"address2.share": {string},
"timezone": {string},
"timezone.share": {string},
"geo": {
"latitude": {int},
"longitude": {int},
"defaultMapLocation": {bool}
}
"geo.share": {string}
}
\endcode
*/
/**
\defgroup ods_module_misc ODS Miscellaneous Functions
*/
/**
\defgroup ods_module_ontology ODS Ontology Management API
*/
|
