Left: | ||
Right: |
LEFT | RIGHT |
---|---|
1 <?xml version="1.0" encoding="utf-8"?> | 1 <?xml version="1.0" encoding="utf-8"?> |
2 <?xml-stylesheet type='text/xsl' href='./OpenSocial.xslt' ?> | 2 <?xml-stylesheet type='text/xsl' href='./OpenSocial.xslt' ?> |
3 <?rfc toc="yes"?> | 3 <?rfc toc="yes"?> |
4 <?rfc-ext allow-markup-in-artwork="yes"?> | 4 <?rfc-ext allow-markup-in-artwork="yes"?> |
5 <!DOCTYPE rfc PUBLIC "-//IETF//DTD RFC 2629//EN" | 5 <!DOCTYPE rfc PUBLIC "-//IETF//DTD RFC 2629//EN" |
6 "http://xml.resource.org/authoring/rfc2629.dtd"> | 6 "http://xml.resource.org/authoring/rfc2629.dtd"> |
7 <rfc ipr="full3978" | 7 <rfc ipr="full3978" |
8 docName="opensocial-data-specification-draft" | 8 docName="opensocial-data-specification-draft" |
9 xmlns:x="http://purl.org/net/xml2rfc/ext"> | 9 xmlns:x="http://purl.org/net/xml2rfc/ext"> |
10 <front> | 10 <front> |
11 <title>OpenSocial Data Specification (draft)</title> | 11 <title>OpenSocial Social Data Specification (draft)</title> |
12 <author fullname='OpenSocial and Gadgets Specification Group'> | 12 <author fullname='OpenSocial and Gadgets Specification Group'> |
13 <address> | 13 <address> |
14 <email>opensocial-and-gadgets-spec@googlegroups.com</email> | 14 <email>opensocial-and-gadgets-spec@googlegroups.com</email> |
15 </address> | 15 </address> |
16 </author> | 16 </author> |
17 <date month="September" | 17 <date month="September" |
18 year="2009" /> | 18 year="2009" /> |
19 <abstract> | 19 <abstract> |
20 <t>This document defines all the data objects used in the | 20 <t>This document defines all the data objects used in the |
21 OpenSocial APIs. Objects defined here make use of the <xref | 21 OpenSocial APIs. Objects defined here make use of the <xref |
(...skipping 28 matching lines...) Expand all Loading... | |
50 </list> | 50 </list> |
51 </section> | 51 </section> |
52 </section> | 52 </section> |
53 <section title="Notational Conventions and Generic Grammar"> | 53 <section title="Notational Conventions and Generic Grammar"> |
54 <section title="Conventions"> | 54 <section title="Conventions"> |
55 <t>Domain name examples use· | 55 <t>Domain name examples use· |
56 <xref target="RFC2606">RFC2606</xref>.</t> | 56 <xref target="RFC2606">RFC2606</xref>.</t> |
57 </section> | 57 </section> |
58 <section title="Augmented BNF"> | 58 <section title="Augmented BNF"> |
59 <t>The grammatical rules in this document are to be interpreted as | 59 <t>The grammatical rules in this document are to be interpreted as |
60 described in <xref target="RFC2234">RFC4234</xref> (Augmented Backus-Naur· | 60 described in <xref target="RFC2234">RFC2234</xref> (Augmented Backus-Naur· |
61 Form).</t>··· | 61 Form).</t>··· |
62 <t>The following constructs are introduced in this document to augment· | 62 <t>The following constructs are introduced in this document to augment· |
63 RFC4234:</t> | 63 RFC2234:</t> |
64 <list style="hanging"> | 64 <list style="hanging"> |
65 <t hangText="{rule1 rule2}"> | 65 <t hangText="{rule1 rule2}"> |
66 <t>Elements enclosed in braces (squiggly brackets) are treated as a | 66 <t>Elements enclosed in braces (squiggly brackets) are treated as a |
67 single, UNORDERED element. Its contents may occur in any order. Hence:· | 67 single, UNORDERED element. Its contents may occur in any order. Hence:· |
68 <artwork type="abnf" xml:space="preserve">{elem foo} bar</artwork> | 68 <artwork type="abnf" xml:space="preserve">{elem foo} bar</artwork> |
69 would match (elem foo bar) and (foo elem bar).</t> | 69 would match (elem foo bar) and (foo elem bar).</t> |
70 <t>NOTE: Specifying alternatives is quite different from specifying set | 70 <t>NOTE: Specifying alternatives is quite different from specifying set |
71 grouping. Alternatives indicate the matching of exactly one (sub-)rule | 71 grouping. Alternatives indicate the matching of exactly one (sub-)rule |
72 out of the total grouping. The set mechanism indicates the matching of a | 72 out of the total grouping. The set mechanism indicates the matching of a |
73 string which contains all of the elements within the group; however the | 73 string which contains all of the elements within the group; however the |
(...skipping 96 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
170 ${Subject.DisplayName} has recommended ${Song.Count} songs to you. | 170 ${Subject.DisplayName} has recommended ${Song.Count} songs to you. |
171 </msg> | 171 </msg> |
172 </messagebundle> | 172 </messagebundle> |
173 </artwork> | 173 </artwork> |
174 </figure></t> | 174 </figure></t> |
175 <texttable> | 175 <texttable> |
176 <ttcol align="left" width="15%">Field Name</ttcol> | 176 <ttcol align="left" width="15%">Field Name</ttcol> |
177 <ttcol align="left" width="21%">Field Type</ttcol> | 177 <ttcol align="left" width="21%">Field Type</ttcol> |
178 <ttcol align="left">Description</ttcol> | 178 <ttcol align="left">Description</ttcol> |
179 <c>appId</c> | 179 <c>appId</c> |
180 <c>string</c> | 180 <c><eref target="./Core-Data.xml#App-Id">App-Id</eref></c> |
181 <c>Specifying the application that this activity is associated with.</c> | 181 <c>Specifying the application that this activity is associated with.</c> |
182 <c>body</c> | 182 <c>body</c> |
183 <c>string</c> | 183 <c><eref target="./Core-Data.xml#Limited-HTML-Content">Limited-HTML-Conten t</eref></c> |
184 <c>Specifying an optional expanded version of an | 184 <c>Specifying an optional expanded version of an activity.</c> |
185 activity. Bodies may only have the following HTML tags: <b> <i> ;, | |
186 <a>, <span>. The container may ignore this formatting when | |
187 rendering the activity.</c> | |
188 <c>bodyId</c> | 185 <c>bodyId</c> |
189 <c>string</c> | 186 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
190 <c>Specifying the body template message ID in the gadget spec.</c> | 187 <c>Specifying the body template message ID in the gadget spec.</c> |
191 <c>externalId</c> | 188 <c>externalId</c> |
192 <c>string</c> | 189 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
193 <c>An optional ID generated by the posting application.</c> | 190 <c>An optional ID generated by the posting application.</c> |
194 <c>id</c> | 191 <c>id</c> |
195 <c>string</c> | 192 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
196 <c>An ID that is permanently associated with this activity.</c> | 193 <c>An ID that is permanently associated with this activity.</c> |
197 <c>mediaItems</c> | 194 <c>mediaItems</c> |
198 <c>Array<MediaItem></c> | 195 <c>Array<<x:ref>MediaItem</x:ref>></c> |
199 <c>Any photos, videos, or images that should be associated with the activi ty. Higher priority ones are higher in the list.</c> | 196 <c>Any photos, videos, or images that should be associated with |
197 the activity. Higher priority ones are higher in the list.</c> | |
200 <c>postedTime</c> | 198 <c>postedTime</c> |
201 <c>string</c> | 199 <c>string</c> |
202 <c>Specifying the time at which this activity took place in milliseconds s ince the epoch.</c> | 200 <c>Specifying the time at which this activity took place in |
201 milliseconds since the epoch.</c> | |
203 <c>priority</c> | 202 <c>priority</c> |
204 <c>number</c> | 203 <c>number</c> |
205 <c>A number between 0 and 1 representing the relative priority of this act ivity in relation to other activities from the same source.</c> | 204 <c>A number between 0 and 1 representing the relative priority |
205 of this activity in relation to other activities from the same | |
206 source.</c> | |
206 <c>streamFaviconUrl</c> | 207 <c>streamFaviconUrl</c> |
207 <c>string</c> | 208 <c><eref target="./Core-Data.xml#URL">URL</eref></c> |
208 <c>Specifying the URL for the stream's favicon.</c> | 209 <c>Specifying the URL for the stream's favicon.</c> |
209 <c>streamSourceUrl</c> | 210 <c>streamSourceUrl</c> |
210 <c>string</c> | 211 <c><eref target="./Core-Data.xml#URL">URL</eref></c> |
211 <c>Specifying the stream's source URL.</c> | 212 <c>Specifying the stream's source URL.</c> |
212 <c>streamTitle</c> | 213 <c>streamTitle</c> |
213 <c>string</c> | 214 <c>string</c> |
214 <c>Specifing the title of the stream.</c> | 215 <c>Specifing the title of the stream.</c> |
215 <c>streamUrl</c> | 216 <c>streamUrl</c> |
216 <c>string</c> | 217 <c><eref target="./Core-Data.xml#URL">URL</eref></c> |
217 <c>Specifying the stream's URL.</c> | 218 <c>Specifying the stream's URL.</c> |
218 <c>templateParams</c> | 219 <c>templateParams</c> |
219 <c></c> | 220 <c></c> |
220 <c>A map of custom key/value pairs associated with this | 221 <c>A map of custom key/value pairs associated with this |
221 activity. These are used for evaluation in templates. The | 222 activity. These are used for evaluation in templates. The |
222 data has type Map<String, Object>. The object may be either a | 223 data has type Map<String, Object>. The object may be either a |
223 String or an opensocial.Person. When passing in a person with | 224 String or an opensocial.Person. When passing in a person with |
224 key PersonKey, can use the following replacement variables in | 225 key PersonKey, can use the following replacement variables in |
225 the template: | 226 the template: |
226 <list style="symbols"> | 227 <list style="symbols"> |
227 <t>PersonKey.DisplayName - Display name for the person</t> | 228 <t>PersonKey.DisplayName - Display name for the person</t> |
228 <t>PersonKey.ProfileUrl. URL of the person's profile</t> | 229 <t>PersonKey.ProfileUrl. URL of the person's profile</t> |
229 <t>PersonKey.Id - The ID of the person</t> | 230 <t>PersonKey.Id - The ID of the person</t> |
230 <t>PersonKey - Container may replace with DisplayName, but may also | 231 <t>PersonKey - Container may replace with DisplayName, but may also |
231 optionally link to the user.</t> | 232 optionally link to the user.</t> |
232 </list> | 233 </list> |
233 </c>· | 234 </c>· |
234 <c>title</c> | 235 <c>title</c> |
235 <c>string</c> | 236 <c>string</c> |
236 <c>Specifying the primary text of an activity. Titles may only | 237 <c>Specifying the primary text of an activity. Titles may only |
237 have the following HTML tags: <b> <i>, <a>, | 238 have the following HTML tags: <b> <i>, <a>, |
238 <span>. The container may ignore this formatting when | 239 <span>. The container may ignore this formatting when |
239 rendering the activity.</c> | 240 rendering the activity.</c> |
240 <c>url</c> | 241 <c>url</c> |
241 <c>string</c> | 242 <c><eref target="./Core-Data.xml#URL">URL</eref></c> |
242 <c>Specifying the URL that represents this activity.</c> | 243 <c>Specifying the URL that represents this activity.</c> |
243 <c>userId</c> | 244 <c>userId</c> |
244 <c>string</c> | 245 <c><x:ref>Person-Id</x:ref></c> |
245 <c>ID of the user who this activity is for.</c> | 246 <c>ID of the user who this activity is for.</c> |
246 </texttable> | 247 </texttable> |
247 </section> | 248 </section> |
248 <section title="AppData" anchor="AppData"> | 249 <section title="AppData" anchor="AppData"> |
Lane LiaBraaten
2009/11/23 19:00:10
Move the text from the Background > Key Concepts >
| |
249 <t>AppData stores uninterpreted key/value pairs on behalf of an | 250 <t>OpenSocial defines a data store that applications can use to |
250 application.</t> | 251 read and write user-specific data. This data store can be read by |
252 anyone who can see the gadget, but only the VIEWER's data is | |
253 writable.</t> | |
254 <t>The keys that developers specify to index this data must only | |
255 contain alphanumeric (A-Za-z0-9) characters, underscore(_), | |
256 dot(.) or dash(-).</t> | |
257 <t>Since application data is often created based on user inputs, | |
258 OpenSocial containers perform automatic HTML escaping of all | |
259 application data. However, developers have the option of turning | |
260 off this escaping by setting the escapeType parameter on | |
261 newFetchPersonAppData and getField calls.</t> | |
262 <t>Because of the potential for abuse, containers MAY implement | |
263 quotas or rate limits to preserve their disk space.</t> | |
251 <texttable> | 264 <texttable> |
252 <ttcol align="left" width="15%">Field Name</ttcol> | 265 <ttcol align="left" width="15%">Field Name</ttcol> |
253 <ttcol align="left" width="21%">Field Type</ttcol> | 266 <ttcol align="left" width="21%">Field Type</ttcol> |
254 <ttcol align="left">Description</ttcol> | 267 <ttcol align="left">Description</ttcol> |
255 <c>key</c> | 268 <c>key</c> |
256 <c>string</c> | 269 <c>string</c> |
257 <c>A unique value with respect to the context it is being stored | 270 <c>A unique value with respect to the context it is being stored |
258 within (typically a person).</c> | 271 within (typically a person).</c> |
259 <c>value</c> | 272 <c>value</c> |
260 <c>string</c> | 273 <c>string</c> |
261 <c>An arbitary string.</c> | 274 <c>An arbitary string.</c> |
262 </texttable> | 275 </texttable> |
263 </section> | 276 </section> |
264 <section title="Message" | 277 <section title="Message" |
265 anchor="Message"> | 278 anchor="Message"> |
266 <t>Valid definitions for Message-Field are listed in the table below.</t> | 279 <t>Valid definitions for Message-Field are listed in the table below.</t> |
267 <texttable> | 280 <texttable> |
268 <ttcol align="left" width="15%">Field Name</ttcol> | 281 <ttcol align="left" width="15%">Field Name</ttcol> |
269 <ttcol align="left" width="21%">Field Type</ttcol> | 282 <ttcol align="left" width="21%">Field Type</ttcol> |
270 <ttcol align="left">Description</ttcol> | 283 <ttcol align="left">Description</ttcol> |
271 <c>appUrl</c> | 284 <c>appId</c> |
272 <c></c> | 285 <c><eref target="./Core-Data.xml#App-Id">App-Id</eref></c> |
273 <c>Identifies the application that generated this message.</c> | 286 <c>Identifies the application that generated this message.</c> |
274 <c>body</c> | 287 <c>body</c> |
275 <c></c> | 288 <c><eref target="./Core-Data.xml#Limited-HTML-Content">Limited-HTML-Conten t</eref></c> |
276 <c>The main text of the message. HTML attributes are allowed and are sanit ized by the container.</c> | 289 <c>The main text of the message.</c> |
277 <c>bodyId</c> | 290 <c>bodyId</c> |
278 <c></c> | 291 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
279 <c>The main text of the message as a message template. Specifies the messa ge ID to use in the gadget xml.</c> | 292 <c>The main text of the message as a message template. Specifies |
293 the message ID to use in the gadget xml.</c> | |
280 <c>collectionIds</c> | 294 <c>collectionIds</c> |
281 <c></c> | 295 <c>Array <<eref target="./Core-Data.xml#Object-Id">Object-Id</eref>> </c> |
Lane LiaBraaten
2009/12/10 19:18:52
should be of type Message-Collection-ID
| |
282 <c>Identifies the messages collection IDs this message is contained in.</c > | 296 <c>Identifies the messages collection IDs this message is |
297 contained in.</c> | |
283 <c>id</c> | 298 <c>id</c> |
284 <c></c> | 299 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
285 <c>Unique ID for this message.</c> | 300 <c>Unique ID for this message.</c> |
286 <c>inReplyTo</c> | 301 <c>inReplyTo</c> |
287 <c></c> | 302 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
288 <c>Message ID, use for threaded comments/messages. Reference the sematics of the Atom Threading model defined in rfc4685. URLs should be mapped to Atom &l t;link rel="type" .../></c> | 303 <c>Message ID, use for threaded comments/messages. Reference the |
304 sematics of the Atom Threading model defined in rfc4685. URLs | |
305 should be mapped to Atom <link rel="type" .../></c> | |
289 <c>recipients</c> | 306 <c>recipients</c> |
290 <c></c> | 307 <c>Array <<x:ref>Person-Id</x:ref>></c> |
291 <c>Array of person IDs.</c> | 308 <c>Array of person IDs.</c> |
292 <c>replies</c> | 309 <c>replies</c> |
293 <c></c> | 310 <c>Array <<eref target="./Core-Data.xml#Object-Id">Object-Id</eref>> </c> |
294 <c>Array of message ids. Reference the sematics of the Atom Threading mode l defined in rfc4685. URLs should be mapped to Atom <link rel="type" .../> </c> | 311 <c>Array of message ids. Reference the sematics of the Atom |
312 Threading model defined in rfc4685. URLs should be mapped to | |
313 Atom <link rel="type" .../></c> | |
295 <c>senderId</c> | 314 <c>senderId</c> |
296 <c></c> | 315 <c><x:ref>Person-Id</x:ref></c> |
297 <c>Id of person who sent the message.</c> | 316 <c>Id of person who sent the message.</c> |
298 <c>status</c> | 317 <c>status</c> |
299 <c></c> | 318 <c>string</c> |
300 <c>Status of the message. (NEW, READ, DELETED).</c> | 319 <c>Status of the message. (NEW, READ, DELETED).</c> |
301 <c>timeSent</c> | 320 <c>timeSent</c> |
302 <c></c> | 321 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
303 <c>UTC time message was sent.</c> | 322 <c>UTC time message was sent.</c> |
304 <c>title</c> | 323 <c>title</c> |
305 <c></c> | 324 <c><eref target="./Core-Data.xml#Limited-HTML-Content">Limited-HTML-Conten t</eref></c> |
306 <c>The title of the message. HTML attributes are allowed and are sanitized by the container.</c> | 325 <c>The title of the message.</c> |
307 <c>titleId</c> | 326 <c>titleId</c> |
308 <c></c> | 327 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
309 <c>The title of the message as a message template. Specifies the message I D to use in the gadget xml.</c> | 328 <c>The title of the message as a message template. Specifies the |
310 <c>type</c> | 329 message ID to use in the gadget xml.</c> |
311 <c></c> | |
312 <c>The title of the message.</c> | |
313 <c>updated</c> | 330 <c>updated</c> |
314 <c></c> | 331 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
315 <c>Last update for this message.</c> | 332 <c>Last update for this message.</c> |
316 <c>urls</c> | 333 <c>urls</c> |
317 <c></c> | 334 <c><eref |
318 <c>List of related URLs for this message. Supported URL types include 'alt ernate', alternate for for this mailbox (text/html being the most common).</c> | 335 target="./Core-Data.xml#Plural-Field">Plural-Field</eref> |
336 <<eref | |
337 target="./Core-Data.xml#URL-Link">URL-Link</eref>></c> | |
338 <c>List of related URLs for this message. Supported URL types | |
339 include 'alternate', alternate for for this mailbox (text/html | |
340 being the most common).</c> | |
319 </texttable> | 341 </texttable> |
320 </section> | 342 </section> |
321 <section title="Person" | 343 <section title="Person" |
Lane LiaBraaten
2009/11/23 19:00:10
Move the text from the Background > Key Concepts >
| |
322 anchor="Person"> | 344 anchor="Person"> |
323 <t>Each person returned MUST include the "id", "name", and "thumbnailUrl" | 345 <t>Each person returned MUST include the "id", "name", and |
324 fields with· | 346 "thumbnailUrl" fields with non-empty values, but all other fields |
325 non-empty values, but all other fields are optional, and it is recognized | 347 are optional, and it is recognized that not all Service Providers |
326 that not all Service Providers are able to provide data for all the | 348 are able to provide data for all the supported fields. The field |
327 supported fields. The field list below is broad so that there is a standard · | 349 list below is broad so that there is a standard field name |
328 field name available among Service Providers that do support any of these | 350 available among Service Providers that do support any of these |
329 fields.</t> | 351 fields.</t> |
352 <t>There are two special Person objects that can be requested | |
353 directly: the VIEWER and the OWNER. To understand the | |
354 distinction, imagine you're checking out a coworker's profile on | |
355 Orkut. In this case, you are the VIEWER and your coworker is the | |
356 OWNER. It's also common to view your own profile, in which case | |
357 you are both the VIEWER and the OWNER, and some applications may | |
358 choose to handle this case differently. OpenSocial also provides | |
359 for the case of anonymous viewing, where the gadget will not be | |
360 able to access the VIEWER's information.</t> | |
330 <artwork type="abnf"> | 361 <artwork type="abnf"> |
331 <x:highlight>Person</x:highlight> = "{" | 362 <x:highlight>Person</x:highlight> = "{" |
332 "id :" User-ID "," | 363 "id :" User-Id "," |
333 "displayName :" string "," | 364 "displayName :" string "," |
334 [ #Person-Field ] | 365 [ #Person-Field ] |
335 "}"</artwork> | 366 "}"</artwork> |
336 <t>Valid definitions for Person-Field are listed in the table below.</t> | 367 <t>Valid definitions for Person-Field are listed in the table below.</t> |
337 <texttable> | 368 <texttable> |
338 <ttcol align="left" width="15%">Field Name</ttcol> | 369 <ttcol align="left" width="15%">Field Name</ttcol> |
339 <ttcol align="left" width="21%">Field Type</ttcol> | 370 <ttcol align="left" width="21%">Field Type</ttcol> |
340 <ttcol align="left">Description</ttcol> | 371 <ttcol align="left">Description</ttcol> |
372 <c>aboutMe</c> | |
373 <c>string</c> | |
374 <c>A general statement about the person.</c> | |
341 <c>accounts</c> | 375 <c>accounts</c> |
342 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<x: ref>Account</x:ref>></c> | 376 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<x: ref>Account</x:ref>></c> |
343 <c>An online account held by this Person.</c> | 377 <c>An online account held by this Person.</c> |
378 <c>activities</c> | |
379 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
380 <c>Person's favorite activities.</c> | |
344 <c>addresses</c> | 381 <c>addresses</c> |
345 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<x: ref>Address</x:ref>></c> | 382 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<x: ref>Address</x:ref>></c> |
346 <c>A physical mailing address for this Person.</c> | 383 <c>A physical mailing address for this Person.</c> |
384 <c>age</c> | |
385 <c>number</c> | |
386 <c>The age of this person. Sometimes sites might want to show | |
387 age without revealing the specific birthday.</c> | |
347 <c>anniversary</c> | 388 <c>anniversary</c> |
348 <c><eref target="./Core-Data.xml#Date">Date</eref></c> | 389 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
349 <c>The wedding anniversary of this person. The value MUST be a | 390 <c>The wedding anniversary of this person. The value MUST be a |
350 valid <eref | 391 valid <eref |
351 target="./Core-Data.xml#Date">Date</eref>. The | 392 target="./Core-Data.xml#Date">Date</eref>. The |
352 year value MAY be set to 0000 when the year is not | 393 year value MAY be set to 0000 when the year is not |
353 available.</c> | 394 available.</c> |
354 <c>appdata</c> | 395 <c>appData</c> |
355 <c><eref | 396 <c><eref |
356 target="./Core-Data.xml#Plural-Field">Plural-Field</eref> | 397 target="./Core-Data.xml#Plural-Field">Plural-Field</eref> |
357 <<x:ref>AppData</x:ref>></c> | 398 <<x:ref>AppData</x:ref>></c> |
358 <c>A collection of AppData keys and values.</c> | 399 <c>A collection of AppData keys and values.</c> |
359 <c>birthday</c> | 400 <c>birthday</c> |
360 <c><eref target="./Core-Data.xml#Date">Date</eref></c> | 401 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
361 <c>The birthday of this person. The value MUST be a valid <eref | 402 <c>The birthday of this person. The value MUST be a valid <eref |
362 target="./Core-Data.xml#Date">Date</eref>. The | 403 target="./Core-Data.xml#Date">Date</eref>. The |
363 year value MAY be set to 0000 when the age of the Person is | 404 year value MAY be set to 0000 when the age of the Person is |
364 private or the year is not available.</c> | 405 private or the year is not available.</c> |
406 <c>bodyType</c> | |
407 <c><x:ref>BodyType</x:ref></c> | |
408 <c>Person's body characteristics.</c> | |
409 <c>books</c> | |
410 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
411 <c>Person's favorite books.</c> | |
412 <c>cars</c> | |
413 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
414 <c>Person's favorite cars.</c> | |
415 <c>children</c> | |
416 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
417 <c>Description of the person's children.</c> | |
365 <c>connected</c> | 418 <c>connected</c> |
366 <c><eref target="./Core-Data.xml#Boolean">Boolean</eref></c> | 419 <c><eref target="./Core-Data.xml#Boolean">Boolean</eref></c> |
367 <c>Boolean value indicating whether the user and this Person have | 420 <c>Boolean value indicating whether the user and this Person have |
368 established a bi-directionally asserted connection of some kind on the | 421 established a bi-directionally asserted connection of some kind on the |
369 Service Provider's service. The value MUST be either true or false. The | 422 Service Provider's service. The value MUST be either true or false. The |
370 value MUST be true if and only if there is at least one value for the | 423 value MUST be true if and only if there is at least one value for the |
371 relationship field, described below, and is thus intended as a summary | 424 relationship field, described below, and is thus intended as a summary |
372 value indicating that some type of bi-directional relationship exists, | 425 value indicating that some type of bi-directional relationship exists, |
373 for Consumers that aren't interested in the specific nature of that | 426 for Consumers that aren't interested in the specific nature of that |
374 relationship. For traditional address books, in which a user stores | 427 relationship. For traditional address books, in which a user stores |
375 information about other contacts without their explicit acknowledgment, | 428 information about other contacts without their explicit acknowledgment, |
376 or for services in which users choose to "follow" other users without | 429 or for services in which users choose to "follow" other users without |
377 requiring mutual consent, this value will always be false.</c> | 430 requiring mutual consent, this value will always be false.</c> |
431 <c>currentLocation</c> | |
432 <c><x:ref>Address</x:ref></c> | |
433 <c>Person's current location, deprecated in 1.0 in favor of the | |
434 standard location field, but is included for backwards | |
435 compatibility. currentLocation will be fully removed in a future | |
436 version of the spec.</c> | |
437 <c>drinker</c> | |
438 <c>string</c> | |
439 <c>Person's drinking status.</c> | |
378 <c>displayName</c> | 440 <c>displayName</c> |
379 <c>string</c> | 441 <c>string</c> |
380 <c><x:highlight>Required.</x:highlight> The name of this Person, suitable for display to end-users. Each | 442 <c><x:highlight>Required.</x:highlight> The name of this Person, suitable for display to end-users. Each |
381 Person returned MUST include a non-empty displayName value. The name | 443 Person returned MUST include a non-empty displayName value. The name |
382 SHOULD be the full name of the Person being described if known (e.g. | 444 SHOULD be the full name of the Person being described if known (e.g. |
383 Cassandra Doll or Mrs. Cassandra Lynn Doll, Esq.), but MAY be a username | 445 Cassandra Doll or Mrs. Cassandra Lynn Doll, Esq.), but MAY be a username |
384 or handle, if that is all that is available (e.g. doll). The value | 446 or handle, if that is all that is available (e.g. doll). The value |
385 provided SHOULD be the primary textual label by which this Person is | 447 provided SHOULD be the primary textual label by which this Person is |
386 normally displayed by the Service Provider when presenting it to | 448 normally displayed by the Service Provider when presenting it to |
387 end-users.</c> | 449 end-users.</c> |
388 <c>emails</c> | 450 <c>emails</c> |
389 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | 451 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<er ef target="./Core-Data.xml#Email">Email</eref>></c> |
390 <c>E-mail address for this Person. The value SHOULD be canonicalized by | 452 <c>E-mail address for this Person. The value SHOULD be canonicalized by |
391 the Service Provider, e.g.joseph@plaxo.com instead of | 453 the Service Provider, e.g.joseph@plaxo.com instead of |
392 joseph@PLAXO.COM.</c> | 454 joseph@PLAXO.COM.</c> |
455 <c>ethnicity</c> | |
456 <c>string</c> | |
457 <c>Person's ethnicity.</c> | |
458 <c>fashion</c> | |
459 <c>string</c> | |
460 <c>Person's thoughts on fashion.</c> | |
461 <c>food</c> | |
462 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
463 <c>Person's favorite food.</c> | |
393 <c>gender</c> | 464 <c>gender</c> |
394 <c>string</c> | 465 <c>string</c> |
395 <c>The gender of this person. Service Providers SHOULD return one of the | 466 <c>The gender of this person. Service Providers SHOULD return one of the |
396 following Canonical Values, if appropriate:male, female, or undisclosed, | 467 following Canonical Values, if appropriate:male, female, or undisclosed, |
397 and MAY return a different value if it is not covered by one of these | 468 and MAY return a different value if it is not covered by one of these |
398 Canonical Values.</c> | 469 Canonical Values.</c> |
470 <c>happiestWhen</c> | |
471 <c>string</c> | |
472 <c>Describes when the person is happiest.</c> | |
473 <c>hasApp</c> | |
474 <c><eref target="./Core-Data.xml#Boolean">Boolean</eref></c> | |
475 <c>Indicating whether the user has application installed.</c> | |
476 <c>heroes</c> | |
477 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
478 <c>Person's favorite heroes.</c> | |
479 <c>humor</c> | |
480 <c>string</c> | |
481 <c>Person's thoughts on humor.</c> | |
399 <c>id</c> | 482 <c>id</c> |
400 <c><x:ref>User-ID</x:ref></c> | 483 <c><x:ref>Person-Id</x:ref></c> |
401 <c><x:highlight>Required.</x:highlight> Unique identifier for the Person. Each Person returned MUST include a | 484 <c><x:highlight>Required.</x:highlight> Unique identifier for |
402 non-empty id value. This identifier MUST be unique across this user's | 485 the Person.</c> |
403 entire set of people, but MAY not be unique across multiple users' data. | |
404 It MUST be a stable ID that does not change when the same contact is | |
405 returned in subsequent requests. For instance, an e-mail address is not a | |
406 good id, because the same person may use a different e-mail address in | |
407 the future. Usually, an internal database ID is the right choice | |
408 here, e.g. "12345".</c> | |
409 <c>ims</c> | 486 <c>ims</c> |
410 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | 487 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> |
411 <c>Instant messaging address for this Person. No official | 488 <c>Instant messaging address for this Person. No official |
412 canonicalization rules exist for all instant messaging addresses, but | 489 canonicalization rules exist for all instant messaging addresses, but |
413 Service Providers SHOULD remove all whitespace and convert the address to | 490 Service Providers SHOULD remove all whitespace and convert the address to |
414 lowercase, if this is appropriate for the service this IM address is used | 491 lowercase, if this is appropriate for the service this IM address is used |
415 for. Instead of the standard Canonical Values for type, this field | 492 for. Instead of the standard Canonical Values for type, this field |
416 defines the following Canonical Values to represent currently popular IM | 493 defines the following Canonical Values to represent currently popular IM |
417 services: aim, gtalk, icq, xmpp,msn, skype, qq, and yahoo.</c> | 494 services: aim, gtalk, icq, xmpp,msn, skype, qq, and yahoo.</c> |
495 <c>interests</c> | |
496 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
497 <c>Person's interests, hobbies or passions.</c> | |
498 <c>jobInterests</c> | |
499 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
500 <c>Person's favorite jobs, or job interests and skills.</c> | |
501 <c>languagesSpoken</c> | |
502 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
503 <c>List of the languages that the person speaks as ISO 639-1 codes.</c> | |
504 <c>livingArrangement</c> | |
505 <c>string</c> | |
506 <c>Description of the person's living arrangemen.</c> | |
507 <c>location</c> | |
508 <c>string</c> | |
509 <c></c> | |
510 <c>lookingFor</c> | |
511 <c>string</c> | |
512 <c>Person's statement about who or what they are looking for, or | |
513 what they are interested in meeting people for.</c> | |
514 <c>movies</c> | |
515 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
516 <c>Person's favorite movies.</c> | |
517 <c>music</c> | |
518 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
519 <c>Person's favorite music.</c> | |
418 <c>name</c> | 520 <c>name</c> |
419 <c><x:ref>Name</x:ref></c> | 521 <c><x:ref>Name</x:ref></c> |
420 <c>The broken-out components and fully formatted version of the person's | 522 <c>The broken-out components and fully formatted version of the person's |
421 real name.</c> | 523 real name.</c> |
524 <c>networkPresence</c> | |
525 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
526 <c>Person's current network status. Specified as one of: AWAY, | |
527 CHAT, DND, OFFLINE, ONLINE OR XA.</c> | |
422 <c>nickname</c> | 528 <c>nickname</c> |
423 <c>string</c> | 529 <c>string</c> |
424 <c>The casual way to address this Person in real life, e.g. "Bob" or | 530 <c>The casual way to address this Person in real life, e.g. "Bob" or |
425 "Bobby" instead of "Robert". This field SHOULD NOT be used to represent a | 531 "Bobby" instead of "Robert". This field SHOULD NOT be used to represent a |
426 user's username (e.g. jsmarr or daveman692); the latter should be | 532 user's username (e.g. jsmarr or daveman692); the latter should be |
427 represented by the preferredUsername field.</c> | 533 represented by the preferredUsername field.</c> |
428 <c>note</c> | 534 <c>note</c> |
429 <c>string</c> | 535 <c>string</c> |
430 <c>Notes about this person, with an unspecified meaning or usage | 536 <c>Notes about this person, with an unspecified meaning or usage |
431 (normally notes by the user about this person). This field MAY contain | 537 (normally notes by the user about this person). This field MAY contain |
432 newlines.</c> | 538 newlines.</c> |
433 <c>organizations</c> | 539 <c>organizations</c> |
434 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<x: ref>Organization</x:ref>></c> | 540 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<x: ref>Organization</x:ref>></c> |
435 <c>A current or past organizational affiliation of this Person.</c> | 541 <c>A current or past organizational affiliation of this Person.</c> |
436 <c>phoneNumbers</c> | 542 <c>phoneNumbers</c> |
437 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | 543 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> |
438 <c>Phone number for this Person. No canonical value is assumed here. In | 544 <c>Phone number for this Person. No canonical value is assumed here. In |
439 addition to the standard Canonical Values for type, this field also | 545 addition to the standard Canonical Values for type, this field also |
440 defines the additional Canonical Values mobile, fax, and pager.</c> | 546 defines the additional Canonical Values mobile, fax, and pager.</c> |
441 <c>photos</c> | 547 <c>photos</c> |
442 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | 548 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <<er ef target="./Core-Data.xml#URL">URL</eref>></c> |
443 <c>URL of a photo of this person. The value SHOULD be a canonicalized | 549 <c>URL of a photo of this person. The value SHOULD be a canonicalized |
444 URL, and MUST point to an actual image file (e.g. a GIF, JPEG, or PNG | 550 URL, and MUST point to an actual image file (e.g. a GIF, JPEG, or PNG |
445 image file) rather than to a web page containing an image. Service | 551 image file) rather than to a web page containing an image. Service |
446 Providers MAY return the same image at different sizes, though it is | 552 Providers MAY return the same image at different sizes, though it is |
447 recognized that no standard for describing images of various sizes | 553 recognized that no standard for describing images of various sizes |
448 currently exists. Note that this field SHOULD NOT be used to send down | 554 currently exists. Note that this field SHOULD NOT be used to send down |
449 arbitrary photos taken by this user, but specifically profile photos of | 555 arbitrary photos taken by this user, but specifically profile photos of |
450 the contact suitable for display when describing the contact.</c> | 556 the contact suitable for display when describing the contact.</c> |
451 <c>preferredUsername</c> | 557 <c>preferredUsername</c> |
452 <c>string</c> | 558 <c>string</c> |
453 <c>The preferred username of this person on sites that ask for a username | 559 <c>The preferred username of this person on sites that ask for a username |
454 (e.g. jsmarr or daveman692). This field may be more useful for describing | 560 (e.g. jsmarr or daveman692). This field may be more useful for describing |
455 the owner (i.e. the value when /@me/@self is requested) than the user's | 561 the owner (i.e. the value when /@me/@self is requested) than the user's |
456 person, e.g. Consumers MAY wish to use this value to pre-populate a | 562 person, e.g. Consumers MAY wish to use this value to pre-populate a |
457 username for this user when signing up for a new service.</c> | 563 username for this user when signing up for a new service.</c> |
564 <c>profileSong</c> | |
565 <c><eref target="./Core-Data.xml#URL">URL</eref></c> | |
566 <c>URL of a person's profile song.</c> | |
567 <c>profileUrl</c> | |
568 <c><eref target="./Core-Data.xml#URL">URL</eref></c> | |
569 <c>Person's profile URL, specified as a string. This URL must be | |
570 fully qualified. Relative URLs will not work in gadgets.</c> | |
571 <c>profileVideo</c> | |
572 <c><eref target="./Core-Data.xml#URL">URL</eref></c> | |
573 <c>URL of a person's profile video.</c> | |
458 <c>published</c> | 574 <c>published</c> |
459 <c><eref target="./Core-Data.xml#Date">Date</eref></c> | 575 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
460 <c>The date this Person was first added to the user's address book or | 576 <c>The date this Person was first added to the user's address book or |
461 friends list (i.e. the creation date of this entry). The value MUST be a | 577 friends list (i.e. the creation date of this entry). The value MUST be a |
462 valid <eref target="./Core-Data.xml#Date">Date</eref>.</c> | 578 valid <eref target="./Core-Data.xml#Date">Date</eref>.</c> |
463 <c>relationships</c> | 579 <c>relationships</c> |
464 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | 580 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> |
465 <c>A bi-directionally asserted relationship type that was established | 581 <c>A bi-directionally asserted relationship type that was established |
466 between the user and this person by the Service Provider. The value | 582 between the user and this person by the Service Provider. The value |
467 SHOULD conform to one of the XFN relationship values (e.g. kin, friend, | 583 SHOULD conform to one of the XFN relationship values (e.g. kin, friend, |
468 contact, etc.) if appropriate, but MAY be an alternative value if needed. | 584 contact, etc.) if appropriate, but MAY be an alternative value if needed. |
469 Note this field is a parallel set of category labels to the tags field, | 585 Note this field is a parallel set of category labels to the tags field, |
470 but relationships MUST have been bi-directionally confirmed, whereas tags | 586 but relationships MUST have been bi-directionally confirmed, whereas tags |
471 are asserted by the user without acknowledgment by this Person. Note that | 587 are asserted by the user without acknowledgment by this Person. Note that |
472 this field consists only of a string value.</c> | 588 this field consists only of a string value.</c> |
589 <c>relationshipStatus</c> | |
590 <c>string</c> | |
591 <c>Person's relationship status.</c> | |
592 <c>religion</c> | |
593 <c>string</c> | |
594 <c>Person's relgion or religious views.</c> | |
595 <c>romance</c> | |
596 <c>string</c> | |
597 <c>Person's comments about romance.</c> | |
598 <c>scaredOf</c> | |
599 <c>string</c> | |
600 <c>What the person is scared of.</c> | |
601 <c>sexualOrientation</c> | |
602 <c>string</c> | |
603 <c>Person's sexual orientation.</c> | |
604 <c>smoker</c> | |
605 <c>string</c> | |
606 <c>Person's smoking status.</c> | |
607 <c>sports</c> | |
608 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
609 <c>Person's favorite sports</c> | |
610 <c>status</c> | |
611 <c>string</c> | |
612 <c>Person's status, headline or shoutout.</c> | |
473 <c>tags</c> | 613 <c>tags</c> |
474 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | 614 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> |
475 <c>A user-defined category label for this person, e.g. "favorite" or | 615 <c>A user-defined category label for this person, e.g. "favorite" or |
476 "web20". These values SHOULD be case-insensitive, and there SHOULD NOT be | 616 "web20". These values SHOULD be case-insensitive, and there SHOULD NOT be |
477 multiple tags provided for a given person that differ only in case. Note | 617 multiple tags provided for a given person that differ only in case. Note |
478 that this field consists only of a string value.</c> | 618 that this field consists only of a string value.</c> |
619 <c>thumbnailUrl</c>c> | |
620 <c>string</c> | |
621 <c>Person's photo thumbnail URL, specified as a string. This URL | |
622 must be fully qualified. Relative URLs will not work in | |
623 gadgets.</c> | |
624 <c>turnOffs</c> | |
625 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
626 <c>Person's turn offs.</c> | |
627 <c>turnOns</c> | |
628 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
629 <c>Person's turn ons.</c> | |
630 <c>tvShows</c> | |
631 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | |
632 <c>Person's favorite TV shows.</c> | |
479 <c>updated</c> | 633 <c>updated</c> |
480 <c><eref target="./Core-Data.xml#Date">Date</eref></c> | 634 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
481 <c>The most recent date the details of this Person were updated (i.e. the | 635 <c>The most recent date the details of this Person were updated (i.e. the |
482 modified date of this entry). The value MUST be a valid· | 636 modified date of this entry). The value MUST be a valid· |
483 <eref target="./Core-Data.xml#Date">Date</eref>. If this Person | 637 <eref target="./Core-Data.xml#Date">Date</eref>. If this Person |
484 has never been modified since its initial creation, the value MUST be the | 638 has never been modified since its initial creation, the value MUST be the |
485 same as the value of published. Note the updatedSince Query Parameter can | 639 same as the value of published. Note the updatedSince Query Parameter can |
486 be used to select only people whose updated value is equal to or more | 640 be used to select only people whose updated value is equal to or more |
487 recent than a given <eref | 641 recent than a given <eref |
488 target="./Core-Data.xml#Date">Date</eref>. This enables | 642 target="./Core-Data.xml#Date">Date</eref>. This enables |
489 Consumers to repeatedly | 643 Consumers to repeatedly |
490 access a user's data and only request newly added or updated contacts | 644 access a user's data and only request newly added or updated contacts |
491 since the last access time.</c> | 645 since the last access time.</c> |
492 <c>urls</c> | 646 <c>urls</c> |
493 <c><eref target="./Core-Data.xml#Plural-Field">Plural-Field</eref> <str ing></c> | 647 <c><eref |
648 target="./Core-Data.xml#Plural-Field">Plural-Field</eref> | |
649 <<eref | |
650 target="./Core-Data.xml#URL-Link">URL-Link</eref>></c> | |
494 <c>URL of a web page relating to this Person. The value SHOULD be | 651 <c>URL of a web page relating to this Person. The value SHOULD be |
495 canonicalized by the Service Provider, e.g.http://josephsmarr.com/about/ | 652 canonicalized by the Service Provider, e.g.http://josephsmarr.com/about/ |
496 instead of JOSEPHSMARR.COM/about/. In addition to the standard Canonical | 653 instead of JOSEPHSMARR.COM/about/. In addition to the standard Canonical |
497 Values for type, this field also defines the additional Canonical Values | 654 Values for type, this field also defines the additional Canonical Values |
498 blog and profile.</c> | 655 blog and profile.</c> |
499 <c>utcOffset</c> | 656 <c>utcOffset</c> |
500 <c><eref target="./Core-Data.xml#Date-UTC-Offset">Date-UTC-Offset</eref></ c> | 657 <c><eref target="./Core-Data.xml#Date-UTC-Offset">Date-UTC-Offset</eref></ c> |
501 <c>The offset from UTC of this Person's current time zone, as of the time | 658 <c>The offset from UTC of this Person's current time zone, as of the time |
502 this response was returned. The value MUST conform to the <eref | 659 this response was returned. The value MUST conform to the <eref |
503 target="./Core-Data.xml#Date-UTC-Offset">Date-UTC-Offset</eref>. Note that this value MAY | 660 target="./Core-Data.xml#Date-UTC-Offset">Date-UTC-Offset</eref>. Note that this value MAY |
504 change over time due to daylight saving time, and is thus meant to | 661 change over time due to daylight saving time, and is thus meant to |
505 signify only the current value of the user's timezone offset.</c> | 662 signify only the current value of the user's timezone offset.</c> |
506 <c>aboutMe</c> | |
507 <c>string</c> | |
508 <c>A general statement about the person.</c> | |
509 <c>bodyType</c> | |
510 <c>string</c> | |
511 <c>Person's body characteristics.</c> | |
512 <c>location</c> | |
513 <c>string</c> | |
514 <c></c> | |
515 <c>drinker</c> | |
516 <c>string</c> | |
517 <c>Person's drinking status.</c> | |
518 <c>ethnicity</c> | |
519 <c>string</c> | |
520 <c>Person's ethnicity.</c> | |
521 <c>fashion</c> | |
522 <c>string</c> | |
523 <c>Person's thoughts on fashion.</c> | |
524 <c>happiestWhen</c> | |
525 <c>string</c> | |
526 <c>Describes when the person is happiest.</c> | |
527 <c>humor</c> | |
528 <c>string</c> | |
529 <c>Person's thoughts on humor.</c> | |
530 <c>livingArrangement</c> | |
531 <c>string</c> | |
532 <c>Description of the person's living arrangemen.</c> | |
533 <c>lookingFor</c> | |
534 <c>string</c> | |
535 <c>Person's statement about who or what they are looking for, or | |
536 what they are interested in meeting people for.</c> | |
537 <c>profileSong</c> | |
538 <c>string</c> | |
539 <c>URL of a person's profile song.</c> | |
540 <c>profileVideo</c> | |
541 <c>string</c> | |
542 <c>URL of a person's profile video.</c> | |
543 <c>relationshipStatus</c> | |
544 <c>string</c> | |
545 <c>Person's relationship status.</c> | |
546 <c>religion</c> | |
547 <c>string</c> | |
548 <c>Person's relgion or religious views.</c> | |
549 <c>romance</c> | |
550 <c>string</c> | |
551 <c>Person's comments about romance.</c> | |
552 <c>scaredOf</c> | |
553 <c>string</c> | |
554 <c>What the person is scared of.</c> | |
555 <c>sexualOrientation</c> | |
556 <c>string</c> | |
557 <c>Person's sexual orientation.</c> | |
558 <c>smoker</c> | |
559 <c>string</c> | |
560 <c>Person's smoking status.</c> | |
561 <c>status</c> | |
562 <c>string</c> | |
563 <c>Person's status, headline or shoutout.</c> | |
564 </texttable> | 663 </texttable> |
565 </section> | 664 </section> |
566 </section> | 665 </section> |
567 <section title="Additional Social Data"> | 666 <section title="Additional Social Data"> |
568 <t>Additional Social Data objects are data objects that are | 667 <t>Additional Social Data objects are data objects that are |
569 contained within other Social Data object. These do not stand | 668 contained within other Social Data object. These do not stand |
570 alone, and are not directly accessable by API calls such as osapi, | 669 alone, and are not directly accessable by API calls such as osapi, |
571 REST, RPC and Pipelining.</t> | 670 REST, RPC and Pipelining.</t> |
572 <section title="Account" anchor="Account"> | 671 <section title="Account" anchor="Account"> |
573 <t>Describes an account held by this Person, which MAY be on the Service | 672 <t>Describes an account held by this Person, which MAY be on the Service |
574 Provider's service, or MAY be on a different service. Consumers SHOULD NOT | 673 Provider's service, or MAY be on a different service. Consumers SHOULD NOT |
575 assume that this account has been verified by the Service Provider to | 674 assume that this account has been verified by the Service Provider to |
576 actually belong to this Person. For each account, the domain is the | 675 actually belong to this Person. For each account, the domain is the |
577 top-most authoritative domain for this account, e.g. yahoo.com or | 676 top-most authoritative domain for this account, e.g. yahoo.com or |
578 reader.google.com, and MUST be non-empty. Each account must also contain a | 677 reader.google.com, and MUST be non-empty. Each account must also contain a |
579 non-empty value for either username or userId, and MAY contain both, in | 678 non-empty value for either username or userid, and MAY contain both, in |
580 which case the two values MUST be for the same account. These accounts can | 679 which case the two values MUST be for the same account. These accounts can |
581 be used to determine if a user on one service is also known to be the same | 680 be used to determine if a user on one service is also known to be the same |
582 person on a different service, to facilitate connecting to people the user | 681 person on a different service, to facilitate connecting to people the user |
583 already knows on different services. If Consumers want to turn these | 682 already knows on different services. If Consumers want to turn these |
584 accounts into profile URLs, they can use an open-source library like· | 683 accounts into profile URLs, they can use an open-source library like· |
585 <xref target="Social-Graph-Node-Mapper" />.· | 684 <xref target="Social-Graph-Node-Mapper" />.· |
586 <texttable> | 685 <texttable> |
587 <ttcol align="left" width="15%">Field Name</ttcol> | 686 <ttcol align="left" width="15%">Field Name</ttcol> |
588 <ttcol align="left" width="21%">Field Type</ttcol> | 687 <ttcol align="left" width="21%">Field Type</ttcol> |
589 <ttcol align="left">Description</ttcol> | 688 <ttcol align="left">Description</ttcol> |
590 <c>domain</c> | 689 <c>domain</c> |
591 <c>string</c> | 690 <c>string</c> |
592 <c>The top-most authoritative domain for this account, e.g. | 691 <c>The top-most authoritative domain for this account, e.g. |
593 "twitter.com". This is the Primary Sub-Field for this field, for the | 692 "twitter.com". This is the Primary Sub-Field for this field, for the |
594 purposes of sorting and filtering.</c> | 693 purposes of sorting and filtering.</c> |
694 <c>userid</c> | |
695 <c>string</c> | |
Lane LiaBraaten
2009/12/10 19:18:52
should be of type User-Id (or Person-Id)
| |
696 <c>A user ID associated with this account.</c> | |
595 <c>username</c> | 697 <c>username</c> |
596 <c>string</c> | 698 <c>string</c> |
597 <c>An alphanumeric user name, usually chosen by the user, e.g. | 699 <c>An alphanumeric user name, usually chosen by the user, e.g. |
598 "jsmarr".</c> | 700 "jsmarr".</c> |
599 <c>userId</c> | |
600 <c>string</c> | |
601 <c>A user ID number, usually chosen automatically, and usually numeric | |
602 but sometimes alphanumeric, e.g. "12345" or "1Z425A".</c> | |
603 </texttable></t> | 701 </texttable></t> |
604 </section> | 702 </section> |
605 <section title="Address" anchor="Address"> | 703 <section title="Address" anchor="Address"> |
606 <t>The components of a physical mailing address. Service | 704 <t>The components of a physical mailing address. Service |
607 Providers MAY return just the full address as a single string in | 705 Providers MAY return just the full address as a single string in |
608 the formattedsub-field, or they MAY return just the individual | 706 the formattedsub-field, or they MAY return just the individual |
609 component fields using the other sub-fields, or they MAY return | 707 component fields using the other sub-fields, or they MAY return |
610 both. If both variants are returned, they SHOULD be describing | 708 both. If both variants are returned, they SHOULD be describing |
611 the same address, with the formatted address indicating how the | 709 the same address, with the formatted address indicating how the |
612 component fields should be combined.</t> | 710 component fields should be combined.</t> |
613 <t><texttable> | 711 <t><texttable> |
614 <ttcol align="left" width="15%">Field Name</ttcol> | 712 <ttcol align="left" width="15%">Field Name</ttcol> |
615 <ttcol align="left" width="21%">Field Type</ttcol> | 713 <ttcol align="left" width="21%">Field Type</ttcol> |
616 <ttcol align="left">Description</ttcol> | 714 <ttcol align="left">Description</ttcol> |
715 <c>country</c> | |
716 <c>string</c> | |
717 <c>The country name component.</c> | |
617 <c>formatted</c> | 718 <c>formatted</c> |
618 <c>string</c> | 719 <c>string</c> |
619 <c>The full mailing address, formatted for display or use with a mailing | 720 <c>The full mailing address, formatted for display or use with a mailing |
620 label. This field MAY contain newlines. This is the Primary Sub-Field for | 721 label. This field MAY contain newlines. This is the Primary Sub-Field for |
621 this field, for the purposes of sorting and filtering.</c> | 722 this field, for the purposes of sorting and filtering.</c> |
723 <c>latitude</c> | |
724 <c>string</c> | |
725 <c>Expresses the latitude of the location on a map.</c> | |
726 <c>locality</c> | |
727 <c>string</c> | |
728 <c>The city or locality component.</c> | |
729 <c>longitude</c> | |
730 <c>string</c> | |
731 <c>Expresses the longitude of the location on a map.</c> | |
732 <c>postalCode</c> | |
733 <c>string</c> | |
734 <c>The zipcode or postal code component.</c> | |
735 <c>region</c> | |
736 <c>string</c> | |
737 <c>The state or region component.</c> | |
622 <c>streetAddress</c> | 738 <c>streetAddress</c> |
623 <c>string</c> | 739 <c>string</c> |
624 <c>The full street address component, which may include house number, | 740 <c>The full street address component, which may include house number, |
625 street name, PO BOX, and multi-line extended street address information. | 741 street name, PO BOX, and multi-line extended street address information. |
626 This field MAY contain newlines.</c> | 742 This field MAY contain newlines.</c> |
627 <c>locality</c> | |
628 <c>string</c> | |
629 <c>The city or locality component.</c> | |
630 <c>region</c> | |
631 <c>string</c> | |
632 <c>The state or region component.</c> | |
633 <c>postalCode</c> | |
634 <c>string</c> | |
635 <c>The zipcode or postal code component.</c> | |
636 <c>country</c> | |
637 <c>string</c> | |
638 <c>The country name component.</c> | |
639 <c>latitude</c> | |
640 <c>string</c> | |
641 <c>Expresses the latitude of the location on a map.</c> | |
642 <c>longitude</c> | |
643 <c>string</c> | |
644 <c>Expresses the longitude of the location on a map.</c> | |
645 <c>type</c> | |
646 <c>string</c> | |
647 <c>The address type or label. Examples include 'work', 'home'.</c> | |
648 </texttable></t> | 743 </texttable></t> |
649 </section> | 744 </section> |
650 <section title="Group ID" | 745 <section title="Album" |
651 anchor="Group-ID"> | 746 anchor="Album"> |
652 <t>The group ID must only contain alphanumeric (A-Za-z0-9) characters, | 747 <t>Represents an album. |
653 underscore(_), dot(.) or dash(-), and must uniquely identify the group in a | 748 <texttable> |
654 container.</t> | 749 <ttcol align="left" width="15%">Field Name</ttcol> |
750 <ttcol align="left" width="21%">Field Type</ttcol> | |
751 <ttcol align="left">Description</ttcol> | |
752 <c>description</c> | |
753 <c>string</c> | |
754 <c>Description of the album</c> | |
755 <c>id</c> | |
756 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> | |
757 <c>Unique identifier for the album.</c> | |
758 <c>location</c> | |
759 <c><x:ref>Address</x:ref></c> | |
760 <c>Location corresponding to the album.</c> | |
761 <c>mediaItemCount</c> | |
762 <c>integer</c> | |
763 <c>Number of items in the album.</c> | |
764 <c>mediaMimeType</c> | |
765 <c>Array <string></c> | |
766 <c>Array of strings identifying the mime-types of media items in | |
767 the Album.</c> | |
768 <c>mediaType</c> | |
769 <c>Array <string></c> | |
770 <c>Array of MediaItem types, types are one of: audio, image, video.</c> | |
771 <c>ownerId</c> | |
772 <c><x:ref>Person-Id</x:ref></c> | |
773 <c>ID of the owner of the album.</c> | |
774 <c>thumbnailUrl</c> | |
775 <c><eref target="./Core-Data.xml#URL">URL</eref></c> | |
776 <c>URL to a thumbnail cover of the album.</c> | |
777 <c>title</c> | |
778 <c>string</c> | |
779 <c>the title of the album.</c> | |
780 </texttable> | |
781 </t> | |
782 </section> | |
783 <section title="BodyType" | |
784 anchor="BodyType"> | |
785 <t>Represents a body type. | |
786 <texttable> | |
787 <ttcol align="left" width="15%">Field Name</ttcol> | |
788 <ttcol align="left" width="21%">Field Type</ttcol> | |
789 <ttcol align="left">Description</ttcol> | |
790 <c>build</c> | |
791 <c>string</c> | |
792 <c>The build of the person's body.</c> | |
793 <c>eyeColor</c> | |
794 <c>string</c> | |
795 <c>The eye color of the person.</c> | |
796 <c>hairColor</c> | |
797 <c>string</c> | |
798 <c>The hair color of the person.</c> | |
799 <c>height</c> | |
800 <c>number</c> | |
801 <c>The height of the person in meters.</c> | |
802 <c>weight</c> | |
803 <c>number</c> | |
804 <c>The weight of the person in kilograms.</c> | |
805 </texttable> | |
806 </t> | |
807 </section> | |
808 <section title="Group-Id" | |
809 anchor="Group-Id"> | |
810 <t>The ID of a Group.</t> | |
655 <artwork type="abnf" | 811 <artwork type="abnf" |
656 xml:space="preserve"> | 812 xml:space="preserve"> |
657 Group-ID = *( DIGIT / ALPHA / "_" / "-" / ".") / "@self" / "@friends" / "@all" | 813 Group-Id = <eref target="./Core-Data.xml#Object-Id">Object-Id</eref> / Special-G roup-Id |
814 Special-Group-Id = "@self" / "@friends" / "@all" | |
658 </artwork> | 815 </artwork> |
816 <t>The Special-Group-Id is only valid within the context of a | |
817 Person. The person may be specified explicitly as part of the | |
818 request, or implicitly as part of the authentication | |
819 credentials.</t> | |
820 <texttable> | |
821 <ttcol align="left" width="15%">ID</ttcol> | |
822 <ttcol align="left">Description</ttcol> | |
823 <c>@all</c> | |
824 <c>@all represents everything that is visible to the | |
825 request.</c> | |
826 <c>@friends</c> | |
827 <c> @friends is a group containing People who the Person in the | |
828 context has a relationship with. Some queries may allow | |
829 parameters like networkDistance to further qualify the friends | |
830 relationship.</c> | |
831 <c>@self</c> | |
832 <c>@self represents a group with that person as the only member.</c> | |
833 </texttable> | |
659 </section> | 834 </section> |
660 <section title="MediaItem" | 835 <section title="MediaItem" |
661 anchor="MediaItem"> | 836 anchor="MediaItem"> |
662 <t>Represents images, movies, and audio. | 837 <t>Represents images, movies, and audio. |
663 <texttable> | 838 <texttable> |
664 <ttcol align="left" width="15%">Field Name</ttcol> | 839 <ttcol align="left" width="15%">Field Name</ttcol> |
665 <ttcol align="left" width="21%">Field Type</ttcol> | 840 <ttcol align="left" width="21%">Field Type</ttcol> |
666 <ttcol align="left">Description</ttcol> | 841 <ttcol align="left">Description</ttcol> |
667 <c>album_id</c> | 842 <c>album_id</c> |
668 <c>string</c> | 843 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
669 <c>Album to which the media item belongs.</c> | 844 <c>Album to which the media item belongs.</c> |
670 <c>created</c> | 845 <c>created</c> |
671 <c>string</c> | 846 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
672 <c>Creation datetime associated with the media item - | 847 <c>Creation datetime associated with the media item - |
673 assigned by container in UTC.</c> | 848 assigned by container in UTC.</c> |
674 <c>description</c> | 849 <c>description</c> |
675 <c>string</c> | 850 <c>string</c> |
676 <c>Description of the media item.</c> | 851 <c>Description of the media item.</c> |
677 <c>duration</c> | 852 <c>duration</c> |
678 <c>integer</c> | 853 <c>integer</c> |
679 <c>For audio/video clips - playtime length in | 854 <c>For audio/video clips - playtime length in |
680 seconds. set to -1/not defined if unknown.</c> | 855 seconds. set to -1/not defined if unknown.</c> |
681 <c>file_size</c> | 856 <c>file_size</c> |
682 <c>long</c> | 857 <c>long</c> |
683 <c>Number of bytes (set to -1/undefined if unknown).</c> | 858 <c>Number of bytes (set to -1/undefined if unknown).</c> |
684 <c>id</c> | 859 <c>id</c> |
685 <c>string</c> | 860 <c><eref target="./Core-Data.xml#Object-Id">Object-Id</eref></c> |
686 <c>Id Associated with the media item.</c> | 861 <c>Id Associated with the media item.</c> |
687 <c>language</c> | 862 <c>language</c> |
688 <c>string</c> | 863 <c>string</c> |
689 <c>Language associated with the media item in ISO | 864 <c>Language associated with the media item in ISO |
690 639-3 format.</c> | 865 639-3 format.</c> |
691 <c>last_updated</c> | 866 <c>last_updated</c> |
692 <c>string</c> | 867 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
693 <c>Update datetime associated with the media item - | 868 <c>Update datetime associated with the media item - |
694 assigned by container in UTC.</c> | 869 assigned by container in UTC.</c> |
695 <c>location</c> | 870 <c>location</c> |
696 <c>Address</c> | 871 <c>Address</c> |
697 <c>Location corresponding to the media item.</c> | 872 <c>Location corresponding to the media item.</c> |
698 <c>mime_type</c> | 873 <c>mime_type</c> |
699 <c>string</c> | 874 <c>string</c> |
700 <c>The MIME type of media, specified as a string.</c> | 875 <c>The MIME type of media, specified as a string.</c> |
701 <c>num_comments</c> | 876 <c>num_comments</c> |
702 <c>integer</c> | 877 <c>integer</c> |
703 <c>Number of comments on the media item.</c> | 878 <c>Number of comments on the media item.</c> |
704 <c>num_views</c> | 879 <c>num_views</c> |
705 <c>integer</c> | 880 <c>integer</c> |
706 <c>Number of views for the media item.</c> | 881 <c>Number of views for the media item.</c> |
707 <c>num_votes</c> | 882 <c>num_votes</c> |
708 <c>integer</c> | 883 <c>integer</c> |
709 <c>Number of votes received for voting.</c> | 884 <c>Number of votes received for voting.</c> |
710 <c>rating</c> | 885 <c>rating</c> |
711 <c>integer</c> | 886 <c>integer</c> |
712 <c>Average rating of the media item on a scale of 0-10.</c> | 887 <c>Average rating of the media item on a scale of 0-10.</c> |
713 <c>start_time</c> | 888 <c>start_time</c> |
714 <c>string</c> | 889 <c><eref target="./Core-Data.xml#Date">Date</eref></c> |
715 <c>For streaming/live content, datetime when the | 890 <c>For streaming/live content, datetime when the |
716 content is available.</c> | 891 content is available.</c> |
717 <c>tagged_people</c> | 892 <c>tagged_people</c> |
718 <c>Array<string></c> | 893 <c>Array<string></c> |
719 <c>Array of string (IDs) of people tagged | 894 <c>Array of string (IDs) of people tagged |
720 in the media item.</c> | 895 in the media item.</c> |
721 <c>tags</c> | 896 <c>tags</c> |
722 <c>Array<string></c> | 897 <c>Array<string></c> |
723 <c>Tags associated with this media item.</c> | 898 <c>Tags associated with this media item.</c> |
724 <c>thumbnail_url</c> | 899 <c>thumbnail_url</c> |
725 <c>string</c> | 900 <c><eref target="./Core-Data.xml#URL">URL</eref></c> |
726 <c>URL to a thumbnail image of the media item.</c> | 901 <c>URL to a thumbnail image of the media item.</c> |
727 <c>title</c> | 902 <c>title</c> |
728 <c>string</c> | 903 <c>string</c> |
729 <c>Describing the media item.</c> | 904 <c>Describing the media item.</c> |
730 <c>type</c> | |
731 <c>string</c> | |
732 <c>The type of media, specified as a MediaItem.Type object.</c> | |
733 <c>url</c> | 905 <c>url</c> |
734 <c>string</c> | 906 <c><eref target="./Core-Data.xml#URL">URL</eref></c> |
735 <c>Specifying the URL where the media can be found.</c> | 907 <c>Specifying the URL where the media can be found.</c> |
736 </texttable> | 908 </texttable> |
737 </t> | 909 </t> |
910 </section> | |
911 <section title="Message-Collection-Id" | |
912 anchor="Message-Collection-Id"> | |
913 <t>The ID of a container of messages.</t> | |
914 <artwork type="abnf" | |
915 xml:space="preserve"> | |
916 Message-Collection-Id = <eref target="./Core-Data.xml#Object-Id">Object-Id</eref > / Special-Message-Collection-Id | |
917 Special-Message-Collection-Id = "@inbox" / "@outbox" | |
918 </artwork> | |
919 <t>The Special-Message-Collection-Id is only valid within the context of a | |
920 Person. The person may be specified explicitly as part of the | |
921 request, or implicitly as part of the authentication | |
922 credentials.</t> | |
923 <texttable> | |
924 <ttcol align="left" width="15%">ID</ttcol> | |
925 <ttcol align="left">Description</ttcol> | |
926 <c>@inbox</c> | |
927 <c>@inbox represents the collection of all messages sent to the | |
928 user</c> | |
929 <c>@outbox</c> | |
930 <c> @outbox represents the collection of all messages sent by | |
931 the user and is used as a special endpoint for posting outbound | |
932 messages.</c> | |
933 </texttable> | |
738 </section> | 934 </section> |
739 <section title="Name" | 935 <section title="Name" |
740 anchor="Name"> | 936 anchor="Name"> |
741 <t>The components of the person's real name. Providers MAY return just the | 937 <t>The components of the person's real name. Providers MAY return just the |
742 full name as a single string in the formatted sub-field, or they MAY | 938 full name as a single string in the formatted sub-field, or they MAY |
743 return just the individual component fields using the other sub-fields, or | 939 return just the individual component fields using the other sub-fields, or |
744 they MAY return both. If both variants are returned, they SHOULD be | 940 they MAY return both. If both variants are returned, they SHOULD be |
745 describing the same name, with the formatted name indicating how the | 941 describing the same name, with the formatted name indicating how the |
746 component fields should be combined.· | 942 component fields should be combined.· |
747 <texttable> | 943 <texttable> |
748 <ttcol align="left" width="15%">Field Name</ttcol> | 944 <ttcol align="left" width="15%">Field Name</ttcol> |
749 <ttcol align="left" width="21%">Field Type</ttcol> | 945 <ttcol align="left" width="21%">Field Type</ttcol> |
750 <ttcol align="left">Description</ttcol> | 946 <ttcol align="left">Description</ttcol> |
751 <c>formatted</c> | 947 <c>formatted</c> |
752 <c>string</c> | 948 <c>string</c> |
753 <c>The full name, including all middle names, titles, and suffixes as | 949 <c>The full name, including all middle names, titles, and suffixes as |
754 appropriate, formatted for display (e.g. Mr. Joseph Robert Smarr, Esq.). | 950 appropriate, formatted for display (e.g. Mr. Joseph Robert Smarr, Esq.). |
755 This is the Primary Sub-Field for this field, for the purposes of sorting | 951 This is the Primary Sub-Field for this field, for the purposes of sorting |
756 and filtering.</c> | 952 and filtering.</c> |
757 <c>familyName</c> | 953 <c>familyName</c> |
758 <c>string</c> | 954 <c>string</c> |
759 <c>he family name of this Person, or "Last Name" in most Western | 955 <c>he family name of this Person, or "Last Name" in most Western |
760 languages (e.g. Smarr given the full name Mr. Joseph Robert Smarr, | 956 languages (e.g. Smarr given the full name Mr. Joseph Robert Smarr, |
761 Esq.).</c> | 957 Esq.).</c> |
762 <c>givenName</c> | 958 <c>givenName</c> |
763 <c>string</c> | 959 <c>string</c> |
764 <c>The given name of this Person, or "First Name" in most Western | 960 <c>The given name of this Person, or "First Name" in most Western |
765 languages (e.g. Joseph given the full name Mr. Joseph Robert Smarr, | 961 languages (e.g. Joseph given the full name Mr. Joseph Robert Smarr, |
766 Esq.).</c> | 962 Esq.).</c> |
767 <c>middleName</c> | |
768 <c>string</c> | |
769 <c>The middle name(s) of this Person (e.g. Robert given the full name Mr. | |
770 Joseph Robert Smarr, Esq.).</c> | |
771 <c>honorificPrefix</c> | 963 <c>honorificPrefix</c> |
772 <c>string</c> | 964 <c>string</c> |
773 <c>The honorific prefix(es) of this Person, or "Title" in most Western | 965 <c>The honorific prefix(es) of this Person, or "Title" in most Western |
774 languages (e.g. Mr. given the full name Mr. Joseph Robert Smarr, | 966 languages (e.g. Mr. given the full name Mr. Joseph Robert Smarr, |
775 Esq.).</c> | 967 Esq.).</c> |
776 <c>honorificSuffix</c> | 968 <c>honorificSuffix</c> |
777 <c>string</c> | 969 <c>string</c> |
778 <c>The honorifix suffix(es) of this Person, or "Suffix" in most Western | 970 <c>The honorifix suffix(es) of this Person, or "Suffix" in most Western |
779 languages (e.g. Esq. given the full name Mr. Joseph Robert Smarr, | 971 languages (e.g. Esq. given the full name Mr. Joseph Robert Smarr, |
780 Esq.).</c> | 972 Esq.).</c> |
973 <c>middleName</c> | |
974 <c>string</c> | |
975 <c>The middle name(s) of this Person (e.g. Robert given the full name Mr. | |
976 Joseph Robert Smarr, Esq.).</c> | |
781 </texttable></t> | 977 </texttable></t> |
782 </section> | 978 </section> |
783 <section title="Organization" anchor="Organization"> | 979 <section title="Organization" anchor="Organization"> |
784 <t>Describes a current or past organizational affiliation of this contact. | 980 <t>Describes a current or past organizational affiliation of this contact. |
785 Service Providers that support only a single Company Name and Job Title | 981 Service Providers that support only a single Company Name and Job Title |
786 field should represent them with a single organization element with name | 982 field should represent them with a single organization element with name |
787 and title properties, respectively.· | 983 and title properties, respectively.· |
788 <texttable> | 984 <texttable> |
789 <ttcol align="left" width="15%">Field Name</ttcol> | 985 <ttcol align="left" width="15%">Field Name</ttcol> |
790 <ttcol align="left" width="21%">Field Type</ttcol> | 986 <ttcol align="left" width="21%">Field Type</ttcol> |
791 <ttcol align="left">Description</ttcol> | 987 <ttcol align="left">Description</ttcol> |
792 <c>name</c> | 988 <c>address</c> |
793 <c>string</c> | 989 <c><x:ref>Address</x:ref></c> |
794 <c>The name of the organization (e.g. company, school, or other | 990 <c>The physical address of this organization.</c> |
795 organization). This field MUST have a non-empty value for each | |
796 organization returned. This is the Primary Sub-Field for this field, for | |
797 the purposes of sorting and filtering.</c> | |
798 <c>department</c> | 991 <c>department</c> |
799 <c>string</c> | 992 <c>string</c> |
800 <c>The department within this organization.</c> | 993 <c>The department within this organization.</c> |
801 <c>title</c> | 994 <c>description</c> |
802 <c>string</c> | 995 <c>string</c> |
803 <c>The job title or organizational role within this organization.</c> | 996 <c>A textual description of the role this Person played in this |
804 <c>type</c> | 997 organization. This field MAY contain newlines.</c> |
805 <c>string</c> | 998 <c>endDate</c> |
806 <c>The type of organization, with Canonical Values job and school.</c> | 999 <c><eref target="./Core-Data.xml#Date">Date</eref> or string</c> |
1000 <c>The date this Person left this organization or the role specified by | |
1001 title within this organization. This value SHOULD be a valid· | |
1002 <eref target="./Core-Data.xml#Date">Date</eref> if possible, but MAY be an unformatted | |
1003 string, since it is recognized that this field is often presented as | |
1004 free-text.</c> | |
807 <c>startDate</c> | 1005 <c>startDate</c> |
808 <c><eref target="./Core-Data.xml#Date">Date</eref> or string</c>· | 1006 <c><eref target="./Core-Data.xml#Date">Date</eref> or string</c>· |
809 <c>The date this Person joined this organization. This value SHOULD be a | 1007 <c>The date this Person joined this organization. This value SHOULD be a |
810 valid <eref target="./Core-Data.xml#Date">Date</eref> | 1008 valid <eref target="./Core-Data.xml#Date">Date</eref> |
811 if possible, but MAY be an unformatted | 1009 if possible, but MAY be an unformatted |
812 string, since it is recognized that this field is often presented as | 1010 string, since it is recognized that this field is often presented as |
813 free-text.</c> | 1011 free-text.</c> |
814 <c>endDate</c> | 1012 <c>subfield</c> |
815 <c><eref target="./Core-Data.xml#Date">Date</eref> or string</c> | 1013 <c>string</c> |
816 <c>The date this Person left this organization or the role specified by | 1014 <c>The subfield the Organization is in.</c> |
817 title within this organization. This value SHOULD be a valid· | 1015 <c>title</c> |
818 <eref target="./Core-Data.xml#Date">Date</eref> if possible, but MAY be an unformatted | 1016 <c>string</c> |
819 string, since it is recognized that this field is often presented as | 1017 <c>The job title or organizational role within this |
820 free-text.</c> | 1018 organization.</c> |
821 <c>location</c> | 1019 <c>webpage</c> |
822 <c><x:ref>Account</x:ref> or string</c> | 1020 <c>string</c> |
823 <c>The physical location of this organization. This may be a | 1021 <c>A webpage related to the organization.</c> |
824 complete <x:ref>Account</x:ref>, or an abbreviated | |
825 location like "San Francisco".</c> | |
826 <c>description</c> | |
827 <c>string</c> | |
828 <c>A textual description of the role this Person played in this | |
829 organization. This field MAY contain newlines.</c> | |
830 </texttable></t> | 1022 </texttable></t> |
1023 </section> | |
1024 <section title="Person-Id" | |
1025 anchor="Person-Id"> | |
1026 <t>The ID used to refer to a Person object. The Speical-Person-Id | |
1027 may be available, depending upon the methods used to access the | |
1028 data.</t> | |
1029 <artwork type="abnf" | |
1030 xml:space="preserve"> | |
1031 Person-Id = <eref target="./Core-Data.xml#Object-Id">Object-Id</eref> / Special- Person-Id | |
1032 Special-Person-Id = "@me" / "@owner" / "@viewer" | |
1033 </artwork> | |
1034 <texttable> | |
1035 <ttcol align="left" width="15%">ID</ttcol> | |
1036 <ttcol align="left">Description</ttcol> | |
1037 <c>@me</c> | |
1038 <c>Valid for any request where authentication is present. @me | |
1039 shall refer to the person who is associated with the | |
1040 authentication credentials.</c> | |
1041 <c>@owner</c> | |
1042 <c>Valid in the context of a rendered gadget in a | |
1043 browser. @owner shall refer to the person who requested the | |
1044 gadget to be placed upon the currently viewed page.</c> | |
1045 <c>@viewer</c> | |
1046 <c>Valid in the context of a rendered gadget in a | |
1047 browser. @viewer shall refer to the person who is currently | |
1048 viewing the page. In this context, it is interchangeable with | |
1049 @me.</c> | |
1050 </texttable> | |
831 </section> | 1051 </section> |
832 </section> | 1052 </section> |
833 </middle> | 1053 </middle> |
834 <back> | 1054 <back> |
835 <references> | 1055 <references> |
1056 <reference anchor='RFC20'> | |
1057 <front> | |
1058 <title>ASCII format for Network Interchange</title> | |
1059 </front> | |
1060 <seriesInfo name='RFC' | |
1061 value='20' /> | |
1062 </reference> | |
836 <reference anchor='RFC2119'> | 1063 <reference anchor='RFC2119'> |
837 <front> | 1064 <front> |
838 <title>Key words for use in RFCs to Indicate Requirement Levels</title> | 1065 <title>Key words for use in RFCs to Indicate Requirement Levels</title> |
839 <author initials='S.' | 1066 <author initials='S.' |
840 surname='Bradner' | 1067 surname='Bradner' |
841 fullname='Scott Bradner'> | 1068 fullname='Scott Bradner'> |
842 <organization abbrev='HarvardU'>Harvard University</organization> | 1069 <organization abbrev='HarvardU'>Harvard University</organization> |
843 </author> | 1070 </author> |
844 <date month='March' | 1071 <date month='March' |
845 year='1997' /> | 1072 year='1997' /> |
846 </front> | 1073 </front> |
847 <seriesInfo name='RFC' value='2119' /> | 1074 <seriesInfo name='RFC' value='2119' /> |
1075 </reference> | |
1076 <reference anchor='RFC2234'> | |
1077 <front> | |
1078 <title>Augmented BNF for Syntax Specifications: ABNF</title> | |
1079 </front> | |
1080 <seriesInfo name='RFC' | |
1081 value='2234' /> | |
848 </reference> | 1082 </reference> |
849 <reference anchor='RFC2606'> | 1083 <reference anchor='RFC2606'> |
850 <front> | 1084 <front> |
851 <title>Reserved Top Level DNS Names</title> | 1085 <title>Reserved Top Level DNS Names</title> |
852 <author initials='D.' | 1086 <author initials='D.' |
853 surname='Eastlake' | 1087 surname='Eastlake' |
854 fullname='Donald E. Eastlake 3rd'> | 1088 fullname='Donald E. Eastlake 3rd'> |
855 <organization abbrev='IBM'>IBM</organization> | 1089 <organization abbrev='IBM'>IBM</organization> |
856 </author> | 1090 </author> |
857 <author initials='A.' | 1091 <author initials='A.' |
858 surname='Panitz' | 1092 surname='Panitz' |
859 fullname='Aliza R. Panitz'></author> | 1093 fullname='Aliza R. Panitz'></author> |
860 <date month='June' | 1094 <date month='June' |
861 year='1999' /> | 1095 year='1999' /> |
862 </front> | 1096 </front> |
863 <seriesInfo name='RFC' | 1097 <seriesInfo name='RFC' |
864 value='2606' /> | 1098 value='2606' /> |
865 </reference> | |
866 <reference anchor='RFC2234'> | |
867 <front> | |
868 <title>Augmented BNF for Syntax Specifications: ABNF</title> | |
869 </front> | |
870 <seriesInfo name='RFC' | |
871 value='2234' /> | |
872 </reference> | |
873 <reference anchor='RFC20'> | |
874 <front> | |
875 <title>ASCII format for Network Interchange</title> | |
876 </front> | |
877 <seriesInfo name='RFC' | |
878 value='20' /> | |
879 </reference> | |
880 <reference anchor='Social-Graph-Node-Mapper' | |
881 target='http://code.google.com/p/google-sgnodemapper/'> | |
882 <front> | |
883 <title>Social Graph Node Mapper</title> | |
884 </front> | |
885 </reference> | 1099 </reference> |
886 <reference anchor='CoreData' | 1100 <reference anchor='CoreData' |
887 target="./Core-Data.xml"> | 1101 target="./Core-Data.xml"> |
888 <front> | 1102 <front> |
889 <title>OpenSocial Core Data Specification</title> | 1103 <title>OpenSocial Core Data Specification</title> |
890 <author fullname='OpenSocial and Gadgets Specification Group | 1104 <author fullname='OpenSocial and Gadgets Specification Group |
891 <opensocial-and-gadgets-spec@googlegroups.com>'></a uthor> | 1105 <opensocial-and-gadgets-spec@googlegroups.com>'></a uthor> |
892 <date month='December' | 1106 <date month='December' |
893 year='2009' /> | 1107 year='2009' /> |
894 </front> | 1108 </front> |
(...skipping 11 matching lines...) Expand all Loading... | |
906 <reference anchor='SocialServer' | 1120 <reference anchor='SocialServer' |
907 target="./Social-API-Server.xml"> | 1121 target="./Social-API-Server.xml"> |
908 <front> | 1122 <front> |
909 <title>OpenSocial Social API Server Specification</title> | 1123 <title>OpenSocial Social API Server Specification</title> |
910 <author fullname='OpenSocial and Gadgets Specification Group | 1124 <author fullname='OpenSocial and Gadgets Specification Group |
911 <opensocial-and-gadgets-spec@googlegroups.com>'></a uthor> | 1125 <opensocial-and-gadgets-spec@googlegroups.com>'></a uthor> |
912 <date month='December' | 1126 <date month='December' |
913 year='2009' /> | 1127 year='2009' /> |
914 </front> | 1128 </front> |
915 </reference> | 1129 </reference> |
1130 <reference anchor='Social-Graph-Node-Mapper' | |
1131 target='http://code.google.com/p/google-sgnodemapper/'> | |
1132 <front> | |
1133 <title>Social Graph Node Mapper</title> | |
1134 </front> | |
1135 </reference> | |
916 </references> | 1136 </references> |
917 </back> | 1137 </back> |
918 </rfc> | 1138 </rfc> |
LEFT | RIGHT |