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

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

Subject Item

n2:new

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n4:isWebServiceOf

n7:this_ODSUserModuleAPI

n4:endPointURL

n6:new

schema:shortDescription

<p>Invite someone to join the user's social network. </p>

n4:hasParameter

n5:_friends_email n5:_custom_message

schema:name

EntryPoint - user_invitation_new

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><parameterlist kind="param"><li> <parameternamelist> <parametername>friends_email</parametername> </parameternamelist> <parameterdescription> <p>The email address the invitation should be sent to. This can either be an already registered user or someone that is also invited to create an account with the instance of ODS. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>custom_message</parametername> </parameternamelist> <parameterdescription> <p>An optional custom message to be sent as part of the autogenerated one. The auto-generated message is based on a template stored in the DAV file system at <computeroutput>"/DAV/VAD/wa/tmpl/SN_INV_TEMPLATE"</computeroutput> or in the web server's file structure at <computeroutput>"wa/tmpl/SN_INV_TEMPLATE"</computeroutput>. The default template can be seen below. <pre> %invitation% I've created my own place on %app% and I'd like you to connect to me so we can stay in touch. You can view my blog, my photos, my news and wiki. With %app%, you can create your own personal page and blog of your own, which will can be linked to mine. To join my network please visit %url% - %user% -------------------------------------------------------------------------- Thank you for using Virtuoso Web Applications. Virtuoso Team -- Powered by Virtuoso http://virtuoso.openlinksw.com/ </pre> It can easily be replaced by the system administrator. The following placeholders are supported:<itemizedlist> <listitem><p><computeroutput>app%</computeroutput> - The title of the web service or the server's hostname as a fallback.</p></listitem><listitem><p><computeroutput>user%</computeroutput> - The full name of the user sending the invitation.</p></listitem><listitem><p><computeroutput>url%</computeroutput> - The URL to the login page of this ODS instance. FIXME: This depends on the used UI. It should be provided by the client or be configurable.</p></listitem><listitem><p><computeroutput>invitation%</computeroutput> - The <computeroutput>custom_message</computeroutput> provided as a parameter. </p></listitem></itemizedlist> </p></parameterdescription> </li> </ul> <simplesect kind="return"><p>An error code stating the success of the command execution as detailed in <ref kindref="member" refid="ods_response_format_1ods_response_format_result_code">ODS Error Result Codes</ref>.</p></simplesect> <simplesect kind="see"><p><ref kindref="member" refid="group__ods__module__user_1gaf0abb9656d7a4b1ccd34a5eecdb68e00">user.invitation.approve()</ref>, <ref kindref="member" refid="group__ods__module__user_1ga33086cfe66b0e314e5b8a3e83ae33437">user.invitation.list()</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:new