This HTML5 document contains 9 embedded RDF statements represented using HTML+Microdata notation.

The embedded RDF content will be recognized by any processor of HTML5 Microdata.

Subject Item

n2:list

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n4:isWebServiceOf

n5:this_ODSUserModuleAPI

n4:endPointURL

n6:list

schema:shortDescription

<p>Get a list of pending and rejected invitations. </p>

schema:name

EntryPoint - user_invitation_list

schema:description

<p>ODS allows users to be connected in a social network. This requires users to send invitations to other users. The other users then need to either approve or reject that invitation.</p><p>This method lists the invitations other users sent to the authenticated user and invitations the authenticated user sent to others.</p><p><simplesect kind="return"><p>A JSON stream listing all invitations.</p></simplesect> <bold>Example:</bold> <programlisting><codeline><highlight class="normal"><sp />{</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /></highlight><highlight class="stringliteral">"incoming"</highlight><highlight class="normal">:<sp />[</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"id"</highlight><highlight class="normal">:<sp />1,</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"from"</highlight><highlight class="normal">:<sp /></highlight><highlight class="stringliteral">"hans"</highlight><highlight class="normal">,</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"date"</highlight><highlight class="normal">:<sp /></highlight><highlight class="stringliteral">"2013-03-15<sp />11:02:37"</highlight><highlight class="normal">,</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"status"</highlight><highlight class="normal">:<sp /></highlight><highlight class="stringliteral">"pending"</highlight><highlight class="normal" /></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp />],</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /></highlight><highlight class="stringliteral">"outgoing"</highlight><highlight class="normal">:<sp />[</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"id"</highlight><highlight class="normal">:<sp />2,</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"to"</highlight><highlight class="normal">:<sp /></highlight><highlight class="stringliteral">"egon@wust.com"</highlight><highlight class="normal">,</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"date"</highlight><highlight class="normal">:<sp /></highlight><highlight class="stringliteral">"2013-03-15<sp />14:06:32"</highlight><highlight class="normal">,</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class="stringliteral">"status"</highlight><highlight class="normal">:<sp /></highlight><highlight class="stringliteral">"pending"</highlight><highlight class="normal" /></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp />]</highlight></codeline> <codeline><highlight class="normal"><sp />}</highlight></codeline> </programlisting> The <computeroutput>id</computeroutput> is an internal identifier, <computeroutput>from</computeroutput> is the username of the ODS account that sent the invitation, <computeroutput>to</computeroutput> is the email address the invitation was sent to, <computeroutput>date</computeroutput> is the date of the creation of the invitation as a GMT date string. The <computeroutput>status</computeroutput> is the status of the invitation which can be either <computeroutput>pending</computeroutput> or <computeroutput>rejected</computeroutput>.</p><p><simplesect kind="see"><p><ref kindref="member" refid="group__ods__module__user_1ga3937eecbf3d82e29667c487f4c404e3f">user.invitation.new()</ref>, <ref kindref="member" refid="group__ods__module__user_1gaf0abb9656d7a4b1ccd34a5eecdb68e00">user.invitation.approve()</ref></p></simplesect> <simplesect kind="par"><title>Authentication</title><p>This function requries authentication via one of the supported authentication methods as described in <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref>. </p></simplesect> </p>

schema:url

n6:list