CINXE.COM

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">  <html> <head><base href="http://vos.openlinksw.com:8895/ods/" /> <link rel="search" type="application/opensearchdescription+xml" title="ODS OpenSearch Description" href="/ods/search.vspx?o=opensearch" /><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/common.css" /> <title>ODS Sign In</title> </head> <body><script type="text/javascript" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:vm="http://www.openlinksw.com/vspx/ods/" xmlns:vdeps="http://www.openlinksw.com/vspx/deps/" xmlns:ev="http://www.w3.org/2001/xml-events"> function doPost (frm_name, name) { var frm = document.forms[frm_name]; frm.__submit_func.value = '__submit__'; frm.__submit_func.name = name; frm.submit (); } function doPostValue (frm_name, name, value) { var frm = document.forms[frm_name]; frm.__submit_func.value = value; frm.__submit_func.name = name; frm.submit (); } </script><noscript xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:vm="http://www.openlinksw.com/vspx/ods/" xmlns:vdeps="http://www.openlinksw.com/vspx/deps/" xmlns:ev="http://www.w3.org/2001/xml-events"> Your browser either does not support JavaScript or it is disabled in your browser's settings. Please consult your browser's documentation for information about enabling this feature. </noscript><script type="text/turtle" id="API_acl"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSAclModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_Acl" ; schema:description "ACL Rule and Group Management" ; schema:mainEntity <#this_ODSAclModuleAPI> ; schema:about <#this_ODSAclModuleAPI> . <#this_ODSAclModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:name "ODS_Acl" ; schema:description "ACL Rule and Group Management" ; schema:potentialAction <#action_fb9836bb3458182d498990d67f4ee26c> , <#action_d1308d00c163f38b295f33105b166d76> , <#action_7b76c693cae8cf5c63f4e5e147ac5ff6> , <#action_89fd9e4ce83492490eeb40608972a602> , <#action_2840e9fbedcfb0458478b5fd21ec8c21> , <#action_14d05cf0002c11a9ba1eeffc9f2de4f6> , <#action_c61410f85466af376baa1fd5d7201316> , <#action_eeffad74df995635e1b1e7b8097cb1c4> , <#action_b1844fa8dc1ab8360a2117e0c8b0bd8e> . <#action_fb9836bb3458182d498990d67f4ee26c> a schema:Action ; schema:name "acl_groups_delete" ; schema:target <#action_acl.groups.delete> . <#action_acl.groups.delete> a schema:EntryPoint ; schema:name "EntryPoint - acl_groups_delete" ; schema:url <https://vos.openlinksw.com/ods/api/acl.groups.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.groups.delete> ; schema:description "Allows to remove a group created by the authenticated user by either specifying the name or the id of the group.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the group to remove. This can be specified several times to delete more than one group. </parameterdescription> </li> <li> <parameternamelist> <parametername>id</parametername> </parameternamelist> <parameterdescription> The numerical identifer or the URI of the group to delete. This can be specified several times to delete more than one group. The group IDs and URIs are part of the output of <ref kindref=\"member\" refid=\"group__ods__module__acl_1ga89fd9e4ce83492490eeb40608972a602\">acl.groups.list()</ref>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">On error an appropriate HTTP error code will be set in addition to a return value as described in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Remove a group. " ; oplwebsrv:hasParameter <#action_acl.groups.delete_#_name> , <#action_acl.groups.delete_#_id> . <#action_acl.groups.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The name of the group to remove. This can be specified several times to delete more than one group. " . <#action_acl.groups.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The numerical identifer or the URI of the group to delete. This can be specified several times to delete more than one group. The group IDs and URIs are part of the output of <ref kindref=\"member\" refid=\"group__ods__module__acl_1ga89fd9e4ce83492490eeb40608972a602\">acl.groups.list()</ref>." . <#action_d1308d00c163f38b295f33105b166d76> a schema:Action ; schema:name "acl_groups_get" ; schema:target <#action_acl.groups.get> . <#action_acl.groups.get> a schema:EntryPoint ; schema:name "EntryPoint - acl_groups_get" ; schema:url <https://vos.openlinksw.com/ods/api/acl.groups.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.groups.get> ; schema:description "Be aware that ODS exposes data as linked data which allows to query the groups via SPARQL as described in <ref kindref=\"member\" refid=\"group__ods__module__acl_1ods_acl_rule_query\">Querying ACL Rules</ref>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the group to get. </parameterdescription> </li> <li> <parameternamelist> <parametername>id</parametername> </parameternamelist> <parameterdescription> The numerical identifer or the URI of the group to delete. </parameterdescription> </li> <li> <parameternamelist> <parametername>accept</parametername> </parameternamelist> <parameterdescription> The mime type of the accepted output. The group IDs and URIs are part of the output of <ref kindref=\"member\" refid=\"group__ods__module__acl_1ga89fd9e4ce83492490eeb40608972a602\">acl.groups.list()</ref>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The details of the group as a JSON stream. See <ref kindref=\"member\" refid=\"group__ods__module__acl_1ga89fd9e4ce83492490eeb40608972a602\">acl.groups.list()</ref> for an example. If no group by that name exists an HTTP status code of 400 is set.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Get details of a specific group. " ; oplwebsrv:hasParameter <#action_acl.groups.get_#_name> , <#action_acl.groups.get_#_id> , <#action_acl.groups.get_#_accept> . <#action_acl.groups.get_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The name of the group to get. " . <#action_acl.groups.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The numerical identifer or the URI of the group to delete. " . <#action_acl.groups.get_#_accept> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "accept" ; schema:name "accept" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; oplwebsrv:parameterExampleValue "application/json" ; schema:description "The mime type of the accepted output. The group IDs and URIs are part of the output of <ref kindref=\"member\" refid=\"group__ods__module__acl_1ga89fd9e4ce83492490eeb40608972a602\">acl.groups.list()</ref>." . <#action_7b76c693cae8cf5c63f4e5e147ac5ff6> a schema:Action ; schema:name "acl_groups_import" ; schema:target <#action_acl.groups.import> . <#action_acl.groups.import> a schema:EntryPoint ; schema:name "EntryPoint - acl_groups_import" ; schema:url <https://vos.openlinksw.com/ods/api/acl.groups.import> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.groups.import> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>content</parametername> </parameternamelist> <parameterdescription> TTL string containing representation of the group</parameterdescription> </li> </ul> <pre> @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> @prefix : <#> . <> foaf:topic :Group . <> rdfs:label \"Social Semantics & ACLs Demo\" . <> rdfs:comment \"Members of this group provide the basis for a Resource Access Policy scoped to this group.\". :Group a foaf:Group . :Group foaf:member <http://id.myopenlink.net/dataspace/person/user1#this> , <http://id.myopenlink.net/dataspace/person/user2#this> , <http://id.myopenlink.net/dataspace/person/user3#this> . </pre><simplesect kind=\"return\">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>. In case of an error the HTTP status code is set accordingly. </simplesect> " ; schema:shortDescription "Import an ACL group. " ; oplwebsrv:hasParameter <#action_acl.groups.import_#_content> . <#action_acl.groups.import_#_content> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "content" ; schema:name "content" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "TTL string containing representation of the group" . <#action_89fd9e4ce83492490eeb40608972a602> a schema:Action ; schema:name "acl_groups_list" ; schema:target <#action_acl.groups.list> . <#action_acl.groups.list> a schema:EntryPoint ; schema:name "EntryPoint - acl_groups_list" ; schema:url <https://vos.openlinksw.com/ods/api/acl.groups.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.groups.list> ; schema:description "This function allows to list all groups defined by the authenticated user. Be aware that ODS exposes data as linked data which allows to query the groups via SPARQL as described in <ref kindref=\"member\" refid=\"group__ods__module__acl_1ods_acl_rule_query\">Querying ACL Rules</ref>.<simplesect kind=\"return\">A list of the groups defined by the authenticated user as a JSON string.</simplesect> <bold>Example:</bold> <programlisting><codeline><highlight class=\"normal\"><sp />[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><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 /></highlight><highlight class=\"stringliteral\">\"uri\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"http://web.ods.openlinksw.com/dataspace/trueg/group/Test%20Group%201\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"Test<sp />group<sp />1\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"description\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"The<sp />first<sp />of<sp />the<sp />groups\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"members\"</highlight><highlight class=\"normal\">:<sp />[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"http://web.ods.openlinksw.com/dataspace/person/egon#this\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"http://web.ods.openlinksw.com/dataspace/person/hans#this\"</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></codeline> <codeline><highlight class=\"normal\"><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 /></highlight><highlight class=\"stringliteral\">\"uri\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"http://web.ods.openlinksw.com/dataspace/trueg/group/Test%20Group%202\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"Test<sp />group<sp />2\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"description\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"The<sp />second<sp />of<sp />the<sp />groups\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"members\"</highlight><highlight class=\"normal\">:[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"http://id.myopenlinksw.com/dataspace/person/egon#this\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"http://www.facebook.com/some.user\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"acct.persona:trueg@openlinksw.com\"</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><simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "List groups defined by the authenticated user. " . <#action_2840e9fbedcfb0458478b5fd21ec8c21> a schema:Action ; schema:name "acl_groups_new" ; schema:target <#action_acl.groups.new> . <#action_acl.groups.new> a schema:EntryPoint ; schema:name "EntryPoint - acl_groups_new" ; schema:url <https://vos.openlinksw.com/ods/api/acl.groups.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.groups.new> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the group. This is unique to the ODS user. Different ODS users may create groups with the same name. </parameterdescription> </li> <li> <parameternamelist> <parametername>description</parametername> </parameternamelist> <parameterdescription> An optional description of the group. </parameterdescription> </li> <li> <parameternamelist> <parametername>member</parametername> </parameternamelist> <parameterdescription> An optional list of members to fill a group. This parameter can be specified several times to add more than one member. New members can also be added via <ref kindref=\"member\" refid=\"group__ods__module__acl_1ga14d05cf0002c11a9ba1eeffc9f2de4f6\">acl.groups.update()</ref>. Members are identifier by their URIs. These can be WebIDs or any of the supported identifiers as listed in <ref kindref=\"member\" refid=\"group__ods__module__user_1gada9926a1513e45b817e6f15ec9faf882\">user.onlineAccounts.new()</ref>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>. In case of an error the HTTP status code is set accordingly.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Create a new group of agents (people, software, machines). " ; oplwebsrv:hasParameter <#action_acl.groups.new_#_name> , <#action_acl.groups.new_#_description> , <#action_acl.groups.new_#_member> . <#action_acl.groups.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The name of the group. This is unique to the ODS user. Different ODS users may create groups with the same name. " . <#action_acl.groups.new_#_description> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "description" ; schema:name "description" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "An optional description of the group. " . <#action_acl.groups.new_#_member> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "member" ; schema:name "member" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "An optional list of members to fill a group. This parameter can be specified several times to add more than one member. New members can also be added via <ref kindref=\"member\" refid=\"group__ods__module__acl_1ga14d05cf0002c11a9ba1eeffc9f2de4f6\">acl.groups.update()</ref>. Members are identifier by their URIs. These can be WebIDs or any of the supported identifiers as listed in <ref kindref=\"member\" refid=\"group__ods__module__user_1gada9926a1513e45b817e6f15ec9faf882\">user.onlineAccounts.new()</ref>." . <#action_14d05cf0002c11a9ba1eeffc9f2de4f6> a schema:Action ; schema:name "acl_groups_update" ; schema:target <#action_acl.groups.update> . <#action_acl.groups.update> a schema:EntryPoint ; schema:name "EntryPoint - acl_groups_update" ; schema:url <https://vos.openlinksw.com/ods/api/acl.groups.update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.groups.update> ; schema:description "This function allows to change the details of any group identified by either the name or the id. The group has to be created via acl.group.new() before.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name or the IRI of the group to change. </parameterdescription> </li> <li> <parameternamelist> <parametername>id</parametername> </parameternamelist> <parameterdescription> The identifier of the group to change. </parameterdescription> </li> <li> <parameternamelist> <parametername>newName</parametername> </parameternamelist> <parameterdescription> The optional new name of the group. This name cannot be used by another group already. </parameterdescription> </li> <li> <parameternamelist> <parametername>newDescription</parametername> </parameternamelist> <parameterdescription> The optional new description of the group. </parameterdescription> </li> <li> <parameternamelist> <parametername>addMember</parametername> </parameternamelist> <parameterdescription> An optional parameter which indicates the new members to add to the group. This parameter can be specified several times to add more than one member. </parameterdescription> </li> <li> <parameternamelist> <parametername>removeMember</parametername> </parameternamelist> <parameterdescription> An optional parameter which indicates the members to remove from the group. This parameter can be specified several times to remove more than one member. If <computeroutput>overwrite</computeroutput> is <computeroutput>1</computeroutput> <computeroutput>removeMember</computeroutput> is ignored. </parameterdescription> </li> <li> <parameternamelist> <parametername>overwrite</parametername> </parameternamelist> <parameterdescription> If <computeroutput>1</computeroutput> the existing members of the given group are replaced by the ones specified in <computeroutput>addMember</computeroutput>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">On error an appropriate HTTP error code will be set in addition to a return value as described in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Change the attributes of a group. " ; oplwebsrv:hasParameter <#action_acl.groups.update_#_name> , <#action_acl.groups.update_#_id> , <#action_acl.groups.update_#_newName> , <#action_acl.groups.update_#_newDescription> , <#action_acl.groups.update_#_addMember> , <#action_acl.groups.update_#_removeMember> , <#action_acl.groups.update_#_overwrite> . <#action_acl.groups.update_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The name or the IRI of the group to change. " . <#action_acl.groups.update_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The identifier of the group to change. " . <#action_acl.groups.update_#_newName> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "newName" ; schema:name "newName" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The optional new name of the group. This name cannot be used by another group already. " . <#action_acl.groups.update_#_newDescription> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "newDescription" ; schema:name "newDescription" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The optional new description of the group. " . <#action_acl.groups.update_#_addMember> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "addMember" ; schema:name "addMember" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "An optional parameter which indicates the new members to add to the group. This parameter can be specified several times to add more than one member. " . <#action_acl.groups.update_#_removeMember> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "removeMember" ; schema:name "removeMember" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "An optional parameter which indicates the members to remove from the group. This parameter can be specified several times to remove more than one member. If <computeroutput>overwrite</computeroutput> is <computeroutput>1</computeroutput> <computeroutput>removeMember</computeroutput> is ignored. " . <#action_acl.groups.update_#_overwrite> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "overwrite" ; schema:name "overwrite" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "If <computeroutput>1</computeroutput> the existing members of the given group are replaced by the ones specified in <computeroutput>addMember</computeroutput>." . <#action_c61410f85466af376baa1fd5d7201316> a schema:Action ; schema:name "acl_rules_delete" ; schema:target <#action_acl.rules.delete> . <#action_acl.rules.delete> a schema:EntryPoint ; schema:name "EntryPoint - acl_rules_delete" ; schema:url <https://vos.openlinksw.com/ods/api/acl.rules.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.rules.delete> ; schema:description "This function allows to remove ACL rules which have previously been created via <ref kindref=\"member\" refid=\"group__ods__module__acl_1gab1844fa8dc1ab8360a2117e0c8b0bd8e\">acl.rules.new()</ref>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>resource</parametername> </parameternamelist> <parameterdescription> The resource whose list of rules should be modified. If omitted the user profile's list of rules is used. </parameterdescription> </li> <li> <parameternamelist> <parametername>rule</parametername> </parameternamelist> <parameterdescription> The numerical identifer or the URI of the rule to delete. This can be specified several times to delete more than one rule. The rule IDs and URIs are part of the output of <ref kindref=\"member\" refid=\"group__ods__module__acl_1gaeeffad74df995635e1b1e7b8097cb1c4\">acl.rules.list()</ref>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>. In case of an error the HTTP status code is set accordingly.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Remove an ACL rule. " ; oplwebsrv:hasParameter <#action_acl.rules.delete_#_resource> , <#action_acl.rules.delete_#_rule> . <#action_acl.rules.delete_#_resource> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "resource" ; schema:name "resource" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The resource whose list of rules should be modified. If omitted the user profile's list of rules is used. " . <#action_acl.rules.delete_#_rule> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rule" ; schema:name "rule" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The numerical identifer or the URI of the rule to delete. This can be specified several times to delete more than one rule. The rule IDs and URIs are part of the output of <ref kindref=\"member\" refid=\"group__ods__module__acl_1gaeeffad74df995635e1b1e7b8097cb1c4\">acl.rules.list()</ref>." . <#action_eeffad74df995635e1b1e7b8097cb1c4> a schema:Action ; schema:name "acl_rules_list" ; schema:target <#action_acl.rules.list> . <#action_acl.rules.list> a schema:EntryPoint ; schema:name "EntryPoint - acl_rules_list" ; schema:url <https://vos.openlinksw.com/ods/api/acl.rules.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.rules.list> ; schema:description "Be aware that ODS exposes data as linked data which allows to query the rules via SPARQL as described in <ref kindref=\"member\" refid=\"group__ods__module__acl_1ods_acl_rule_query\">Querying ACL Rules</ref>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>resource</parametername> </parameternamelist> <parameterdescription> The resource to list the ACL rules for. If omitted the user's profile's rules are listed.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A JSon stream of ACL rules as decribed in <ref kindref=\"member\" refid=\"group__ods__module__acl_1ods_acl_rule_example\">ODS ACL Rules</ref> with additional properties <computeroutput>id</computeroutput> and <computeroutput>uri</computeroutput> to allow rule-identification for deletion and <computeroutput>resource</computeroutput> properties which identify the given resource for convinience. If the <computeroutput>resource</computeroutput> URL is not supported an HTTP status code of 400 is set.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "List all ACL rules for a specific resource. " ; oplwebsrv:hasParameter <#action_acl.rules.list_#_resource> . <#action_acl.rules.list_#_resource> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "resource" ; schema:name "resource" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The resource to list the ACL rules for. If omitted the user's profile's rules are listed." . <#action_b1844fa8dc1ab8360a2117e0c8b0bd8e> a schema:Action ; schema:name "acl_rules_new" ; schema:target <#action_acl.rules.new> . <#action_acl.rules.new> a schema:EntryPoint ; schema:name "EntryPoint - acl_rules_new" ; schema:url <https://vos.openlinksw.com/ods/api/acl.rules.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAclModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/acl.rules.new> ; schema:description "Data access in ODS is controlled via Access Control Lists (ACL). In practice this comes down to a set of rules giving or revoking access to certain people or groups. Each rule grants access to or revokes access from a certain resource or type of resource.ODS allows to define rules on the user profile (by specifying the user's profile URL) or any DAV resource the user has access to. In case of the user profile those parts of the profile which are set to be protected are shared. See also <ref kindref=\"member\" refid=\"group__ods__module__user_1gaa5b7bc990093ae641d2a777cbe386766\">user.acl.update()</ref>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>resource</parametername> </parameternamelist> <parameterdescription> The resource to grant access to. If omitted the rule will be created for the user's profile. </parameterdescription> </li> <li> <parameternamelist> <parametername>rule</parametername> </parameternamelist> <parameterdescription> The ACL rule specified as a JSON string. See <ref kindref=\"member\" refid=\"group__ods__module__acl_1ods_acl_rule_example\">ODS ACL Rules</ref> for details.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>. In case of an error the HTTP status code is set accordingly.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Create a new ACL rule. " ; oplwebsrv:hasParameter <#action_acl.rules.new_#_resource> , <#action_acl.rules.new_#_rule> . <#action_acl.rules.new_#_resource> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "resource" ; schema:name "resource" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The resource to grant access to. If omitted the rule will be created for the user's profile. " . <#action_acl.rules.new_#_rule> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rule" ; schema:name "rule" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAclModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAclModuleAPIDoc> ; schema:description "The ACL rule specified as a JSON string. See <ref kindref=\"member\" refid=\"group__ods__module__acl_1ods_acl_rule_example\">ODS ACL Rules</ref> for details." . </script><script type="text/turtle" id="API_admin"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSAdminModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_Admin" ; schema:description "ODS Administration API" ; schema:mainEntity <#this_ODSAdminModuleAPI> ; schema:about <#this_ODSAdminModuleAPI> . <#this_ODSAdminModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:name "ODS_Admin" ; schema:description "ODS Administration API" ; schema:potentialAction <#action_9bce030d8f0b0490c6bef55e83beb3a7> , <#action_e768a84636feffbb899a87066d67f975> , <#action_92ef7d74e1103210380902488e90e2a7> , <#action_fba8d979cba6f71bc8c1f21a8d5358e7> , <#action_adfb99d5d0dc78888f8fd6aa4ce8457e> , <#action_675af873f023acb812a8d7694a1d3b9f> , <#action_365701a6c7a95c72a9ec3dbfb3ae6c48> , <#action_ac81c7d6244af55f77a46888803d002d> , <#action_dd8898e6ee5bf737acd77741115e9d61> , <#action_0b8cb955791c1e70bcc77cb215fd9103> , <#action_7e333f962d99ee605f5be4bf6a9e2e21> , <#action_fb92fea83f401240d25d502c48d8acab> , <#action_bdb4fd99e2da15f8074247c01e4c0b83> , <#action_432296b4e4363f83bda3e7d688fe4e6e> , <#action_8aa41babfc48c8e4604cbd7cdc847a5b> , <#action_dbd2a1ea39f431786c4ac85b8184c5e3> , <#action_aed3d74d9f7718d3d68771d112e0ef9f> , <#action_e8c25b1a604fcf5ddfb842446dbb47b8> . <#action_9bce030d8f0b0490c6bef55e83beb3a7> a schema:Action ; schema:name "admin_apikeys_delete" ; schema:target <#action_admin.apikeys.delete> . <#action_admin.apikeys.delete> a schema:EntryPoint ; schema:name "EntryPoint - admin_apikeys_delete" ; schema:url <https://vos.openlinksw.com/ods/api/admin.apikeys.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.apikeys.delete> ; schema:description "ODS (and Virtuoso) supports many 3rd-party services via OAuth. In order to use these features the ODS instance needs to be registered with the service and the client key and secret needs to be added to the ODS instance through <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>.See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref> for details on how to create the client key and secret for the different supported services.This function allows to remove previously installed client key/secret pairs.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the service whose key/secret pair should be removed.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>0</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1gae768a84636feffbb899a87066d67f975\">admin.apikeys.list()</ref> </simplesect> " ; schema:shortDescription "Delete a 3rd-party service client key and secret for OAuth authentication. " ; oplwebsrv:hasParameter <#action_admin.apikeys.delete_#_name> . <#action_admin.apikeys.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the service whose key/secret pair should be removed." . <#action_e768a84636feffbb899a87066d67f975> a schema:Action ; schema:name "admin_apikeys_list" ; schema:target <#action_admin.apikeys.list> . <#action_admin.apikeys.list> a schema:EntryPoint ; schema:name "EntryPoint - admin_apikeys_list" ; schema:url <https://vos.openlinksw.com/ods/api/admin.apikeys.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.apikeys.list> ; schema:description "ODS (and Virtuoso) supports many 3rd-party services via OAuth. In order to use these features the ODS instance needs to be registered with the service and the client key and secret needs to be added to the ODS instance through <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>.See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref> for details on how to create the client key and secret for the different supported services.This method simply lists all installed service key/secret pairs.<simplesect kind=\"return\">A JSON stream as follows: <programlisting><codeline><highlight class=\"normal\"><sp />[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"facebook\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"key\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"434328308925961\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"secret\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"d35da06d83a9dd0e5582eeb734c0fd6f\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />},</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"flickr\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"key\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"cf6a4dfef5f3662a8014578ab23c0659\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"secret\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"fb35324064ab41cb\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"comment\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"Flickr<sp />apikey<sp />named<sp />mykey<sp />created<sp />with<sp />flickr<sp />account<sp />foobar.\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp />]</highlight></codeline> </programlisting></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga9bce030d8f0b0490c6bef55e83beb3a7\">admin.apikeys.delete()</ref> </simplesect> " ; schema:shortDescription "List installed 3rd-party service client key and secrets for OAuth authentication. " . <#action_92ef7d74e1103210380902488e90e2a7> a schema:Action ; schema:name "admin_apikeys_new" ; schema:target <#action_admin.apikeys.new> . <#action_admin.apikeys.new> a schema:EntryPoint ; schema:name "EntryPoint - admin_apikeys_new" ; schema:url <https://vos.openlinksw.com/ods/api/admin.apikeys.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.apikeys.new> ; schema:description "ODS (and Virtuoso) supports many 3rd-party services via OAuth. In order to use these features the ODS instance needs to be registered with the service and the client key and secret needs to be added to the ODS instance through this function.See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref> for details on how to create the client key and secret for the different supported services.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the service. See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref> for a list of the supported services. </parameterdescription> </li> <li> <parameternamelist> <parametername>clientkey</parametername> </parameternamelist> <parameterdescription> The client key, sometimes also called consumer key. </parameterdescription> </li> <li> <parameternamelist> <parametername>clientsecret</parametername> </parameternamelist> <parameterdescription> The client secret, sometimes also called consumer secret. </parameterdescription> </li> <li> <parameternamelist> <parametername>comment</parametername> </parameternamelist> <parameterdescription> An optional comment which can be used to store any additional information of interest to the administrator. </parameterdescription> </li> <li> <parameternamelist> <parametername>options</parametername> </parameternamelist> <parameterdescription> An optional string of comma-separated options. This allows api keys to carry configuration. Supported configuration for now: <computeroutput>sandbox</computeroutput> to add a PayPal sandbox api key.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>0</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1ga9bce030d8f0b0490c6bef55e83beb3a7\">admin.apikeys.delete()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1gae768a84636feffbb899a87066d67f975\">admin.apikeys.list()</ref> </simplesect> " ; schema:shortDescription "Add a 3rd-party service client key and secret for OAuth authentication. " ; oplwebsrv:hasParameter <#action_admin.apikeys.new_#_name> , <#action_admin.apikeys.new_#_clientkey> , <#action_admin.apikeys.new_#_clientsecret> , <#action_admin.apikeys.new_#_comment> , <#action_admin.apikeys.new_#_options> . <#action_admin.apikeys.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the service. See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref> for a list of the supported services. " . <#action_admin.apikeys.new_#_clientkey> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "clientkey" ; schema:name "clientkey" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The client key, sometimes also called consumer key. " . <#action_admin.apikeys.new_#_clientsecret> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "clientsecret" ; schema:name "clientsecret" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The client secret, sometimes also called consumer secret. " . <#action_admin.apikeys.new_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "An optional comment which can be used to store any additional information of interest to the administrator. " . <#action_admin.apikeys.new_#_options> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "options" ; schema:name "options" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "An optional string of comma-separated options. This allows api keys to carry configuration. Supported configuration for now: <computeroutput>sandbox</computeroutput> to add a PayPal sandbox api key." . <#action_fba8d979cba6f71bc8c1f21a8d5358e7> a schema:Action ; schema:name "admin_clients_delete" ; schema:target <#action_admin.clients.delete> . <#action_admin.clients.delete> a schema:EntryPoint ; schema:name "EntryPoint - admin_clients_delete" ; schema:url <https://vos.openlinksw.com/ods/api/admin.clients.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.clients.delete> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name or URL of the client to delete.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>0</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1ga675af873f023acb812a8d7694a1d3b9f\">admin.clients.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1gaadfb99d5d0dc78888f8fd6aa4ce8457e\">admin.clients.list()</ref>; </simplesect> " ; schema:shortDescription "Delete a registered client application. " ; oplwebsrv:hasParameter <#action_admin.clients.delete_#_name> . <#action_admin.clients.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name or URL of the client to delete." . <#action_adfb99d5d0dc78888f8fd6aa4ce8457e> a schema:Action ; schema:name "admin_clients_list" ; schema:target <#action_admin.clients.list> . <#action_admin.clients.list> a schema:EntryPoint ; schema:name "EntryPoint - admin_clients_list" ; schema:url <https://vos.openlinksw.com/ods/api/admin.clients.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.clients.list> ; schema:description "Certain operations in ODS require special security mesures. This includes authentication through third-party services for which the callback URL needs to be trusted. To this end administrator can register client URLs.The ODS session will also allow JavaScript cross-origin-requests only from registered client URLs.<simplesect kind=\"return\">A JSON stream as follows: <programlisting><codeline><highlight class=\"normal\"><sp />[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"my<sp />client\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"url\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"http://my.client.com:8890\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />},</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"my<sp />ssl<sp />client\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"url\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"https://my.client.com\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp />]</highlight></codeline> </programlisting></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1gafba8d979cba6f71bc8c1f21a8d5358e7\">admin.clients.delete()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga675af873f023acb812a8d7694a1d3b9f\">admin.clients.new()</ref>; </simplesect> " ; schema:shortDescription "List registered client URLs. " . <#action_675af873f023acb812a8d7694a1d3b9f> a schema:Action ; schema:name "admin_clients_new" ; schema:target <#action_admin.clients.new> . <#action_admin.clients.new> a schema:EntryPoint ; schema:name "EntryPoint - admin_clients_new" ; schema:url <https://vos.openlinksw.com/ods/api/admin.clients.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.clients.new> ; schema:description "Certain operations in ODS require special security mesures. This includes authentication through third-party services for which the callback URL needs to be trusted. To this end administrator can register client URLs via this function.The ODS session will also allow JavaScript cross-origin-requests only from registered client URLs.Be aware that the ODS host itself is treated as a client by default and does not have to be added via this API.This administration function requires administrator privileges.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> A descriptive name for the client. </parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> The URL of the client which will access the ODS instance. The base URL is sufficient.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>0</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1gafba8d979cba6f71bc8c1f21a8d5358e7\">admin.clients.delete()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1gaadfb99d5d0dc78888f8fd6aa4ce8457e\">admin.clients.list()</ref>; </simplesect> " ; schema:shortDescription "Register a new client application with an ODS instance. " ; oplwebsrv:hasParameter <#action_admin.clients.new_#_name> , <#action_admin.clients.new_#_url> . <#action_admin.clients.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "A descriptive name for the client. " . <#action_admin.clients.new_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The URL of the client which will access the ODS instance. The base URL is sufficient." . <#action_365701a6c7a95c72a9ec3dbfb3ae6c48> a schema:Action ; schema:name "admin_config_clear" ; schema:target <#action_admin.config.clear> . <#action_admin.config.clear> a schema:EntryPoint ; schema:name "EntryPoint - admin_config_clear" ; schema:url <https://vos.openlinksw.com/ods/api/admin.config.clear> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.config.clear> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the configuration option. This can be specified several times to remove more than one option value. </parameterdescription> </li> <li> <parameternamelist> <parametername>username</parametername> </parameternamelist> <parameterdescription> The user name for whom the config value should be set or <computeroutput>null</computeroutput> for system-wide configuration settings.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>1</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Clear one or more configuration options. " ; oplwebsrv:hasParameter <#action_admin.config.clear_#_name> , <#action_admin.config.clear_#_username> . <#action_admin.config.clear_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the configuration option. This can be specified several times to remove more than one option value. " . <#action_admin.config.clear_#_username> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "username" ; schema:name "username" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The user name for whom the config value should be set or <computeroutput>null</computeroutput> for system-wide configuration settings." . <#action_ac81c7d6244af55f77a46888803d002d> a schema:Action ; schema:name "admin_config_list" ; schema:target <#action_admin.config.list> . <#action_admin.config.list> a schema:EntryPoint ; schema:name "EntryPoint - admin_config_list" ; schema:url <https://vos.openlinksw.com/ods/api/admin.config.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.config.list> ; schema:description "This method lists the configuration for the given <computeroutput>username</computeroutput> or the system config. This includes the actual configuration values and a list of configuration options including labels, descriptions, default values, and options restrictions to the possible values.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>username</parametername> </parameternamelist> <parameterdescription> The user name for whom the config value should be set or <computeroutput>null</computeroutput> for system-wide configuration settings.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A JSon document listing the configuration options and their values. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <bold>Example:</bold> <programlisting><codeline><highlight class=\"normal\"><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"config\"</highlight><highlight class=\"normal\">:<sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"values\"</highlight><highlight class=\"normal\">:<sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"sparql_user_access\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"update\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"foor\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"bar\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"options\"</highlight><highlight class=\"normal\">:<sp />[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"user_sparql_access\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"label\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"User<sp />SPARQL<sp />Access\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"description\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"States<sp />which<sp />type<sp />of<sp />access<sp />to<sp />the<sp />SPARQL<sp />engine<sp />the<sp />ODS<sp />users<sp />should<sp />have.<sp />Possible<sp />values<sp />are<sp />\\"none\\",<sp />\\"select\\",<sp />\\"update\\",<sp />or<sp />\\"sponge\\".\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"multiValue\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"false\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"default\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"none\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"restriction\"</highlight><highlight class=\"normal\">:<sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"type\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"choices\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"choices\"</highlight><highlight class=\"normal\">:[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"none\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"select\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"update\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"sponge\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />]</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp />}</highlight></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><simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "List available configuration options and their values. " ; oplwebsrv:hasParameter <#action_admin.config.list_#_username> . <#action_admin.config.list_#_username> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "username" ; schema:name "username" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The user name for whom the config value should be set or <computeroutput>null</computeroutput> for system-wide configuration settings." . <#action_dd8898e6ee5bf737acd77741115e9d61> a schema:Action ; schema:name "admin_config_set" ; schema:target <#action_admin.config.set> . <#action_admin.config.set> a schema:EntryPoint ; schema:name "EntryPoint - admin_config_set" ; schema:url <https://vos.openlinksw.com/ods/api/admin.config.set> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.config.set> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the configuration option. </parameterdescription> </li> <li> <parameternamelist> <parametername>value</parametername> </parameternamelist> <parameterdescription> The requested value. This parameter can be specified multiple times in order to create a list. </parameterdescription> </li> <li> <parameternamelist> <parametername>username</parametername> </parameternamelist> <parameterdescription> The user name for whom the config value should be set or <computeroutput>null</computeroutput> for system-wide configuration settings.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>1</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Set a configuration option. " ; oplwebsrv:hasParameter <#action_admin.config.set_#_name> , <#action_admin.config.set_#_value> , <#action_admin.config.set_#_username> . <#action_admin.config.set_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the configuration option. " . <#action_admin.config.set_#_value> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "value" ; schema:name "value" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The requested value. This parameter can be specified multiple times in order to create a list. " . <#action_admin.config.set_#_username> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "username" ; schema:name "username" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The user name for whom the config value should be set or <computeroutput>null</computeroutput> for system-wide configuration settings." . <#action_0b8cb955791c1e70bcc77cb215fd9103> a schema:Action ; schema:name "admin_oauth_odshosts_delete" ; schema:target <#action_admin.oauth.odshosts.delete> . <#action_admin.oauth.odshosts.delete> a schema:EntryPoint ; schema:name "EntryPoint - admin_oauth_odshosts_delete" ; schema:url <https://vos.openlinksw.com/ods/api/admin.oauth.odshosts.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.oauth.odshosts.delete> ; schema:description "ODS supports authentication via a variety of OAuth services through <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>. This includes other ODS instances. While other OAuth providers are hard-coded into the ODS API, other ODS instances can be added through <ref kindref=\"member\" refid=\"group__ods__module__admin_1gafb92fea83f401240d25d502c48d8acab\">admin.oauth.odshosts.new()</ref>. OAuth API key and secret are added as for any other service via <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>.This function allows to remove previously added ODS instances.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the ODS instance to remove.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>0</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1gafb92fea83f401240d25d502c48d8acab\">admin.oauth.odshosts.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga7e333f962d99ee605f5be4bf6a9e2e21\">admin.oauth.odshosts.list()</ref> </simplesect> " ; schema:shortDescription "Delete a 3rd-party service client key and secret for OAuth authentication. " ; oplwebsrv:hasParameter <#action_admin.oauth.odshosts.delete_#_name> . <#action_admin.oauth.odshosts.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the ODS instance to remove." . <#action_7e333f962d99ee605f5be4bf6a9e2e21> a schema:Action ; schema:name "admin_oauth_odshosts_list" ; schema:target <#action_admin.oauth.odshosts.list> . <#action_admin.oauth.odshosts.list> a schema:EntryPoint ; schema:name "EntryPoint - admin_oauth_odshosts_list" ; schema:url <https://vos.openlinksw.com/ods/api/admin.oauth.odshosts.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.oauth.odshosts.list> ; schema:description "ODS supports authentication via a variety of OAuth services through <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>. This includes other ODS instances. While other OAuth providers are hard-coded into the ODS API, other ODS instances can be added through <ref kindref=\"member\" refid=\"group__ods__module__admin_1gafb92fea83f401240d25d502c48d8acab\">admin.oauth.odshosts.new()</ref>. OAuth API key and secret are added as for any other service via <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>.This method simply lists all installed ODS OAuth provider instances.<simplesect kind=\"return\">A JSON stream as follows: <programlisting><codeline><highlight class=\"normal\"><sp />[</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"myopenlink\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"host\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"https://id.myopenlink.net\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />},</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"name\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"web.ods\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"host\"</highlight><highlight class=\"normal\">:</highlight><highlight class=\"stringliteral\">\"web.ods.openlinksw.com\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp />]</highlight></codeline> </programlisting></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1gafb92fea83f401240d25d502c48d8acab\">admin.oauth.odshosts.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga0b8cb955791c1e70bcc77cb215fd9103\">admin.oauth.odshosts.delete()</ref> </simplesect> " ; schema:shortDescription "List installed 3rd-party service client key and secrets for OAuth authentication. " . <#action_fb92fea83f401240d25d502c48d8acab> a schema:Action ; schema:name "admin_oauth_odshosts_new" ; schema:target <#action_admin.oauth.odshosts.new> . <#action_admin.oauth.odshosts.new> a schema:EntryPoint ; schema:name "EntryPoint - admin_oauth_odshosts_new" ; schema:url <https://vos.openlinksw.com/ods/api/admin.oauth.odshosts.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.oauth.odshosts.new> ; schema:description "ODS supports authentication via a variety of OAuth services through <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>. This includes other ODS instances. While other OAuth providers are hard-coded into the ODS API, other ODS instances can be added through <ref kindref=\"member\" refid=\"group__ods__module__admin_1gafb92fea83f401240d25d502c48d8acab\">admin.oauth.odshosts.new()</ref>. OAuth API key and secret are added as for any other service via <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>.<bold>Example:</bold> Given authentication with admin privileges OpenLink's public ODS instance at <ulink url=\"http://id.myopenlink.net\">http://id.myopenlink.net</ulink> can be added as follows: <programlisting><codeline><highlight class=\"normal\"><sp />/ods/api/<ref kindref=\"member\" refid=\"group__ods__module__admin_1gafb92fea83f401240d25d502c48d8acab\" tooltip=\"Add an ODS instance as OAuth authentication server.\">admin.oauth.odshosts.new</ref>?name=myopenlink&host=id.myopenlink.net</highlight></codeline> </programlisting>Afterwards an API key/secret pair as created at <ulink url=\"http://id.myopenlink.net/oauth/oauth_apps.vspx\">http://id.myopenlink.net/oauth/oauth_apps.vspx</ulink> can be added: <programlisting><codeline><highlight class=\"normal\"><sp />/ods/api/<ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\" tooltip=\"Add a 3rd-party service client key and secret for OAuth authentication.\">admin.apikeys.new</ref>?name=myopenlink&clientkey=698afkjha6uaf924&clientsecret=678923jbfad723u3r</highlight></codeline> </programlisting>Then <computeroutput>myopenlink</computeroutput> can be used like any other OAuth service in <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the ODS instance. This is how the API will identify the OAuth provider in methods like <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> or <ref kindref=\"member\" refid=\"group__ods__module__misc_1ga694da38279997cafbe2f2012dfe30c47\">server.getInfo()</ref>. ODS will normalize this name by removing whilespace and converting it to lower-case. </parameterdescription> </li> <li> <parameternamelist> <parametername>label</parametername> </parameternamelist> <parameterdescription> An optional human-readable label for the ODS instance. </parameterdescription> </li> <li> <parameternamelist> <parametername>host</parametername> </parameternamelist> <parameterdescription> The host of the ODS instance with an optional protocol. If no protocol is given <computeroutput>http</computeroutput> is assumed.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref>, <computeroutput>0</computeroutput> on success. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__admin_1ga0b8cb955791c1e70bcc77cb215fd9103\">admin.oauth.odshosts.delete()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga7e333f962d99ee605f5be4bf6a9e2e21\">admin.oauth.odshosts.list()</ref> </simplesect> " ; schema:shortDescription "Add an ODS instance as OAuth authentication server. " ; oplwebsrv:hasParameter <#action_admin.oauth.odshosts.new_#_name> , <#action_admin.oauth.odshosts.new_#_label> , <#action_admin.oauth.odshosts.new_#_host> . <#action_admin.oauth.odshosts.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the ODS instance. This is how the API will identify the OAuth provider in methods like <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> or <ref kindref=\"member\" refid=\"group__ods__module__misc_1ga694da38279997cafbe2f2012dfe30c47\">server.getInfo()</ref>. ODS will normalize this name by removing whilespace and converting it to lower-case. " . <#action_admin.oauth.odshosts.new_#_label> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "label" ; schema:name "label" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "An optional human-readable label for the ODS instance. " . <#action_admin.oauth.odshosts.new_#_host> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "host" ; schema:name "host" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The host of the ODS instance with an optional protocol. If no protocol is given <computeroutput>http</computeroutput> is assumed." . <#action_bdb4fd99e2da15f8074247c01e4c0b83> a schema:Action ; schema:name "admin_shop_clearOfferingCache" ; schema:target <#action_admin.shop.clearOfferingCache> . <#action_admin.shop.clearOfferingCache> a schema:EntryPoint ; schema:name "EntryPoint - admin_shop_clearOfferingCache" ; schema:url <https://vos.openlinksw.com/ods/api/admin.shop.clearOfferingCache> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.shop.clearOfferingCache> ; schema:description "ODS Shop uses the Virtuoso Sponger to fetch information about offerings. In the spirit of good linked data the offers should never change, ideally only new offerings are added. If this is not the case this method allows to clear the cache and work with a freshly fetched set of offerings.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name or the uri of the shop.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A result code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref> is returned. In the case of an error an appropriate HTTP status is set.</simplesect> " ; schema:shortDescription "Clear a shop instance's offerings cache. " ; oplwebsrv:hasParameter <#action_admin.shop.clearOfferingCache_#_name> . <#action_admin.shop.clearOfferingCache_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name or the uri of the shop." . <#action_432296b4e4363f83bda3e7d688fe4e6e> a schema:Action ; schema:name "admin_shop_create" ; schema:target <#action_admin.shop.create> . <#action_admin.shop.create> a schema:EntryPoint ; schema:name "EntryPoint - admin_shop_create" ; schema:url <https://vos.openlinksw.com/ods/api/admin.shop.create> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.shop.create> ; schema:description "Each ODS instance can have several shops. One user has one cart in every shop.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the new shop. This is a unique name to identify the shop. </parameterdescription> </li> <li> <parameternamelist> <parametername>description</parametername> </parameternamelist> <parameterdescription> An optional description of the shop which can be used in generic overview pages. </parameterdescription> </li> <li> <parameternamelist> <parametername>offers</parametername> </parameternamelist> <parameterdescription> The URLs which point to the <computeroutput>schema:Offer</computeroutput> data. This parameter can be specified several times if offerings are defined in different places. Labels and comments of the offerings are expected to be defined in one of those places. Additional information like price specifications may only be referenced. Virtuoso's Sponger will take care of fetching that additional information. </parameterdescription> </li> <li> <parameternamelist> <parametername>currency</parametername> </parameternamelist> <parameterdescription> The currency used in this shop. Possible values include <computeroutput>USD</computeroutput> or <computeroutput>EUR</computeroutput>. The shop will map this value to the <computeroutput>schema:priceCurrency</computeroutput> property value of <computeroutput>schema:UnitPriceSpecification</computeroutput> resources. </parameterdescription> </li> <li> <parameternamelist> <parametername>maxPrice</parametername> </parameternamelist> <parameterdescription> The maximum price for offers in this shop. If this values is higher than <computeroutput>0</computeroutput> any offer added to any cart of the shop cannot have a price higher than the maxPrice. If this value is <computeroutput>0</computeroutput> then there is no limit to the price.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A turtle representation of the newly created shop. In the case of an error an appropriate HTTP status is set and an error as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref> is returned.</simplesect> " ; schema:shortDescription "Create a new ODS shop instance. " ; oplwebsrv:hasParameter <#action_admin.shop.create_#_name> , <#action_admin.shop.create_#_description> , <#action_admin.shop.create_#_offers> , <#action_admin.shop.create_#_currency> , <#action_admin.shop.create_#_maxPrice> . <#action_admin.shop.create_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the new shop. This is a unique name to identify the shop. " . <#action_admin.shop.create_#_description> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "description" ; schema:name "description" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "An optional description of the shop which can be used in generic overview pages. " . <#action_admin.shop.create_#_offers> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "offers" ; schema:name "offers" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The URLs which point to the <computeroutput>schema:Offer</computeroutput> data. This parameter can be specified several times if offerings are defined in different places. Labels and comments of the offerings are expected to be defined in one of those places. Additional information like price specifications may only be referenced. Virtuoso's Sponger will take care of fetching that additional information. " . <#action_admin.shop.create_#_currency> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "currency" ; schema:name "currency" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; oplwebsrv:parameterExampleValue "USD" ; schema:description "The currency used in this shop. Possible values include <computeroutput>USD</computeroutput> or <computeroutput>EUR</computeroutput>. The shop will map this value to the <computeroutput>schema:priceCurrency</computeroutput> property value of <computeroutput>schema:UnitPriceSpecification</computeroutput> resources. " . <#action_admin.shop.create_#_maxPrice> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "maxPrice" ; schema:name "maxPrice" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "The maximum price for offers in this shop. If this values is higher than <computeroutput>0</computeroutput> any offer added to any cart of the shop cannot have a price higher than the maxPrice. If this value is <computeroutput>0</computeroutput> then there is no limit to the price." . <#action_8aa41babfc48c8e4604cbd7cdc847a5b> a schema:Action ; schema:name "admin_shop_delete" ; schema:target <#action_admin.shop.delete> . <#action_admin.shop.delete> a schema:EntryPoint ; schema:name "EntryPoint - admin_shop_delete" ; schema:url <https://vos.openlinksw.com/ods/api/admin.shop.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.shop.delete> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name or the uri of the shop to delete.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A result code as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref> is returned. In the case of an error an appropriate HTTP status is set.</simplesect> " ; schema:shortDescription "Delete a shop instance. " ; oplwebsrv:hasParameter <#action_admin.shop.delete_#_name> . <#action_admin.shop.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name or the uri of the shop to delete." . <#action_dbd2a1ea39f431786c4ac85b8184c5e3> a schema:Action ; schema:name "admin_shop_list" ; schema:target <#action_admin.shop.list> . <#action_admin.shop.list> a schema:EntryPoint ; schema:name "EntryPoint - admin_shop_list" ; schema:url <https://vos.openlinksw.com/ods/api/admin.shop.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.shop.list> ; schema:description "This method lists all shops that have been created via <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga432296b4e4363f83bda3e7d688fe4e6e\">admin.shop.create()</ref>.Using Virtuoso's SPARQL endpoint and the power of Virtuos's Sponger make it easy to retrieve all <computeroutput>schema:Offer</computeroutput> resources including their details that a certain shop includes. All that is required is the shop's URI. In this example the shop URI is <computeroutput><ulink url=\"http://web.ods.openlinksw.com/dataspace/shop/0001.\">http://web.ods.openlinksw.com/dataspace/shop/0001.</ulink></computeroutput> This query makes one assumption about the files rescribing the offerings: The file itself requires to contain <computeroutput>schema:about</computeroutput> links to the <computeroutput>schema:Offer</computeroutput> resources.<programlisting><codeline><highlight class=\"normal\"><sp />define<sp />input:grab-iri<sp /></highlight><highlight class=\"stringliteral\">\"http://web.ods.openlinksw.com/dataspace/shop/0001\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />define<sp />input:grab-var<sp /></highlight><highlight class=\"stringliteral\">\"?src\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />define<sp />input:grab-var<sp /></highlight><highlight class=\"stringliteral\">\"?offer\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />define<sp />input:grab-var<sp /></highlight><highlight class=\"stringliteral\">\"?pp\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />define<sp />input:grab-depth<sp />2</highlight></codeline> <codeline><highlight class=\"normal\"><sp />define<sp />input:grab-destination<sp /></highlight><highlight class=\"stringliteral\">\"http://web.ods.openlinksw.com/dataspace/shop/0001/offerdata\"</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />prefix<sp />gr:<sp /><http:</highlight><highlight class=\"comment\">//purl.org/goodrelations/v1#></highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />prefix<sp />schema:<sp /><http:</highlight><highlight class=\"comment\">//schema.org/></highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />prefix<sp />oplshop:<sp /><http:</highlight><highlight class=\"comment\">//www.openlinksw.com/ontology/shop#></highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />prefix<sp />dcterms:<sp /><http:</highlight><highlight class=\"comment\">//purl.org/dc/terms/></highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />select<sp />distinct</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />xsd:string(?offer)</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />xsd:</highlight><highlight class=\"keywordtype\">string</highlight><highlight class=\"normal\">(?label)</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />xsd:</highlight><highlight class=\"keywordtype\">string</highlight><highlight class=\"normal\">(?comment)</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />xsd:</highlight><highlight class=\"keywordtype\">float</highlight><highlight class=\"normal\">(?price)</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />xsd:</highlight><highlight class=\"keywordtype\">string</highlight><highlight class=\"normal\">(?currency)</highlight></codeline> <codeline><highlight class=\"normal\"><sp />from<sp /><http:</highlight><highlight class=\"comment\">//web.ods.openlinksw.com/dataspace/shop/0001/offerdata></highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp />where<sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><http:</highlight><highlight class=\"comment\">//web.ods.openlinksw.com/dataspace/shop/0001><sp />oplshop:hasOffersSource<sp />?src<sp />.</highlight><highlight class=\"normal\" /></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />optional<sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp />?src<sp />foaf:topic<sp />?offer<sp />.</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />optional<sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp />?offer<sp />a<sp />schema:Offer<sp />;</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:comment<sp />?comment<sp />;</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:name<sp />?label<sp />;</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:priceSpecification<sp />?pp<sp />;</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:validFrom<sp />?vfrom<sp />;</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:validThrough<sp />?vthrough<sp />.</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />optional<sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp />?pp<sp />schema:price<sp />?price<sp />;</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:priceCurrency<sp />?currency<sp />.</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:validFrom<sp />?pvfrom<sp />;</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp /><sp />schema:validThrough<sp />?pvthrough<sp />.</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />}</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />FILTER(!bound(?vfrom)<sp />or<sp />(?vfrom<sp /><=<sp />bif:curutcdatetime()<sp />and<sp />?vthrough<sp />>=<sp />bif:curutcdatetime()))<sp />.</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp />FILTER(!bound(?pvfrom)<sp />or<sp />(?pvfrom<sp /><=<sp />bif:curutcdatetime()<sp />and<sp />?pvthrough<sp />>=<sp />bif:curutcdatetime()))<sp />.</highlight></codeline> <codeline><highlight class=\"normal\"><sp />}</highlight></codeline> </programlisting>There are a few things to note about this query:<itemizedlist> <listitem><computeroutput>input:grab-iri</computeroutput> is used to fetch the shop details before continuing. This is a nice way of telling Virtuoso to download the shop data and save it in a graph to make it available for the further query processing.</listitem><listitem><computeroutput>input:grab-destination</computeroutput> is used to let the Sponger store all fetched information in the same graph. This allows to restrict the query to this one graph via a <computeroutput>from</computeroutput> clause. The only reason for this is better performance.</listitem><listitem>All details that the Sponger is supposed to load from external sources are stated in <computeroutput>optional</computeroutput> graph patterns. This is required since the Virtuoso query engine will run the query several times (<computeroutput>input:grab-depth</computeroutput> restricts it to 2 times), each time grabbing additional information.</listitem><listitem><computeroutput />?src, <computeroutput />?offer, and <computeroutput />?pp are the variables which the Sponger should \"expand\" by fetching additional external information. The first iteration of the query is already based on the data from the shop URI (<computeroutput>input:grab-iri</computeroutput>), the next iteration then uses additional information from the offering sources, and so on.</listitem><listitem>The filters on the valid times need to be non-optional but we still need to cater for the Sponger iterations which do not include the values yet. Hence the <computeroutput>!bound</computeroutput>() filters which make sure we do not get rows which contain all values from invalid offerings except for the valid times.</listitem></itemizedlist> <simplesect kind=\"return\">All configured shops in the form of a Turtle document. </simplesect> " ; schema:shortDescription "List all configured shops. " . <#action_aed3d74d9f7718d3d68771d112e0ef9f> a schema:Action ; schema:name "admin_shop_restriction" ; schema:target <#action_admin.shop.restriction> . <#action_admin.shop.restriction> a schema:EntryPoint ; schema:name "EntryPoint - admin_shop_restriction" ; schema:url <https://vos.openlinksw.com/ods/api/admin.shop.restriction> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.shop.restriction> ; schema:description "ODS shop uses the Virtuoso restriction system to scope different restrictions to different individuals or groups. This procedure allows to retrieve them by name rather than URI. Each restriction URI consists of the shop URI with an appended hash that denotes the restriction.Authentication is optional, meaning that no authentication results in evaluation of public restrictions (ie. such that are scoped to <computeroutput>foaf:Agent</computeroutput>).<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of URI of the shop instance. </parameterdescription> </li> <li> <parameternamelist> <parametername>res</parametername> </parameternamelist> <parameterdescription> The name of the resource to get a restriction value for. Supported values are: <computeroutput>maxPurchasePrice</computeroutput>. </parameterdescription> </li> <li> <parameternamelist> <parametername>type</parametername> </parameternamelist> <parameterdescription> The type of restriction value to be returned, either <computeroutput>min</computeroutput> or <computeroutput>max</computeroutput>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The value of the restriction in plain text or no content at all if no restriction has been defined that matches the authentication information. </simplesect> " ; schema:shortDescription "Get a user restriction value. " ; oplwebsrv:hasParameter <#action_admin.shop.restriction_#_name> , <#action_admin.shop.restriction_#_res> , <#action_admin.shop.restriction_#_type> . <#action_admin.shop.restriction_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of URI of the shop instance. " . <#action_admin.shop.restriction_#_res> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "res" ; schema:name "res" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name of the resource to get a restriction value for. Supported values are: <computeroutput>maxPurchasePrice</computeroutput>. " . <#action_admin.shop.restriction_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; oplwebsrv:parameterExampleValue "max" ; schema:description "The type of restriction value to be returned, either <computeroutput>min</computeroutput> or <computeroutput>max</computeroutput>." . <#action_e8c25b1a604fcf5ddfb842446dbb47b8> a schema:Action ; schema:name "admin_shop_update" ; schema:target <#action_admin.shop.update> . <#action_admin.shop.update> a schema:EntryPoint ; schema:name "EntryPoint - admin_shop_update" ; schema:url <https://vos.openlinksw.com/ods/api/admin.shop.update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSAdminModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/admin.shop.update> ; schema:description "Shop descriptions and the offer URIs can be changed via this method.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name or the uri of the shop to delete. </parameterdescription> </li> <li> <parameternamelist> <parametername>description</parametername> </parameternamelist> <parameterdescription> An optional description of the shop which can be used in generic overview pages. </parameterdescription> </li> <li> <parameternamelist> <parametername>offers</parametername> </parameternamelist> <parameterdescription> The URLs which point to the <computeroutput>schema:Offer</computeroutput> data. This parameter can be specified several times if offerings are defined in different places. Labels and comments of the offerings are expected to be defined in one of those places. Additional information like price specifications may only be referenced. Virtuoso's Sponger will take care of fetching that additional information. If provided at least once the existing offer uris will be overwritten. </parameterdescription> </li> <li> <parameternamelist> <parametername>currency</parametername> </parameternamelist> <parameterdescription> If provided this updates the currency used in this shop. Possible values include <computeroutput>USD</computeroutput> or <computeroutput>EUR</computeroutput>. The shop will map this value to the <computeroutput>schema:priceCurrency</computeroutput> property value of <computeroutput>schema:UnitPriceSpecification</computeroutput> resources. </parameterdescription> </li> <li> <parameternamelist> <parametername>maxPrice</parametername> </parameternamelist> <parameterdescription> If provided this updates the maximum price for offers in this shop. If this values is higher than <computeroutput>0</computeroutput> any offer added to any cart of the shop cannot have a price higher than the maxPrice. If this value is <computeroutput>0</computeroutput> then there is no limit to the price.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A turtle representation of the updated shop. In the case of an error an appropriate HTTP status is set and an error as defined in <ref kindref=\"compound\" refid=\"ods_response_format\">Response format</ref> is returned.</simplesect> " ; schema:shortDescription "Modify the details of an ODS shop instance. " ; oplwebsrv:hasParameter <#action_admin.shop.update_#_name> , <#action_admin.shop.update_#_description> , <#action_admin.shop.update_#_offers> , <#action_admin.shop.update_#_currency> , <#action_admin.shop.update_#_maxPrice> . <#action_admin.shop.update_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The name or the uri of the shop to delete. " . <#action_admin.shop.update_#_description> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "description" ; schema:name "description" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "An optional description of the shop which can be used in generic overview pages. " . <#action_admin.shop.update_#_offers> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "offers" ; schema:name "offers" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "The URLs which point to the <computeroutput>schema:Offer</computeroutput> data. This parameter can be specified several times if offerings are defined in different places. Labels and comments of the offerings are expected to be defined in one of those places. Additional information like price specifications may only be referenced. Virtuoso's Sponger will take care of fetching that additional information. If provided at least once the existing offer uris will be overwritten. " . <#action_admin.shop.update_#_currency> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "currency" ; schema:name "currency" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "If provided this updates the currency used in this shop. Possible values include <computeroutput>USD</computeroutput> or <computeroutput>EUR</computeroutput>. The shop will map this value to the <computeroutput>schema:priceCurrency</computeroutput> property value of <computeroutput>schema:UnitPriceSpecification</computeroutput> resources. " . <#action_admin.shop.update_#_maxPrice> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "maxPrice" ; schema:name "maxPrice" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSAdminModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSAdminModuleAPIDoc> ; schema:description "If provided this updates the maximum price for offers in this shop. If this values is higher than <computeroutput>0</computeroutput> any offer added to any cart of the shop cannot have a price higher than the maxPrice. If this value is <computeroutput>0</computeroutput> then there is no limit to the price." . </script><script type="text/turtle" id="API_instance"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSInstanceModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_Instance" ; schema:description "ODS App Instance Management API" ; schema:mainEntity <#this_ODSInstanceModuleAPI> ; schema:about <#this_ODSInstanceModuleAPI> . <#this_ODSInstanceModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> ; schema:name "ODS_Instance" ; schema:description "ODS App Instance Management API" ; schema:potentialAction <#action_fba31b85838bcfa7b72112b6686d571e> , <#action_1ba1b4d73a33c968f47f15090f537c61> , <#action_e808f48417ece473a05ae8ac16bea352> , <#action_28c1643d8032d1c88fb0cdd2aa4a9133> , <#action_4691f222440cb3c98a47eeca185144f7> , <#action_017b075e90b245c212d3531dd3dde6f2> , <#action_f255bc5df92c1ae63d7dde1c522737fb> , <#action_20b3a7c0205cb7d5836e3b826202ad50> , <#action_fe5e4d2ab5195b29a400ba40711d3b30> , <#action_6e5d81bed3316860586cf785315be72e> , <#action_e8d25f755459e214509679ae5818db36> , <#action_f74738f395b06c5589946c12f77846d8> , <#action_d2a89c3ef8d052e1aea79a7f8f4ce8fa> , <#action_7e19a858fdbcee18a41d50740839706f> . <#action_fba31b85838bcfa7b72112b6686d571e> a schema:Action ; schema:name "instance_create" ; schema:target <#action_instance.create> . <#action_instance.create> a schema:EntryPoint ; schema:name "EntryPoint - instance_create" ; schema:url <https://vos.openlinksw.com/ods/api/instance.create> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.create> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>type</parametername> </parameternamelist> <parameterdescription> The type of instance. Be aware that the corresponding ODS application needs to be installed.<itemizedlist> <listitem><computeroutput>WEBLOG2</computeroutput> </listitem><listitem><computeroutput>eNews2</computeroutput> </listitem><listitem><computeroutput>oWiki</computeroutput> </listitem><listitem><computeroutput>oDrive</computeroutput> </listitem><listitem><computeroutput>oMail</computeroutput> </listitem><listitem><computeroutput>oGallery</computeroutput> </listitem><listitem><computeroutput>Community</computeroutput> </listitem><listitem><computeroutput>Bookmark</computeroutput> </listitem><listitem><computeroutput>nntpf</computeroutput> </listitem><listitem><computeroutput>Polls</computeroutput> </listitem><listitem><computeroutput>AddressBook</computeroutput> </listitem><listitem><computeroutput>SocialNetwork</computeroutput> </listitem><listitem><computeroutput>Calendar</computeroutput> </listitem></itemizedlist> </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> A unique name for the new instance. </parameterdescription> </li> <li> <parameternamelist> <parametername>description</parametername> </parameternamelist> <parameterdescription> A description of the new instance. </parameterdescription> </li> <li> <parameternamelist> <parametername>model</parametername> </parameternamelist> <parameterdescription> The membership model:<itemizedlist> <listitem><computeroutput>0</computeroutput> - Open, anyone can join the instance.</listitem><listitem><computeroutput>1</computeroutput> - Closed, no new members can be added.</listitem><listitem><computeroutput>2</computeroutput> - Invitation only, new members need to be invited by the instance owner.</listitem><listitem><computeroutput>3</computeroutput> - Approval based. The instance owner needs to approve membership requests. </listitem></itemizedlist> </parameterdescription> </li> <li> <parameternamelist> <parametername>public</parametername> </parameternamelist> <parameterdescription> Indicates if the new instance should be public (<computeroutput>1</computeroutput>) or not (<computeroutput>0</computeroutput>). A public instance can be seen by anyone, a private instance can only be seen by the owner.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The internal ID of the newly created instance.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Create a new ODS data space. " ; oplwebsrv:hasParameter <#action_instance.create_#_type> , <#action_instance.create_#_name> , <#action_instance.create_#_description> , <#action_instance.create_#_model> , <#action_instance.create_#_public> . <#action_instance.create_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> ; schema:description "The type of instance. Be aware that the corresponding ODS application needs to be installed.<itemizedlist> <listitem><computeroutput>WEBLOG2</computeroutput> </listitem><listitem><computeroutput>eNews2</computeroutput> </listitem><listitem><computeroutput>oWiki</computeroutput> </listitem><listitem><computeroutput>oDrive</computeroutput> </listitem><listitem><computeroutput>oMail</computeroutput> </listitem><listitem><computeroutput>oGallery</computeroutput> </listitem><listitem><computeroutput>Community</computeroutput> </listitem><listitem><computeroutput>Bookmark</computeroutput> </listitem><listitem><computeroutput>nntpf</computeroutput> </listitem><listitem><computeroutput>Polls</computeroutput> </listitem><listitem><computeroutput>AddressBook</computeroutput> </listitem><listitem><computeroutput>SocialNetwork</computeroutput> </listitem><listitem><computeroutput>Calendar</computeroutput> </listitem></itemizedlist> " . <#action_instance.create_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> ; schema:description "A unique name for the new instance. " . <#action_instance.create_#_description> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "description" ; schema:name "description" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> ; schema:description "A description of the new instance. " . <#action_instance.create_#_model> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "model" ; schema:name "model" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> ; schema:description "The membership model:<itemizedlist> <listitem><computeroutput>0</computeroutput> - Open, anyone can join the instance.</listitem><listitem><computeroutput>1</computeroutput> - Closed, no new members can be added.</listitem><listitem><computeroutput>2</computeroutput> - Invitation only, new members need to be invited by the instance owner.</listitem><listitem><computeroutput>3</computeroutput> - Approval based. The instance owner needs to approve membership requests. </listitem></itemizedlist> " . <#action_instance.create_#_public> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "public" ; schema:name "public" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> ; schema:description "Indicates if the new instance should be public (<computeroutput>1</computeroutput>) or not (<computeroutput>0</computeroutput>). A public instance can be seen by anyone, a private instance can only be seen by the owner." . <#action_1ba1b4d73a33c968f47f15090f537c61> a schema:Action ; schema:name "instance_delete" ; schema:target <#action_instance.delete> . <#action_instance.delete> a schema:EntryPoint ; schema:name "EntryPoint - instance_delete" ; schema:url <https://vos.openlinksw.com/ods/api/instance.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.delete_#_inst_id> . <#action_instance.delete_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_e808f48417ece473a05ae8ac16bea352> a schema:Action ; schema:name "instance_disjoin" ; schema:target <#action_instance.disjoin> . <#action_instance.disjoin> a schema:EntryPoint ; schema:name "EntryPoint - instance_disjoin" ; schema:url <https://vos.openlinksw.com/ods/api/instance.disjoin> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.disjoin> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.disjoin_#_inst_id> . <#action_instance.disjoin_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_28c1643d8032d1c88fb0cdd2aa4a9133> a schema:Action ; schema:name "instance_freeze" ; schema:target <#action_instance.freeze> . <#action_instance.freeze> a schema:EntryPoint ; schema:name "EntryPoint - instance_freeze" ; schema:url <https://vos.openlinksw.com/ods/api/instance.freeze> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.freeze> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.freeze_#_inst_id> . <#action_instance.freeze_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_4691f222440cb3c98a47eeca185144f7> a schema:Action ; schema:name "instance_get" ; schema:target <#action_instance.get> . <#action_instance.get> a schema:EntryPoint ; schema:name "EntryPoint - instance_get" ; schema:url <https://vos.openlinksw.com/ods/api/instance.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.get> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.get_#_inst_id> . <#action_instance.get_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_017b075e90b245c212d3531dd3dde6f2> a schema:Action ; schema:name "instance_get_id" ; schema:target <#action_instance.get.id> . <#action_instance.get.id> a schema:EntryPoint ; schema:name "EntryPoint - instance_get_id" ; schema:url <https://vos.openlinksw.com/ods/api/instance.get.id> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.get.id> ; schema:description "Each ODS app has a unique numeric id which is required for almost all operations. This method allows to determine that id from the app instance's name (App instance names are oftern something like \"foobar's Calendar\").<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>instanceName</parametername> </parameternamelist> <parameterdescription> The name of the app instance.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref> which in this case matches the instance id.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__instance_1ods_instance_id\">ODS App Instance Ids</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.</simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/instance.get.id?instanceName=Demo%20account%27s%20Briefcase&sid=c198c56e675abd9967b2b264d1119ae2\" HTTP/1.1 200 OK Server: Virtuoso/05.12.3041 (Solaris) x86_64-sun-solaris2.10-64 VDB Connection: Keep-Alive Date: Tue, 01 Dec 2009 12:39:19 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"ISO-8859-1\" Content-Length: 57 <result> <code>6</code> <message>Success</message> </result> </pre> " ; schema:shortDescription "Get the id of an ODS app instance. " ; oplwebsrv:hasParameter <#action_instance.get.id_#_instanceName> . <#action_instance.get.id_#_instanceName> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "instanceName" ; schema:name "instanceName" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> ; schema:description "The name of the app instance." . <#action_f255bc5df92c1ae63d7dde1c522737fb> a schema:Action ; schema:name "instance_join" ; schema:target <#action_instance.join> . <#action_instance.join> a schema:EntryPoint ; schema:name "EntryPoint - instance_join" ; schema:url <https://vos.openlinksw.com/ods/api/instance.join> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.join> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.join_#_inst_id> . <#action_instance.join_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_20b3a7c0205cb7d5836e3b826202ad50> a schema:Action ; schema:name "instance_join_approve" ; schema:target <#action_instance.join_approve> . <#action_instance.join_approve> a schema:EntryPoint ; schema:name "EntryPoint - instance_join_approve" ; schema:url <https://vos.openlinksw.com/ods/api/instance.join_approve> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.join_approve> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.join_approve_#_inst_id> , <#action_instance.join_approve_#_uname> . <#action_instance.join_approve_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_instance.join_approve_#_uname> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uname" ; schema:name "uname" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_fe5e4d2ab5195b29a400ba40711d3b30> a schema:Action ; schema:name "instance_notification_cancel" ; schema:target <#action_instance.notification.cancel> . <#action_instance.notification.cancel> a schema:EntryPoint ; schema:name "EntryPoint - instance_notification_cancel" ; schema:url <https://vos.openlinksw.com/ods/api/instance.notification.cancel> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.notification.cancel> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.notification.cancel_#_inst_id> , <#action_instance.notification.cancel_#_services> . <#action_instance.notification.cancel_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_instance.notification.cancel_#_services> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "services" ; schema:name "services" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_6e5d81bed3316860586cf785315be72e> a schema:Action ; schema:name "instance_notification_log" ; schema:target <#action_instance.notification.log> . <#action_instance.notification.log> a schema:EntryPoint ; schema:name "EntryPoint - instance_notification_log" ; schema:url <https://vos.openlinksw.com/ods/api/instance.notification.log> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.notification.log> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.notification.log_#_inst_id> . <#action_instance.notification.log_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_e8d25f755459e214509679ae5818db36> a schema:Action ; schema:name "instance_notification_set" ; schema:target <#action_instance.notification.set> . <#action_instance.notification.set> a schema:EntryPoint ; schema:name "EntryPoint - instance_notification_set" ; schema:url <https://vos.openlinksw.com/ods/api/instance.notification.set> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.notification.set> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.notification.set_#_inst_id> , <#action_instance.notification.set_#_services> . <#action_instance.notification.set_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_instance.notification.set_#_services> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "services" ; schema:name "services" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_f74738f395b06c5589946c12f77846d8> a schema:Action ; schema:name "instance_search" ; schema:target <#action_instance.search> . <#action_instance.search> a schema:EntryPoint ; schema:name "EntryPoint - instance_search" ; schema:url <https://vos.openlinksw.com/ods/api/instance.search> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.search> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.search_#_pattern> . <#action_instance.search_#_pattern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "pattern" ; schema:name "pattern" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_d2a89c3ef8d052e1aea79a7f8f4ce8fa> a schema:Action ; schema:name "instance_unfreeze" ; schema:target <#action_instance.unfreeze> . <#action_instance.unfreeze> a schema:EntryPoint ; schema:name "EntryPoint - instance_unfreeze" ; schema:url <https://vos.openlinksw.com/ods/api/instance.unfreeze> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.unfreeze> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.unfreeze_#_inst_id> . <#action_instance.unfreeze_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_7e19a858fdbcee18a41d50740839706f> a schema:Action ; schema:name "instance_update" ; schema:target <#action_instance.update> . <#action_instance.update> a schema:EntryPoint ; schema:name "EntryPoint - instance_update" ; schema:url <https://vos.openlinksw.com/ods/api/instance.update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSInstanceModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/instance.update> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_instance.update_#_inst_id> , <#action_instance.update_#_name> , <#action_instance.update_#_description> , <#action_instance.update_#_model> , <#action_instance.update_#_public> . <#action_instance.update_#_inst_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inst_id" ; schema:name "inst_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_instance.update_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_instance.update_#_description> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "description" ; schema:name "description" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_instance.update_#_model> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "model" ; schema:name "model" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . <#action_instance.update_#_public> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "public" ; schema:name "public" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSInstanceModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSInstanceModuleAPIDoc> . </script><script type="text/turtle" id="API_misc"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSMiscModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_Misc" ; schema:description "ODS Miscellaneous Functions" ; schema:mainEntity <#this_ODSMiscModuleAPI> ; schema:about <#this_ODSMiscModuleAPI> . <#this_ODSMiscModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> ; schema:name "ODS_Misc" ; schema:description "ODS Miscellaneous Functions" ; schema:potentialAction <#action_20ca9c80da494263b5b9884f14fb26d9> , <#action_8c286d1f8d6cee1b826ce893c9878d5d> , <#action_1e6a996edce55e0e3dc0fce36c21100e> , <#action_e26bd3c5bb01f66feddac2dd07e85dd0> , <#action_2d0264643b77d0855284d530234ef9a8> , <#action_694da38279997cafbe2f2012dfe30c47> , <#action_d215551b4cd058f847851a445aa91dae> , <#action_4dc9e2f9e0e5e799bca75e65b2fea15d> , <#action_2758b965ad2d694c14e326a5d27c0389> . <#action_20ca9c80da494263b5b9884f14fb26d9> a schema:Action ; schema:name "getDefaultHttps" ; schema:target <#action_getDefaultHttps> . <#action_getDefaultHttps> a schema:EntryPoint ; schema:name "EntryPoint - getDefaultHttps" ; schema:url <https://vos.openlinksw.com/ods/api/getDefaultHttps> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/getDefaultHttps> ; schema:shortDescription "" . <#action_8c286d1f8d6cee1b826ce893c9878d5d> a schema:Action ; schema:name "iri2proxy" ; schema:target <#action_iri2proxy> . <#action_iri2proxy> a schema:EntryPoint ; schema:name "EntryPoint - iri2proxy" ; schema:url <https://vos.openlinksw.com/ods/api/iri2proxy> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/iri2proxy> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_iri2proxy_#_iri> . <#action_iri2proxy_#_iri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "iri" ; schema:name "iri" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_1e6a996edce55e0e3dc0fce36c21100e> a schema:Action ; schema:name "linkedinServer" ; schema:target <#action_linkedinServer> . <#action_linkedinServer> a schema:EntryPoint ; schema:name "EntryPoint - linkedinServer" ; schema:url <https://vos.openlinksw.com/ods/api/linkedinServer> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/linkedinServer> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000006\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_linkedinServer_#_hostUrl> . <#action_linkedinServer_#_hostUrl> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "hostUrl" ; schema:name "hostUrl" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_e26bd3c5bb01f66feddac2dd07e85dd0> a schema:Action ; schema:name "linkedinVerify" ; schema:target <#action_linkedinVerify> . <#action_linkedinVerify> a schema:EntryPoint ; schema:name "EntryPoint - linkedinVerify" ; schema:url <https://vos.openlinksw.com/ods/api/linkedinVerify> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/linkedinVerify> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000008\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_linkedinVerify_#_sid> , <#action_linkedinVerify_#_oauth_verifier> , <#action_linkedinVerify_#_oauth_token> . <#action_linkedinVerify_#_sid> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sid" ; schema:name "sid" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_linkedinVerify_#_oauth_verifier> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_verifier" ; schema:name "oauth_verifier" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_linkedinVerify_#_oauth_token> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_token" ; schema:name "oauth_token" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_2d0264643b77d0855284d530234ef9a8> a schema:Action ; schema:name "qrcode" ; schema:target <#action_qrcode> . <#action_qrcode> a schema:EntryPoint ; schema:name "EntryPoint - qrcode" ; schema:url <https://vos.openlinksw.com/ods/api/qrcode> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/qrcode> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_qrcode_#_data> , <#action_qrcode_#_width> , <#action_qrcode_#_height> , <#action_qrcode_#_scale> . <#action_qrcode_#_data> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "data" ; schema:name "data" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_qrcode_#_width> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "width" ; schema:name "width" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> ; oplwebsrv:parameterExampleValue "120" . <#action_qrcode_#_height> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "height" ; schema:name "height" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> ; oplwebsrv:parameterExampleValue "120" . <#action_qrcode_#_scale> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "scale" ; schema:name "scale" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> ; oplwebsrv:parameterExampleValue "3" . <#action_694da38279997cafbe2f2012dfe30c47> a schema:Action ; schema:name "server_getInfo" ; schema:target <#action_server.getInfo> . <#action_server.getInfo> a schema:EntryPoint ; schema:name "EntryPoint - server_getInfo" ; schema:url <https://vos.openlinksw.com/ods/api/server.getInfo> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/server.getInfo> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>info</parametername> </parameternamelist> <parameterdescription> The type of info to return. Supported values are<itemizedlist> <listitem><computeroutput>sslPort</computeroutput> This will return the SSL host and port of the ODS instance if available.</listitem><listitem><computeroutput>regData</computeroutput> This will return the registration and authentication configuration, ie. which registration and authentication methods are available and enabled. See below for an example of the returned data.</listitem><listitem><computeroutput>qrcode</computeroutput> This will return if the QRCode plugin is enabled (loaded) or not.</listitem></itemizedlist> </parameterdescription> </li> </ul> <simplesect kind=\"return\">A JSON stream containing the requested information.</simplesect> <bold>Example:</bold> The following result shows that authentication via WebID, OpenID, Facebook, Twitter, and Google are enabled while LinkedIn and Windows Live are disabled. <computeroutput>digest</computeroutput> refers to authentication or registration via username and password. <computeroutput>connect</computeroutput> refers to connecting an external account with an ODS account. The three blocks <computeroutput>authenticate</computeroutput>, <computeroutput>register</computeroutput>, and <computeroutput>connect</computeroutput> map to the actions as defined in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_action\">Authentication Action Types</ref>, the <computeroutput>labels</computeroutput> block simply contains human-readable labels for the services to be used in UI.<pre> { \"openidEnable\":1, \"facebookEnable\":1, \"twitterEnable\":1, \"linkedinEnable\":0, \"googleEnable\":1, \"sslEnable\":1, \"sslAutomaticEnable\":1, \"authenticate\": { \"digest\":1, \"webid\":1, \"openid\":1, \"facebook\":1, \"twitter\":1, \"linkedin\":0, \"google\":1, \"windowslive\":0, [...] }, \"register\": { \"digest\":1, \"webid\":1, \"openid\":1, \"facebook\":1, \"twitter\":1, \"linkedin\":0, \"google\":1, \"windowslive\":0, [...] }, \"connect\": { \"webid\":1, \"openid\":1, \"facebook\":1, \"twitter\":1, \"linkedin\":0, \"google\":1, \"windowslive\":0, [...] }, \"labels\": { \"webid\":\"WebID\", \"openid\":\"OpenID\", \"facebook\":\"Facebook\", \"twitter\":\"Twitter\", \"linkedin\":\"LinkedIn\", \"google\":\"Google+\", \"windowslive\":\"Windows Live\", [...] } } </pre><simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "Get information about the ODS instance's configuration. " ; oplwebsrv:hasParameter <#action_server.getInfo_#_info> , <#action_server.getInfo_#_json> . <#action_server.getInfo_#_info> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "info" ; schema:name "info" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> ; schema:description "The type of info to return. Supported values are<itemizedlist> <listitem><computeroutput>sslPort</computeroutput> This will return the SSL host and port of the ODS instance if available.</listitem><listitem><computeroutput>regData</computeroutput> This will return the registration and authentication configuration, ie. which registration and authentication methods are available and enabled. See below for an example of the returned data.</listitem><listitem><computeroutput>qrcode</computeroutput> This will return if the QRCode plugin is enabled (loaded) or not.</listitem></itemizedlist> " . <#action_server.getInfo_#_json> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "json" ; schema:name "json" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_d215551b4cd058f847851a445aa91dae> a schema:Action ; schema:name "twitterServer" ; schema:target <#action_twitterServer> . <#action_twitterServer> a schema:EntryPoint ; schema:name "EntryPoint - twitterServer" ; schema:url <https://vos.openlinksw.com/ods/api/twitterServer> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/twitterServer> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000002\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_twitterServer_#_hostUrl> . <#action_twitterServer_#_hostUrl> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "hostUrl" ; schema:name "hostUrl" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_4dc9e2f9e0e5e799bca75e65b2fea15d> a schema:Action ; schema:name "twitterVerify" ; schema:target <#action_twitterVerify> . <#action_twitterVerify> a schema:EntryPoint ; schema:name "EntryPoint - twitterVerify" ; schema:url <https://vos.openlinksw.com/ods/api/twitterVerify> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/twitterVerify> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000004\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_twitterVerify_#_sid> , <#action_twitterVerify_#_oauth_verifier> , <#action_twitterVerify_#_oauth_token> . <#action_twitterVerify_#_sid> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sid" ; schema:name "sid" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_twitterVerify_#_oauth_verifier> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_verifier" ; schema:name "oauth_verifier" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_twitterVerify_#_oauth_token> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_token" ; schema:name "oauth_token" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_2758b965ad2d694c14e326a5d27c0389> a schema:Action ; schema:name "webfinger" ; schema:target <#action_webfinger> . <#action_webfinger> a schema:EntryPoint ; schema:name "EntryPoint - webfinger" ; schema:url <https://vos.openlinksw.com/ods/api/webfinger> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSMiscModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/webfinger> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_webfinger_#_resource> , <#action_webfinger_#_format> . <#action_webfinger_#_resource> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "resource" ; schema:name "resource" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> . <#action_webfinger_#_format> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "format" ; schema:name "format" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSMiscModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSMiscModuleAPIDoc> ; oplwebsrv:parameterExampleValue "json" . </script><script type="text/turtle" id="API_ontology"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSOntologyModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_Ontology" ; schema:description "ODS Ontology Management API" ; schema:mainEntity <#this_ODSOntologyModuleAPI> ; schema:about <#this_ODSOntologyModuleAPI> . <#this_ODSOntologyModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:name "ODS_Ontology" ; schema:description "ODS Ontology Management API" ; schema:potentialAction <#action_8c3969d4f82cf0f4c8376916909a10dd> , <#action_cbbc62a8958db27f38acdd2b4fd794de> , <#action_ec5b81f71f49a6ecc52a6ba58b08ece2> , <#action_22a4d1cd960357acbf43302ad583474e> , <#action_f14a63cbf6b61270d656756ed316c74a> , <#action_4bfceb141c807225c0aae75770875827> , <#action_4a5c9b8572f5db66c894a6905ad7dcd5> , <#action_d00c49d90c83dc701000e549a334c6fa> . <#action_8c3969d4f82cf0f4c8376916909a10dd> a schema:Action ; schema:name "ontology_byPrefix" ; schema:target <#action_ontology.byPrefix> . <#action_ontology.byPrefix> a schema:EntryPoint ; schema:name "EntryPoint - ontology_byPrefix" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.byPrefix> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.byPrefix> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>prefix</parametername> </parameternamelist> <parameterdescription> The ontology prefix.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A JSON ontology URI.</simplesect> <bold>Example:</bold> <pre> $ curl -i http://vos.openlinksw.com/ods/api/ontology.byPrefix?prefix=foaf HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Mon, 05 May 2014 15:57:17 GMT Accept-Ranges: bytes Content-Type: application/json; charset=\"UTF-8\" Content-Length: 25 \"http://xmlns.com/foaf/0.1/\" </pre> " ; schema:shortDescription "Ontology by prefix. " ; oplwebsrv:hasParameter <#action_ontology.byPrefix_#_prefix> , <#action_ontology.byPrefix_#_extern> . <#action_ontology.byPrefix_#_prefix> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "prefix" ; schema:name "prefix" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology prefix." . <#action_ontology.byPrefix_#_extern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "extern" ; schema:name "extern" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_cbbc62a8958db27f38acdd2b4fd794de> a schema:Action ; schema:name "ontology_classes" ; schema:target <#action_ontology.classes> . <#action_ontology.classes> a schema:EntryPoint ; schema:name "EntryPoint - ontology_classes" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.classes> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.classes> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>ontology</parametername> </parameternamelist> <parameterdescription> The ontology IRI. </parameterdescription> </li> <li> <parameternamelist> <parametername>prefix</parametername> </parameternamelist> <parameterdescription> The ontology prefix. </parameterdescription> </li> <li> <parameternamelist> <parametername>ontologyClass</parametername> </parameternamelist> <parameterdescription> The ontology class IRI. When is selected the result contains data for this class only.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The JSON with classes and its subclasses.</simplesect> <bold>Example:</bold> <pre> $ curl -i http://vos.openlinksw.com/ods/api/ontology.classes?prefix=foaf HTTP/1.1 200 OK Server: Virtuoso/07.10.3209 (Win64) x86_64-generic-win-64 VDB Connection: Keep-Alive Date: Thu, 08 May 2014 17:16:11 GMT Accept-Ranges: bytes Content-Type: application/json; charset=\"UTF-8\" Content-Length: 845 { \"name\": \"http://xmlns.com/foaf/0.1/\", \"prefix\": \"foaf\", \"classes\":[ {\"name\": \"foaf:Agent\", \"subClassOf\": [\"rdfs:Class\"]}, {\"name\": \"foaf:Document\", \"subClassOf\": [\"rdfs:Class\"]}, {\"name\": \"foaf:Group\", \"subClassOf\": [\"foaf:Agent\"]}, {\"name\": \"foaf:Image\", \"subClassOf\": [\"foaf:Document\"]}, {\"name\": \"foaf:LabelProperty\", \"subClassOf\": [\"rdfs:Class\"]}, {\"name\": \"foaf:OnlineAccount\", \"subClassOf\": [\"rdfs:Class\"]}, {\"name\": \"foaf:OnlineChatAccount\", \"subClassOf\": [\"foaf:OnlineAccount\"]}, {\"name\": \"foaf:OnlineEcommerceAccount\", \"subClassOf\": [\"foaf:OnlineAccount\"]}, {\"name\": \"foaf:OnlineGamingAccount\", \"subClassOf\": [\"foaf:OnlineAccount\"]}, {\"name\": \"foaf:Organization\", \"subClassOf\": [\"foaf:Agent\"]}, {\"name\": \"foaf:Person\", \"subClassOf\": [\"foaf:Agent\"]}, {\"name\": \"foaf:PersonalProfileDocument\", \"subClassOf\": [\"foaf:Document\"]}, {\"name\": \"foaf:Project\", \"subClassOf\": [\"rdfs:Class\"]} ] } </pre> " ; schema:shortDescription "Ontology classes. " ; oplwebsrv:hasParameter <#action_ontology.classes_#_ontology> , <#action_ontology.classes_#_prefix> , <#action_ontology.classes_#_ontologyClass> , <#action_ontology.classes_#_dependentOntology> , <#action_ontology.classes_#_extern> . <#action_ontology.classes_#_ontology> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontology" ; schema:name "ontology" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology IRI. " . <#action_ontology.classes_#_prefix> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "prefix" ; schema:name "prefix" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology prefix. " . <#action_ontology.classes_#_ontologyClass> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontologyClass" ; schema:name "ontologyClass" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology class IRI. When is selected the result contains data for this class only." . <#action_ontology.classes_#_dependentOntology> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "dependentOntology" ; schema:name "dependentOntology" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> . <#action_ontology.classes_#_extern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "extern" ; schema:name "extern" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_ec5b81f71f49a6ecc52a6ba58b08ece2> a schema:Action ; schema:name "ontology_classProperties" ; schema:target <#action_ontology.classProperties> . <#action_ontology.classProperties> a schema:EntryPoint ; schema:name "EntryPoint - ontology_classProperties" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.classProperties> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.classProperties> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>ontology</parametername> </parameternamelist> <parameterdescription> The ontology IRI. </parameterdescription> </li> <li> <parameternamelist> <parametername>prefix</parametername> </parameternamelist> <parameterdescription> The ontology prefix. </parameterdescription> </li> <li> <parameternamelist> <parametername>ontologyClass</parametername> </parameternamelist> <parameterdescription> The ontology class IRI.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The JSON of the class properties.</simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/ontology.classProperties?prefix=foaf&ontologyClass=foaf:Agent\" HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Fri, 09 May 2014 13:04:42 GMT Accept-Ranges: bytes Content-Type: application/json; charset=\"UTF-8\" Content-Length: 1284 [ {\"name\": \"foaf:account\", \"object\": [\"foaf:OnlineAccount\"]}, {\"name\": \"foaf:age\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:aimChatID\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:birthday\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:gender\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:holdsAccount\", \"object\": [\"foaf:OnlineAccount\"]}, {\"name\": \"foaf:icqChatID\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:interest\", \"object\": [\"foaf:Document\"]}, {\"name\": \"foaf:jabberID\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:made\", \"object\": [\"owl:Thing\"]}, {\"name\": \"foaf:mbox\", \"object\": [\"owl:Thing\"]}, {\"name\": \"foaf:mbox_sha1sum\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:msnChatID\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:openid\", \"object\": [\"foaf:Document\"]}, {\"name\": \"foaf:skypeID\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:status\", \"literal\": [\"rdfs:Literal\"]}, {\"name\": \"foaf:tipjar\", \"object\": [\"foaf:Document\"]}, {\"name\": \"foaf:topic_interest\", \"object\": [\"owl:Thing\"]}, {\"name\": \"foaf:weblog\", \"object\": [\"foaf:Document\"]}, {\"name\": \"foaf:yahooChatID\", \"literal\": [\"rdfs:Literal\"]} ] </pre> " ; schema:shortDescription "Ontology class properties with its type and range. " ; oplwebsrv:hasParameter <#action_ontology.classProperties_#_ontology> , <#action_ontology.classProperties_#_prefix> , <#action_ontology.classProperties_#_ontologyClass> , <#action_ontology.classProperties_#_extern> . <#action_ontology.classProperties_#_ontology> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontology" ; schema:name "ontology" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology IRI. " . <#action_ontology.classProperties_#_prefix> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "prefix" ; schema:name "prefix" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology prefix. " . <#action_ontology.classProperties_#_ontologyClass> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontologyClass" ; schema:name "ontologyClass" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology class IRI." . <#action_ontology.classProperties_#_extern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "extern" ; schema:name "extern" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_22a4d1cd960357acbf43302ad583474e> a schema:Action ; schema:name "ontology_denormalize" ; schema:target <#action_ontology.denormalize> . <#action_ontology.denormalize> a schema:EntryPoint ; schema:name "EntryPoint - ontology_denormalize" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.denormalize> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.denormalize> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>iri</parametername> </parameternamelist> <parameterdescription> The full IRI for de-normilize</parameterdescription> </li> </ul> <simplesect kind=\"return\">The denormilized IRI.</simplesect> <bold>Example:</bold> <pre> $ curl -i http://vos.openlinksw.com/ods/api/ontology.denormalize?iri=http://xmlns.com/foaf/0.1/Person HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Mon, 05 May 2014 15:57:17 GMT Accept-Ranges: bytes Content-Type: text/plain; charset=\"UTF-8\" Content-Length: 26 foaf:Person </pre> " ; schema:shortDescription "IRI nomalize. " ; oplwebsrv:hasParameter <#action_ontology.denormalize_#_iri> , <#action_ontology.denormalize_#_ontology> , <#action_ontology.denormalize_#_prefix> . <#action_ontology.denormalize_#_iri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "iri" ; schema:name "iri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The full IRI for de-normilize" . <#action_ontology.denormalize_#_ontology> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontology" ; schema:name "ontology" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> . <#action_ontology.denormalize_#_prefix> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "prefix" ; schema:name "prefix" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> . <#action_f14a63cbf6b61270d656756ed316c74a> a schema:Action ; schema:name "ontology_list" ; schema:target <#action_ontology.list> . <#action_ontology.list> a schema:EntryPoint ; schema:name "EntryPoint - ontology_list" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.list> ; schema:description "<simplesect kind=\"return\">The JSON with ontologies and its pefixes.</simplesect> <bold>Example:</bold> <pre> $ curl -i http://vos.openlinksw.com/ods/api/ontology.list HTTP/1.1 200 OK Server: Virtuoso/07.10.3209 (Win64) x86_64-generic-win-64 VDB Connection: Keep-Alive Date: Thu, 08 May 2014 17:16:11 GMT Accept-Ranges: bytes Content-Type: application/json; charset=\"UTF-8\" Content-Length: 845 [ {\"name\": \"http://xmlns.com/foaf/0.1/\", \"prefix\": \"foaf\"} ] </pre> " ; schema:shortDescription "List of ontology. " ; oplwebsrv:hasParameter <#action_ontology.list_#_extern> . <#action_ontology.list_#_extern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "extern" ; schema:name "extern" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_4bfceb141c807225c0aae75770875827> a schema:Action ; schema:name "ontology_normalize" ; schema:target <#action_ontology.normalize> . <#action_ontology.normalize> a schema:EntryPoint ; schema:name "EntryPoint - ontology_normalize" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.normalize> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.normalize> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>iri</parametername> </parameternamelist> <parameterdescription> The IRI for normilize</parameterdescription> </li> </ul> <simplesect kind=\"return\">The normilized IRI.</simplesect> <bold>Example:</bold> <pre> $ curl -i http://vos.openlinksw.com/ods/api/ontology.denormalize?iri=foaf:Person HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Mon, 05 May 2014 15:57:17 GMT Accept-Ranges: bytes Content-Type: text/plain; charset=\"UTF-8\" Content-Length: 26 http://xmlns.com/foaf/0.1/Person </pre> " ; schema:shortDescription "IRI de-nomalize. " ; oplwebsrv:hasParameter <#action_ontology.normalize_#_iri> , <#action_ontology.normalize_#_ontology> , <#action_ontology.normalize_#_prefix> . <#action_ontology.normalize_#_iri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "iri" ; schema:name "iri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The IRI for normilize" . <#action_ontology.normalize_#_ontology> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontology" ; schema:name "ontology" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> . <#action_ontology.normalize_#_prefix> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "prefix" ; schema:name "prefix" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> . <#action_4a5c9b8572f5db66c894a6905ad7dcd5> a schema:Action ; schema:name "ontology_objects" ; schema:target <#action_ontology.objects> . <#action_ontology.objects> a schema:EntryPoint ; schema:name "EntryPoint - ontology_objects" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.objects> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.objects> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>ontology</parametername> </parameternamelist> <parameterdescription> The ontology IRI. </parameterdescription> </li> <li> <parameternamelist> <parametername>prefix</parametername> </parameternamelist> <parameterdescription> The ontology prefix.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A vector of the ontology prefined objects if exist.</simplesect> <bold>Example:</bold> <pre> $ curl -i http://vos.openlinksw.com/ods/api/ontology.objects?prefix=gr HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Mon, 05 May 2014 15:57:17 GMT Accept-Ranges: bytes Content-Type: application/json; charset=\"UTF-8\" Content-Length: 2538 [ {\"id\": \"gr:Business\", \"class\": \"gr:BusinessEntityType\"}, {\"id\": \"gr:Enduser\", \"class\": \"gr:BusinessEntityType\"}, {\"id\": \"gr:PublicInstitution\", \"class\": \"gr:BusinessEntityType\"}, {\"id\": \"gr:Reseller\", \"class\": \"gr:BusinessEntityType\"}, {\"id\": \"gr:Buy\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:ConstructionInstallation\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:Dispose\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:LeaseOut\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:Maintain\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:ProvideService\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:Repair\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:Sell\", \"class\": \"gr:BusinessFunction\"}, {\"id\": \"gr:Friday\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:Monday\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:PublicHolidays\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:Saturday\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:Sunday\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:Thursday\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:Tuesday\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:Wednesday\", \"class\": \"gr:DayOfWeek\"}, {\"id\": \"gr:DeliveryModeDirectDownload\", \"class\": \"gr:DeliveryMethod\"}, {\"id\": \"gr:DeliveryModeFreight\", \"class\": \"gr:DeliveryMethod\"}, {\"id\": \"gr:DeliveryModeMail\", \"class\": \"gr:DeliveryMethod\"}, {\"id\": \"gr:DeliveryModeOwnFleet\", \"class\": \"gr:DeliveryMethod\"}, {\"id\": \"gr:DeliveryModePickUp\", \"class\": \"gr:DeliveryMethod\"}, {\"id\": \"gr:DHL\", \"class\": \"gr:DeliveryModeParcelService\"}, {\"id\": \"gr:FederalExpress\", \"class\": \"gr:DeliveryModeParcelService\"}, {\"id\": \"gr:UPS\", \"class\": \"gr:DeliveryModeParcelService\"}, {\"id\": \"gr:ByBankTransferInAdvance\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:ByInvoice\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:COD\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:Cash\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:CheckInAdvance\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:DirectDebit\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:GoogleCheckout\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:PayPal\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:PaySwarm\", \"class\": \"gr:PaymentMethod\"}, {\"id\": \"gr:AmericanExpress\", \"class\": \"gr:PaymentMethodCreditCard\"}, {\"id\": \"gr:DinersClub\", \"class\": \"gr:PaymentMethodCreditCard\"}, {\"id\": \"gr:Discover\", \"class\": \"gr:PaymentMethodCreditCard\"}, {\"id\": \"gr:JCB\", \"class\": \"gr:PaymentMethodCreditCard\"}, {\"id\": \"gr:MasterCard\", \"class\": \"gr:PaymentMethodCreditCard\"}, {\"id\": \"gr:VISA\", \"class\": \"gr:PaymentMethodCreditCard\"}, {\"id\": \"gr:Labor-BringIn\", \"class\": \"gr:WarrantyScope\"}, {\"id\": \"gr:PartsAndLabor-BringIn\", \"class\": \"gr:WarrantyScope\"}, {\"id\": \"gr:PartsAndLabor-PickUp\", \"class\": \"gr:WarrantyScope\"} ] </pre> " ; schema:shortDescription "Ontology prefined objects. " ; oplwebsrv:hasParameter <#action_ontology.objects_#_ontology> , <#action_ontology.objects_#_prefix> , <#action_ontology.objects_#_extern> . <#action_ontology.objects_#_ontology> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontology" ; schema:name "ontology" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology IRI. " . <#action_ontology.objects_#_prefix> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "prefix" ; schema:name "prefix" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology prefix." . <#action_ontology.objects_#_extern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "extern" ; schema:name "extern" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_d00c49d90c83dc701000e549a334c6fa> a schema:Action ; schema:name "ontology_properties" ; schema:target <#action_ontology.properties> . <#action_ontology.properties> a schema:EntryPoint ; schema:name "EntryPoint - ontology_properties" ; schema:url <https://vos.openlinksw.com/ods/api/ontology.properties> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSOntologyModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/ontology.properties> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>ontology</parametername> </parameternamelist> <parameterdescription> The ontology IRI. </parameterdescription> </li> <li> <parameternamelist> <parametername>prefix</parametername> </parameternamelist> <parameterdescription> The ontology prefix.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The JSON of the all ontology properties.</simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/ontology.properties?prefix=foaf\" HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Fri, 09 May 2014 13:04:42 GMT Accept-Ranges: bytes Content-Type: application/json; charset=\"UTF-8\" Content-Length: 4790 [ {\"name\": \"foaf:account\", \"type\": \"owl:ObjectProperty\", \"range\": \"foaf:OnlineAccount\"}, {\"name\": \"foaf:accountName\", \"type\": \"owl:DatatypeProperty\", \"range\": \"rdfs:Literal\"}, {\"name\": \"foaf:accountServiceHomepage\", \"type\": \"owl:ObjectProperty\", \"range\": \"foaf:Document\"}, {\"name\": \"foaf:age\", \"type\": \"owl:DatatypeProperty\", \"range\": \"rdfs:Literal\"}, {\"name\": \"foaf:aimChatID\", \"type\": \"owl:DatatypeProperty\", \"range\": \"rdfs:Literal\"}, {\"name\": \"foaf:based_near\", \"type\": \"owl:ObjectProperty\", \"range\": \"geo:SpatialThing\"}, ... ] </pre> " ; schema:shortDescription "Ontology properties with its type and range. " ; oplwebsrv:hasParameter <#action_ontology.properties_#_ontology> , <#action_ontology.properties_#_prefix> , <#action_ontology.properties_#_extern> . <#action_ontology.properties_#_ontology> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "ontology" ; schema:name "ontology" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology IRI. " . <#action_ontology.properties_#_prefix> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "prefix" ; schema:name "prefix" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; schema:description "The ontology prefix." . <#action_ontology.properties_#_extern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "extern" ; schema:name "extern" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSOntologyModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSOntologyModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . </script><script type="text/turtle" id="API_query"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSQueryModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_Query" ; schema:description "ODS General Query API" ; schema:mainEntity <#this_ODSQueryModuleAPI> ; schema:about <#this_ODSQueryModuleAPI> . <#this_ODSQueryModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSQueryModuleAPIDoc> ; schema:name "ODS_Query" ; schema:description "ODS General Query API" ; schema:potentialAction <#action_a414cfba762ecd76d5a58755ab7072f5> . <#action_a414cfba762ecd76d5a58755ab7072f5> a schema:Action ; schema:name "query_sparql" ; schema:target <#action_query.sparql> . <#action_query.sparql> a schema:EntryPoint ; schema:name "EntryPoint - query_sparql" ; schema:url <https://vos.openlinksw.com/ods/api/query.sparql> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSQueryModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/query.sparql> ; schema:description "ODS exposes most of its information as linked data through the Virtuoso triple store. All private information is stored in graphs which are protected by Virtuoso's ACL engine. This method allow to query the triple store using any of the supported ODS authentication mechanisms. Other than that it is comparable to Virtuoso's <computeroutput>/sparql</computeroutput> endpoint.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>query</parametername> </parameternamelist> <parameterdescription> The actual SPARQL query to be executed. Be aware that query URLs might be cut at a certain max length. So for long query strings it will be better to perform an HTTP POST with the URL-encoded parameters in the body. </parameterdescription> </li> <li> <parameternamelist> <parametername>format</parametername> </parameternamelist> <parameterdescription> The result format. This can be any of the Virtuoso supported formats:<itemizedlist> <listitem>For SPARQL select binding results:<itemizedlist> <listitem><computeroutput>auto</computeroutput> - Automatic selection</listitem><listitem>HTML - text/html</listitem><listitem><computeroutput>application/vnd.ms-excel</computeroutput> - Spreadsheet</listitem><listitem><computeroutput>application/sparql-results+xml</computeroutput> - XML</listitem><listitem><computeroutput>application/sparql-results+json</computeroutput> - JSON</listitem><listitem><computeroutput>application/javascript</computeroutput> - Javascript</listitem><listitem><computeroutput>text/rdf+n3</computeroutput> - N3/Turtle</listitem><listitem><computeroutput>application/rdf+xml</computeroutput> - RDF/XML</listitem><listitem><computeroutput>text/plain</computeroutput> - N-Triples</listitem><listitem><computeroutput>text/csv</computeroutput> - CSV</listitem><listitem><computeroutput>text/tab-separated-values</computeroutput> - TSV</listitem></itemizedlist> </listitem><listitem>For construct or describe results:<itemizedlist> <listitem><computeroutput>text/rdf+n3</computeroutput> - N3/Turtle</listitem><listitem><computeroutput>application/rdf+json</computeroutput> - RDF/JSON</listitem><listitem><computeroutput>application/rdf+xml</computeroutput> - RDF/XML</listitem><listitem><computeroutput>text/plain</computeroutput> - N-Triples</listitem><listitem><computeroutput>application/xhtml+xml</computeroutput> - XHTML+RDFa</listitem><listitem><computeroutput>application/atom+xml</computeroutput> - ATOM+XML</listitem><listitem><computeroutput>application/odata+json</computeroutput> - ODATA/JSON</listitem><listitem><computeroutput>application/x-json+ld</computeroutput> - JSON-LD</listitem><listitem><computeroutput>text/x-html+ul</computeroutput> - HTML (list)</listitem><listitem><computeroutput>text/x-html+tr</computeroutput> - HTML (table)</listitem><listitem><computeroutput>text/html</computeroutput> - HTML+Microdata</listitem><listitem><computeroutput>application/microdata+json</computeroutput> - Microdata/JSON</listitem><listitem><computeroutput>text/csv</computeroutput> - CSV</listitem><listitem><computeroutput>text/tab-separated-values</computeroutput> Tab-separated values</listitem><listitem><computeroutput>application/x-trig</computeroutput> - TriG</listitem><listitem><computeroutput>application/x-nice-turtle</computeroutput> - Pretty-printed Turtle (slow!)</listitem></itemizedlist> </listitem></itemizedlist> </parameterdescription> </li> </ul> <simplesect kind=\"return\">A stream of SPARQL results encoded in the requested format.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function will provide additional information if authentication via one of the supported methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> is used. </simplesect> " ; schema:shortDescription "Query the Virtuoso triple store with ODS credentials. " ; oplwebsrv:hasParameter <#action_query.sparql_#_query> , <#action_query.sparql_#_format> . <#action_query.sparql_#_query> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "query" ; schema:name "query" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSQueryModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSQueryModuleAPIDoc> ; schema:description "The actual SPARQL query to be executed. Be aware that query URLs might be cut at a certain max length. So for long query strings it will be better to perform an HTTP POST with the URL-encoded parameters in the body. " . <#action_query.sparql_#_format> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "format" ; schema:name "format" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSQueryModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSQueryModuleAPIDoc> ; oplwebsrv:parameterExampleValue "auto" ; schema:description "The result format. This can be any of the Virtuoso supported formats:<itemizedlist> <listitem>For SPARQL select binding results:<itemizedlist> <listitem><computeroutput>auto</computeroutput> - Automatic selection</listitem><listitem>HTML - text/html</listitem><listitem><computeroutput>application/vnd.ms-excel</computeroutput> - Spreadsheet</listitem><listitem><computeroutput>application/sparql-results+xml</computeroutput> - XML</listitem><listitem><computeroutput>application/sparql-results+json</computeroutput> - JSON</listitem><listitem><computeroutput>application/javascript</computeroutput> - Javascript</listitem><listitem><computeroutput>text/rdf+n3</computeroutput> - N3/Turtle</listitem><listitem><computeroutput>application/rdf+xml</computeroutput> - RDF/XML</listitem><listitem><computeroutput>text/plain</computeroutput> - N-Triples</listitem><listitem><computeroutput>text/csv</computeroutput> - CSV</listitem><listitem><computeroutput>text/tab-separated-values</computeroutput> - TSV</listitem></itemizedlist> </listitem><listitem>For construct or describe results:<itemizedlist> <listitem><computeroutput>text/rdf+n3</computeroutput> - N3/Turtle</listitem><listitem><computeroutput>application/rdf+json</computeroutput> - RDF/JSON</listitem><listitem><computeroutput>application/rdf+xml</computeroutput> - RDF/XML</listitem><listitem><computeroutput>text/plain</computeroutput> - N-Triples</listitem><listitem><computeroutput>application/xhtml+xml</computeroutput> - XHTML+RDFa</listitem><listitem><computeroutput>application/atom+xml</computeroutput> - ATOM+XML</listitem><listitem><computeroutput>application/odata+json</computeroutput> - ODATA/JSON</listitem><listitem><computeroutput>application/x-json+ld</computeroutput> - JSON-LD</listitem><listitem><computeroutput>text/x-html+ul</computeroutput> - HTML (list)</listitem><listitem><computeroutput>text/x-html+tr</computeroutput> - HTML (table)</listitem><listitem><computeroutput>text/html</computeroutput> - HTML+Microdata</listitem><listitem><computeroutput>application/microdata+json</computeroutput> - Microdata/JSON</listitem><listitem><computeroutput>text/csv</computeroutput> - CSV</listitem><listitem><computeroutput>text/tab-separated-values</computeroutput> Tab-separated values</listitem><listitem><computeroutput>application/x-trig</computeroutput> - TriG</listitem><listitem><computeroutput>application/x-nice-turtle</computeroutput> - Pretty-printed Turtle (slow!)</listitem></itemizedlist> </listitem></itemizedlist> " . </script><script type="text/turtle" id="API_user"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSUserModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_User" ; schema:description "ODS User Profile Management API" ; schema:mainEntity <#this_ODSUserModuleAPI> ; schema:about <#this_ODSUserModuleAPI> . <#this_ODSUserModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:name "ODS_User" ; schema:description "ODS User Profile Management API" ; schema:potentialAction <#action_5f8c2e15e08364057455246a9a6aa907> , <#action_a5b7bc990093ae641d2a777cbe386766> , <#action_850598d36e8fe9bf877d750bc98c31cc> , <#action_3eb2b86aceaaea30e381a1c6fc839452> , <#action_6238a5b780bc6a2811d977bfdc2a9f96> , <#action_d6f02a38ce0b890ad56c35888e33eed8> , <#action_e57c8caea0f528b4fedf05cb34656540> , <#action_974f604be99696e368122af579e4a670> , <#action_c4a44364bb01b5a6190ee9891d396c94> , <#action_12318092617414e4bf46cf26a5444995> , <#action_20aface7d78e43a59e18321ba68b3b25> , <#action_0ee2110be2d0c0557a63715de1828a21> , <#action_f3cdde03422b5229c1e0da88aecbbc02> , <#action_807b4d5525d41c3e57153d16b63550b7> , <#action_6d06a0c4234b65cdb32592109db723fb> , <#action_08433bad261e430d17a7e1c6243b0f1a> , <#action_2610d8c4c79df52949bdc7691550999c> , <#action_e73bd1caaa489c62e79a64337c00edcd> , <#action_8b054c0d917f2c0d2238e559a71720bf> , <#action_dc0be85f0f17bba11dfbf055c541aef9> , <#action_2bf1904a63e0cda499071b2045488a8e> , <#action_e4a210b40f67d3263a23fc276d5f2ddd> , <#action_a383784d1c31a23a5687ddc25485e4e4> , <#action_955bca2ca9ff875e2bdb7f0d676e1c10> , <#action_aeccd6c639e21209915c5d1f846f4925> , <#action_74749a74f6dc1347e1df25b7c0082739> , <#action_1c155be33ae582553ab7ddd8e2b85a5c> , <#action_f1e7bb7f65ea19f106a4f89495a42e51> , <#action_cc35aebac06452361e5294175ed63841> , <#action_f43f1ade207c62354db52ae9b741164d> , <#action_8a8fa955de45599b5a5b8c5088a70436> , <#action_64ab2cc30f97cc05cb3a405047959545> , <#action_544c77f703c7c8c9373e06bf97428258> , <#action_a17e86489578968ab0aabaa53c9e44cc> , <#action_0238f6cb1f76ec1db5572e9c79a6c3fe> , <#action_290c5fd3bbbd86c5b1d768515f6b2fff> , <#action_3126592d72decd62dbc22a3c1ea2b185> , <#action_2014031675de3dbd1542fe80d0cbdcd6> , <#action_108187adebaca2104cdfa59094951872> , <#action_05f810efd14314e3f8390f14efdd01c1> , <#action_81c931a41511460716d7cb43e748a839> , <#action_61ff7d0b1f9dcba8346c32d7bbff32be> , <#action_86c9649a7994f79bdf41b484ee88f76b> , <#action_d47d0fcb342013c577dcb92a5ee3b8c8> , <#action_f0abb9656d7a4b1ccd34a5eecdb68e00> , <#action_33086cfe66b0e314e5b8a3e83ae33437> , <#action_3937eecbf3d82e29667c487f4c404e3f> , <#action_cb40815a971206657c42e68ab0a2ab77> , <#action_b7ea59582c5db9d82c8e85730a8b11ed> , <#action_e6be624a2c149c799944c6bd9e4a6c34> , <#action_2eaa526f2fce7feb41bb996db7c27e53> , <#action_c6890a069c5aa6d17e09ab482033d34f> , <#action_e2f5c10016376f74a32b39be2ad7296a> , <#action_4574db9a55aaf933a9bfe71bb5c0165e> , <#action_90a9689419bbfd1bf7b3a9078ef1ff3d> , <#action_3ba22eb29e8e6d14db09fbae7478ba8b> , <#action_81e805511be84bc4dad5af6aaf147ec4> , <#action_862a10c7c945f08c3b32406aeeebee35> , <#action_9336f54c75d7d31d23e6d41b33800dcb> , <#action_d6fa906ebe473bb8220ff82b2c9ed357> , <#action_553df274a6ec61c6f89bb62ea78303f6> , <#action_154c3ab12e48efadeb13afcc896b3dd4> , <#action_caf917d50a8dc97695b4fe9e3a88ca6e> , <#action_2b062b3446ec84819f7acc71233e4212> , <#action_e05afcd744f27a47a1f18e842cbc1176> , <#action_cc5a2898879bbd842fb442dae97320a6> , <#action_0d9d97fd1ef32c38c14949e9e14fe401> , <#action_006798044e5635c8892bd40547a0914d> , <#action_85cc5b04ec6073a6ad71aa006da7250f> , <#action_f9826a4dd0a1d11dc8d3d6c57dc46978> , <#action_281290eba4d4cac10cfd292d275141e8> , <#action_2f8d4e7b37e631657c0badc9918ba5e3> , <#action_1d1203c1c7e0c3679c9395cf66eb1829> , <#action_e672214e6c9e8e75ae37c84a96f63297> , <#action_de5c458c1efcb2e4aeef1426adbb4ecf> , <#action_7c97030b0e756dddbfb433103c475a17> , <#action_36b7a808d985734d162e3b76098891ff> , <#action_74edeb21c990ffa4d8e554fd8dd13eff> , <#action_da9926a1513e45b817e6f15ec9faf882> , <#action_69f5d32f2fd7170073a205cff531b823> , <#action_4d6e56e08decb6b2422a68f5ce113c55> , <#action_4d30ccc3e6f6b1167521d664f1214f11> , <#action_fcc423fd90ed7ac701ae720b51165e83> , <#action_5f5768af135ac0828bc448665994de30> , <#action_ef22ce041897114f92c941bda43ff66f> , <#action_2181b5d57683550ed4d9af556df237b5> , <#action_3345fcd06099b890890e0b1266147ac5> , <#action_454e9821088a774ba245ffcef0f16965> , <#action_51949c776742c1f3b5c16d49e5d4fd02> , <#action_13c32dc03db0eaa27d7af5219f8aac86> , <#action_44832721d52264f13a216cba592fb11c> , <#action_bff5adf64d0a8d144eea3bf00c186825> , <#action_ed278f53a1c3b676a7bfa90300bd787c> , <#action_09e8a2b568e0a2ab718d062a7864f6b2> , <#action_53a3a01c23b0bd22c6f8b5a5c8b93407> , <#action_4a14817a0eca5c100dc15d0621f5db02> , <#action_84bde539ffa09ed354e538962177f350> , <#action_8393abcc162d8c1e9d4ec0eb781519de> , <#action_1bf6fe6fccafb1adf6af9942407ee6c4> , <#action_a5d73f8ca8a1759c75487303857c221b> , <#action_a2a5c29541fd9a2aa1750da6c7c3cf48> , <#action_590988d4501680d3842e4f6c45f7a399> , <#action_48d34c70383a8a61eca6e2a038728bed> , <#action_2ee5c858e3093c0bc9dd67aa6ee15fc8> , <#action_e66454567e88ef6de5c7bf836025d308> , <#action_7f589b9c2410f02aeaff41d4e054d735> , <#action_41282c102ba666f7c49f212b6bcf1afa> , <#action_76e99d5d1f8306ec6a003747917129be> , <#action_0ee8a3214520a223cd188b1ed0b65784> , <#action_777818aa3df3994ecb3fc581e691c18a> , <#action_d209f4dae81756549e7a8bd5698b049a> , <#action_e4ab377e106ca7c8bbd52b84cedd7e1b> . <#action_5f8c2e15e08364057455246a9a6aa907> a schema:Action ; schema:name "user_acl_info" ; schema:target <#action_user.acl.info> . <#action_user.acl.info> a schema:EntryPoint ; schema:name "EntryPoint - user_acl_info" ; schema:url <https://vos.openlinksw.com/ods/api/user.acl.info> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.acl.info> ; schema:description "Almost each detail in a user's profile can have its individual privacy setting as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_user_privacy\">ODS User Privacy Settings</ref>. This method returns the currently configured privacy settings for the authenticated user.<simplesect kind=\"return\">An XML stream containing one tag for each user profile detail with the following content:<itemizedlist> <listitem><computeroutput>1</computeroutput> - The detail is public</listitem><listitem><computeroutput>2</computeroutput> - The detail is controlled by ACLs. FIXME: see also somewhere</listitem><listitem><computeroutput>3</computeroutput> - The detail is private</listitem></itemizedlist> </simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1gaa5b7bc990093ae641d2a777cbe386766\">user.acl.update()</ref></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/user.acl.info?user_name=demo&password_hash=49e473da03fbf295f06b5f0bf1f3301b5e4a67fc\" HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Wed, 18 Apr 2012 06:30:48 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 1421 <acl> <title>1</title> <firstName>1</firstName> <lastName>1</lastName> <fullName>1</fullName> <mail>1</mail> <gender>1</gender> <birthday>2</birthday> <homepage>1</homepage> <webIDs>1</webIDs> <mailSignature>3</mailSignature> <icq>1</icq> <skype>1</skype> <yahoo>1</yahoo> [...] </acl> </pre> " ; schema:shortDescription "Get privacy information about user profile details. " . <#action_a5b7bc990093ae641d2a777cbe386766> a schema:Action ; schema:name "user_acl_update" ; schema:target <#action_user.acl.update> . <#action_user.acl.update> a schema:EntryPoint ; schema:name "EntryPoint - user_acl_update" ; schema:url <https://vos.openlinksw.com/ods/api/user.acl.update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.acl.update> ; schema:description "Almost each detail in a user's profile can have its individual privacy setting as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_user_privacy\">ODS User Privacy Settings</ref>. This method allows to change these privacy settings.The following user detail identifier are supported:<itemizedlist> <listitem><computeroutput>title</computeroutput> </listitem><listitem><computeroutput>firstName</computeroutput> </listitem><listitem><computeroutput>lastName</computeroutput> </listitem><listitem><computeroutput>fullName</computeroutput> </listitem><listitem><computeroutput>mail</computeroutput> </listitem><listitem><computeroutput>gender</computeroutput> </listitem><listitem><computeroutput>birthday</computeroutput> </listitem><listitem><computeroutput>homepage</computeroutput> </listitem><listitem><computeroutput>webIDs</computeroutput> </listitem><listitem><computeroutput>mailSignature</computeroutput> </listitem><listitem><computeroutput>icq</computeroutput> </listitem><listitem><computeroutput>skype</computeroutput> </listitem><listitem><computeroutput>yahoo</computeroutput> </listitem><listitem><computeroutput>aim</computeroutput> </listitem><listitem><computeroutput>msn</computeroutput> </listitem><listitem><computeroutput>homeAddress1</computeroutput> </listitem><listitem><computeroutput>homeCountry</computeroutput> </listitem><listitem><computeroutput>homeTimezone</computeroutput> </listitem><listitem><computeroutput>homePhone</computeroutput> </listitem><listitem><computeroutput>businessIndustry</computeroutput> </listitem><listitem><computeroutput>businessOrganization</computeroutput> </listitem><listitem><computeroutput>businessJob</computeroutput> </listitem><listitem><computeroutput>businessAddress1</computeroutput> </listitem><listitem><computeroutput>businessCountry</computeroutput> </listitem><listitem><computeroutput>businessTimezone</computeroutput> </listitem><listitem><computeroutput>businessPhone</computeroutput> </listitem><listitem><computeroutput>businessRegNo</computeroutput> </listitem><listitem><computeroutput>businessCareer</computeroutput> </listitem><listitem><computeroutput>businessEmployees</computeroutput> </listitem><listitem><computeroutput>businessVendor</computeroutput> </listitem><listitem><computeroutput>businessService</computeroutput> </listitem><listitem><computeroutput>businessOther</computeroutput> </listitem><listitem><computeroutput>businessNetwork</computeroutput> </listitem><listitem><computeroutput>summary</computeroutput> </listitem><listitem><computeroutput>businessResume</computeroutput> </listitem><listitem><computeroutput>photo</computeroutput> </listitem><listitem><computeroutput>homeLatitude</computeroutput> </listitem><listitem><computeroutput>audio</computeroutput> </listitem><listitem><computeroutput>businessLatitude</computeroutput> </listitem><listitem><computeroutput>interests</computeroutput> </listitem><listitem><computeroutput>topicInterests</computeroutput> </listitem><listitem><computeroutput>businessIcq</computeroutput> </listitem><listitem><computeroutput>businessSkype</computeroutput> </listitem><listitem><computeroutput>businessYahoo</computeroutput> </listitem><listitem><computeroutput>businessAim</computeroutput> </listitem><listitem><computeroutput>businessMsn</computeroutput> </listitem><listitem><computeroutput>homeCode</computeroutput> </listitem><listitem><computeroutput>homeCity</computeroutput> </listitem><listitem><computeroutput>homeState</computeroutput> </listitem><listitem><computeroutput>businessCode</computeroutput> </listitem><listitem><computeroutput>businessCity</computeroutput> </listitem><listitem><computeroutput>businessState</computeroutput> </listitem></itemizedlist> <parameterlist kind=\"param\"><li> <parameternamelist> <parametername>acls</parametername> </parameternamelist> <parameterdescription> A list of URL-parameter style key/value pairs where each key corresponds to one user profile detail and each value refers to its visibility. A simple example would be <computeroutput>\"gender=1&birthday=3&photo=1\"</computeroutput> which would set the gender to be public, the birthday to be controlled by fine grained ACLs, and the photo to be public, too. The visibility value can be one of the following:<itemizedlist> <listitem><computeroutput>1</computeroutput> - The detail is public</listitem><listitem><computeroutput>2</computeroutput> - The detail is controlled by ACLs. See also acl.rule.new().</listitem><listitem><computeroutput>3</computeroutput> - The detail is private</listitem></itemizedlist> </parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga5f8c2e15e08364057455246a9a6aa907\">user.acl.info()</ref></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/user.acl.update?user_name=demo&password_hash=49e473da03fbd296f05b5f0bf1f3301b5e4a67fc&acls=gender%3D1%26birthday%3D3%26photo%3D1\" HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Wed, 18 Apr 2012 09:07:25 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 57 <result><code>1</code><message>Success</message></result> </pre><simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Change the user profile detail privacy settings. " ; oplwebsrv:hasParameter <#action_user.acl.update_#_acls> . <#action_user.acl.update_#_acls> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "acls" ; schema:name "acls" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "A list of URL-parameter style key/value pairs where each key corresponds to one user profile detail and each value refers to its visibility. A simple example would be <computeroutput>\"gender=1&birthday=3&photo=1\"</computeroutput> which would set the gender to be public, the birthday to be controlled by fine grained ACLs, and the photo to be public, too. The visibility value can be one of the following:<itemizedlist> <listitem><computeroutput>1</computeroutput> - The detail is public</listitem><listitem><computeroutput>2</computeroutput> - The detail is controlled by ACLs. See also acl.rule.new().</listitem><listitem><computeroutput>3</computeroutput> - The detail is private</listitem></itemizedlist> " . <#action_850598d36e8fe9bf877d750bc98c31cc> a schema:Action ; schema:name "user_annotation_delete" ; schema:target <#action_user.annotation.delete> . <#action_user.annotation.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_annotation_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.annotation.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.annotation.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.annotation.delete_#_claimIri> , <#action_user.annotation.delete_#_claimRelation> , <#action_user.annotation.delete_#_claimValue> . <#action_user.annotation.delete_#_claimIri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "claimIri" ; schema:name "claimIri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.annotation.delete_#_claimRelation> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "claimRelation" ; schema:name "claimRelation" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.annotation.delete_#_claimValue> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "claimValue" ; schema:name "claimValue" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_3eb2b86aceaaea30e381a1c6fc839452> a schema:Action ; schema:name "user_annotation_new" ; schema:target <#action_user.annotation.new> . <#action_user.annotation.new> a schema:EntryPoint ; schema:name "EntryPoint - user_annotation_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.annotation.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.annotation.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.annotation.new_#_claimIri> , <#action_user.annotation.new_#_claimRelation> , <#action_user.annotation.new_#_claimValue> . <#action_user.annotation.new_#_claimIri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "claimIri" ; schema:name "claimIri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.annotation.new_#_claimRelation> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "claimRelation" ; schema:name "claimRelation" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.annotation.new_#_claimValue> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "claimValue" ; schema:name "claimValue" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_6238a5b780bc6a2811d977bfdc2a9f96> a schema:Action ; schema:name "user_authenticate" ; schema:target <#action_user.authenticate> . <#action_user.authenticate> a schema:EntryPoint ; schema:name "EntryPoint - user_authenticate" ; schema:url <https://vos.openlinksw.com/ods/api/user.authenticate> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.authenticate> ; schema:description "ODS supports a variety of authentication methods. The most common way of operation for a client is to obtain a session ID and use it in subsequent calls to the API as described in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>. Session IDs are obtained in one of the following ways. This method allows to authenticate via classical user digest information (user name and password). Authentication through third-party services is handled by <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>. <ref kindref=\"member\" refid=\"group__ods__module__user_1ga974f604be99696e368122af579e4a670\">user.authenticate.webid()</ref> handles WebiD (X.509 client SSL certificate authentication). In contrast to the other methods <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> will return a URL the client needs to navigate the user to in order to complete the authentication. The other methods will return a session ID.A session will timeout after being unused for half an hour.<sect1 id=\"group__ods__module__user_1ods_user_authenticate_password\"> <title>Authentication via Password Hash</title> When authenticating via password hashes parameters <computeroutput>user_name</computeroutput> and <computeroutput>password_hash</computeroutput> need to be specified. The password hash uses the <emphasis>sha1</emphasis> digest algorithm and includes both the user name and the password.This can be created via openssl or any sha1 tool available in the environment of the client: <programlisting><codeline><highlight class=\"preprocessor\"><sp />#<sp />echo<sp />-n<sp />\"demofoobar\"<sp />|<sp />openssl<sp />dgst<sp />-sha1</highlight></codeline> <codeline><highlight class=\"preprocessor\"><sp />#<sp />echo<sp />-n<sp />\"demofoobar\"<sp />|<sp />sha1sum</highlight></codeline> </programlisting><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>user_name</parametername> </parameternamelist> <parameterdescription> The user name of the account created via <ref kindref=\"member\" refid=\"group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825\">user.register()</ref>. If specified <computeroutput>password_hash</computeroutput> also needs to be provided. </parameterdescription> </li> <li> <parameternamelist> <parametername>password_hash</parametername> </parameternamelist> <parameterdescription> The password hash as explained in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_password_hash\">Password Hash Authentication</ref>. Mandatory if <computeroutput>user_name</computeroutput> is specified. </parameterdescription> </li> <li> <parameternamelist> <parametername>facebookUID</parametername> </parameternamelist> <parameterdescription> Deprecated Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> for Facebook login. </parameterdescription> </li> <li> <parameternamelist> <parametername>openIdUrl</parametername> </parameternamelist> <parameterdescription> Deprecated Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> for OpenID login. </parameterdescription> </li> <li> <parameternamelist> <parametername>openIdIdentity</parametername> </parameternamelist> <parameterdescription> Deprecated Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> for OpenID login. </parameterdescription> </li> <li> <parameternamelist> <parametername>oauthMode</parametername> </parameternamelist> <parameterdescription> Deprecated Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> for OAuth login. </parameterdescription> </li> <li> <parameternamelist> <parametername>oauthSid</parametername> </parameternamelist> <parameterdescription> Deprecated Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> for OAuth login. </parameterdescription> </li> <li> <parameternamelist> <parametername>oauthVerifier</parametername> </parameternamelist> <parameterdescription> Deprecated Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> for OAuth login. </parameterdescription> </li> <li> <parameternamelist> <parametername>oauthToken</parametername> </parameternamelist> <parameterdescription> Deprecated Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> for OAuth login.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An XML stream containing the session id of the newly created session. This session id can then be used to authenticate other method calls as explained in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>. For an example of a user session object see <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_user_session_example\">Example User Session:</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_oauth\">Authentication via OAuth</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1ga974f604be99696e368122af579e4a670\">user.authenticate.webid()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/user.authenticate?user_name=demo&password_hash=49e473da03fbc286f06b5f0bf1f3301b5e4a67fd\" HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Tue, 17 Apr 2012 09:31:34 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 114 <userSession> <sid>1de236f5da2f32d92e8c0cce5053a96e</sid> <user> <uname>demo</uname> <uid>127</uid> <new>0</new> <dba>0</dba> </user> </userSession> </pre><simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> </sect1>" ; schema:shortDescription "Start a new user session via user digest information. " ; oplwebsrv:hasParameter <#action_user.authenticate_#_user_name> , <#action_user.authenticate_#_password_hash> , <#action_user.authenticate_#_facebookUID> , <#action_user.authenticate_#_openIdUrl> , <#action_user.authenticate_#_openIdIdentity> , <#action_user.authenticate_#_oauthMode> , <#action_user.authenticate_#_oauthSid> , <#action_user.authenticate_#_oauthVerifier> , <#action_user.authenticate_#_oauthToken> . <#action_user.authenticate_#_user_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "user_name" ; schema:name "user_name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_password_hash> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "password_hash" ; schema:name "password_hash" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_facebookUID> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "facebookUID" ; schema:name "facebookUID" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_openIdUrl> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "openIdUrl" ; schema:name "openIdUrl" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_openIdIdentity> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "openIdIdentity" ; schema:name "openIdIdentity" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_oauthMode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauthMode" ; schema:name "oauthMode" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_oauthSid> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauthSid" ; schema:name "oauthSid" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_oauthVerifier> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauthVerifier" ; schema:name "oauthVerifier" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate_#_oauthToken> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauthToken" ; schema:name "oauthToken" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_d6f02a38ce0b890ad56c35888e33eed8> a schema:Action ; schema:name "user_authenticate_authenticationUrl" ; schema:target <#action_user.authenticate.authenticationUrl> . <#action_user.authenticate.authenticationUrl> a schema:EntryPoint ; schema:name "EntryPoint - user_authenticate_authenticationUrl" ; schema:url <https://vos.openlinksw.com/ods/api/user.authenticate.authenticationUrl> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.authenticate.authenticationUrl> ; schema:description "ODS supports a variety of third-party services for login and registration including Twitter, Facebook, or Google. ODS clients can use this method to easily expose this functionality to their users. Clients can either start authentication, registration or the connection of an ODS account with a third-party service account.<sect1 id=\"group__ods__module__user_1ods_authentication_url_workflow\"> <title>Client Workflow</title> The workflow for a client is always the same irrespective of the service type:<orderedlist> <listitem>The client requests an authentication URL via this method, specifying the <computeroutput>service</computeroutput> type (see below for <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref>, the <computeroutput>action</computeroutput> to take, and a callback URL.</listitem><listitem>The client navigates to the returned URL allowing the user to authenticate with the 3rd party service.</listitem><listitem>The 3rd party service redirects to ODS which concludes the action and performs the final redirect to the <computeroutput>callback</computeroutput> URL provided by the client. The <computeroutput>callback</computeroutput> URL contains one the following:<orderedlist> <listitem>A new ODS session ID in the <computeroutput>userSession.sid</computeroutput> parameter and a flag (<computeroutput>0</computeroutput> or <computeroutput>1</computeroutput>) to indicate if a new account has been registered <computeroutput>user.new</computeroutput>. See also <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>.</listitem><listitem>An authentication confirmation session consisting of the parameters <computeroutput>confirmSession.cid</computeroutput>, <computeroutput>confirmSession.reason.code</computeroutput>, <computeroutput>confirmSession.reason.msg</computeroutput>, <computeroutput>user.name</computeroutput>, <computeroutput>user.email</computeroutput>, <computeroutput>onlineAccount.service</computeroutput>, and <computeroutput>onlineAccount.uid</computeroutput>. See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_confirm\">Authentication Confirmation Mode</ref> for details.</listitem><listitem>In the case of a workflow error an error messages in the <computeroutput>error.msg</computeroutput> parameter. Errors include such conditions as a failed 3rd party service authentication or a missing detail in the profile for registration (ODS for example requires an email address for account creation).</listitem></orderedlist> </listitem></orderedlist> Clients can use <ref kindref=\"member\" refid=\"group__ods__module__misc_1ga694da38279997cafbe2f2012dfe30c47\">server.getInfo()</ref> to retrieve the enabled services. A service is available if it is enabled in the ODS configuration (all are enabled by default) and if the ODS instance contains an application ID. Application IDs are typically created through the third-party service's web interface and can be added by the ODS administrator via <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>. (See below for links to the respective admin pages and the required callback links.)For security reasons the <computeroutput>callback</computeroutput> URL needs to match one of the configures clients URLs. See <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga675af873f023acb812a8d7694a1d3b9f\">admin.clients.new()</ref> for details.</sect1> <sect1 id=\"group__ods__module__user_1ods_authentication_url_action\"> <title>Authentication Action Types</title> Clients can initiate three different types of actions revolving around third-party service accounts with this methods. The actions are as follows:<itemizedlist> <listitem><computeroutput>authenticate</computeroutput> A basic authentication workflow which, if succesful results in the client being authenticated with the ODS account which is connected to the 3rd-party service account the user logged into.</listitem><listitem><computeroutput>register</computeroutput> The creation of a new ODS account which will be connected to the 3rd-party service account the user logged into. The new ODS account will have a random password set which can later be changed via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965\">user.password.change()</ref> to allow authentication with classical username digest information. Should the 3rd-party service not provide enough information to create an account, ODS will continue based on the value of <computeroutput>confirm</computeroutput> as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_confirm\">Authentication Confirmation Mode</ref>.</listitem><listitem><computeroutput>connect</computeroutput> Connect an existing ODS account with a third-party service account.</listitem><listitem><computeroutput>auto</computeroutput> In automatic mode ODS tries to choose the best fitting action. Should an ODS account be connected to the 3rd-party service account the user logged into <computeroutput>authenticate</computeroutput> will be chosen. Otherwise ODS will try to create a new account like with <computeroutput>register</computeroutput> (Should the 3rd-party service not provide enough information to create an account, ODS will continue based on the value of <computeroutput>confirm</computeroutput> as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_confirm\">Authentication Confirmation Mode</ref>). Should the client provide authentication information according to <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> ODS will try to connect the 3rd-party service account the user logged into with the authenticated ODS account.</listitem></itemizedlist> </sect1> <sect1 id=\"group__ods__module__user_1ods_authentication_url_confirm\"> <title>Authentication Confirmation Mode</title> ODS allows to create accounts by simply connecting them to third-party online accounts. Clients can either ask the user to confirm the creation of the new account or have it done automatically. ODS supports three modes for registration confirmation:<itemizedlist> <listitem><computeroutput>always</computeroutput> ODS will always ask the client to confirm the creation of the new account.</listitem><listitem><computeroutput>never</computeroutput> ODS will never ask the client for confirmation. If certain details like the email are missing for account creation it will simply fail.</listitem><listitem><computeroutput>auto</computeroutput> ODS will decide based on the available profile detail. If both username and email address are available, valid, and not yet in user the new account will be created without confirmation. Otherwise ODS will request confirmation through a confirmation session.</listitem></itemizedlist> A verified and completed confirmation request can be confirmed to create the final account via <ref kindref=\"member\" refid=\"group__ods__module__user_1gae57c8caea0f528b4fedf05cb34656540\">user.authenticate.confirm()</ref>.</sect1> <sect1 id=\"group__ods__module__user_1ods_authentication_url_services\"> <title>Supported Services</title> ODS supports the following services for authentication and registration. Except for OpenID each service uses one flavor of OAuth and requires a client ID and secret to be registered with ODS. Client IDs are managed via <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga92ef7d74e1103210380902488e90e2a7\">admin.apikeys.new()</ref>. (An easy way to install new client keys is via the <ref kindref=\"compound\" refid=\"ods_console\">ODS Console</ref> which can easily be installed on any instance of Virtuoso running ODS.)Most services require that a callback URL is stored with the client ID. The following list contains details on the values to add for ODS. Keep in mind that both ODS and Virtuoso support OAuth workflows in other situations like Briefcase external web drive mounting. These use different callback URLs which needs to be taken into account when configuring certain services like Google.<itemizedlist> <listitem><computeroutput>facebook</computeroutput> - Create a login link for Facebook. Client IDs (App ID/API key and App Secret) can be created at <ulink url=\"https://developers.facebook.com/apps\">https://developers.facebook.com/apps</ulink> . The Facebook client app should be configured as \"Website with Facebook login\" with a site URL matching the host of the ODS installation. Example: if ODS runs at <computeroutput><ulink url=\"http://myhost.com/ods/api\">http://myhost.com/ods/api</ulink></computeroutput> then the URL in the Facebook app should be <computeroutput><ulink url=\"http://myhost.com/\">http://myhost.com/</ulink></computeroutput> or <computeroutput><ulink url=\"https://myhost.com/\">https://myhost.com/</ulink></computeroutput> if SSL endpoints have been configured.</listitem><listitem><computeroutput>google</computeroutput> - Create a login link for Google. Client ID and Client secret can be created at <ulink url=\"https://code.google.com/apis/console/\">https://code.google.com/apis/console/</ulink> under \"API Access\". The redirect urls need to contain <computeroutput>http[s]://HOST[:PORT]/val/api/thirdparty_callback</computeroutput> (an https URL when ODS SSL endpoints have been configured).</listitem><listitem><computeroutput>twitter</computeroutput> - Create a login link for Twitter. Consumer key and secret can be created at <ulink url=\"https://dev.twitter.com/apps\">https://dev.twitter.com/apps</ulink> . The Twitter Callback URL should be set to the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>linkedin</computeroutput> - Create a login link for LinkedIn. OAuth User Token and Secret can be created at <ulink url=\"https://www.linkedin.com/secure/developer\">https://www.linkedin.com/secure/developer</ulink> . There is no need to specify a callback URL.</listitem><listitem><computeroutput>windowslive</computeroutput> - Create a login link for Windows Live. Client ID and secret can be created at <ulink url=\"https://account.live.com/developers/applications\">https://account.live.com/developers/applications</ulink> . The redirect urls need to contain <computeroutput>http[s]://HOST[:PORT]/val/api/thirdparty_callback</computeroutput> (an https URL when ODS SSL endpoints have been configured).</listitem><listitem><computeroutput>wordpress</computeroutput> - Create a login link for Wordpress. Client ID and Secret can be created at <ulink url=\"https://developer.wordpress.com/apps/\">https://developer.wordpress.com/apps/</ulink> . The redirect URL of the configured OAuth application needs to match the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>yahoo</computeroutput> - Create a login link for Yahoo. Consumer key and secret can be created at <ulink url=\"https://developer.apps.yahoo.com/dashboard/createKey.html.\">https://developer.apps.yahoo.com/dashboard/createKey.html.</ulink> The application needs a Web-based one with access to private user data: read/write permissions for the <emphasis>Social Directory</emphasis> scope. The application domain needs to match the domain of the ODS installation. Example: if ODS runs at <computeroutput><ulink url=\"http://myhost.com/ods/api\">http://myhost.com/ods/api</ulink></computeroutput> then the domain should be <computeroutput><ulink url=\"http://myhost.com/\">http://myhost.com/</ulink></computeroutput>.</listitem><listitem><computeroutput>tumblr</computeroutput> - Create a login link for Tumblr. OAuth Consumer Key and Secret Key can be created at <ulink url=\"http://www.tumblr.com/oauth/apps\">http://www.tumblr.com/oauth/apps</ulink> . The redirect URL of the configured OAuth application needs to match the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>disqus</computeroutput> - Create a login link for Disqus. Public Key and Secret Key can be created at <ulink url=\"http://disqus.com/api/applications/.\">http://disqus.com/api/applications/.</ulink> ODS only requires the created application to have read access. The redirect URL of the configured OAuth application needs to match the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>instagram</computeroutput> - Create a login link for Instagram. Client IDs including API key and secret can be created at <ulink url=\"http://instagram.com/developer/clients/manage/\">http://instagram.com/developer/clients/manage/</ulink> . The redirect uri needs to be <computeroutput>http[s]://HOST[:PORT]/val/api/thirdparty_callback</computeroutput> (an https URL when ODS SSL endpoints have been configured).</listitem><listitem><computeroutput>bitly</computeroutput> - Create a login link for Bitly. Client ID and Secret can be created at <ulink url=\"https://bitly.com/a/oauth_apps\">https://bitly.com/a/oauth_apps</ulink> by registering an OAuth 2 application. The application link should be set to the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>foursquare</computeroutput> - Create a login link for Foursquare. Client ID and Client Secret can be created at <ulink url=\"https://foursquare.com/developers/apps\">https://foursquare.com/developers/apps</ulink> . The application link should be set to the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>dropbox</computeroutput> - Create a login link for DropBox. App key and app secret can be created at <ulink url=\"https://www.dropbox.com/developers/apps\">https://www.dropbox.com/developers/apps</ulink> . No callback URL needs to be configured.</listitem><listitem><computeroutput>github</computeroutput> - Create a login link for GitHub. Client ID and secret can be created at <ulink url=\"https://github.com/settings/applications/new\">https://github.com/settings/applications/new</ulink> . The callback URL should be set to the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>meetup</computeroutput> - Create a login link for MeetUp. Key and Secret can be created at <ulink url=\"http://www.meetup.com/meetup_api/oauth_consumers/create/\">http://www.meetup.com/meetup_api/oauth_consumers/create/</ulink> . The callback URL should be set to the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example. There is no need to set a revocation URL.</listitem><listitem><computeroutput>flickr</computeroutput> - Create a login link for Flickr. Key and Secret can be created at <ulink url=\"http://www.flickr.com/services/apps\">http://www.flickr.com/services/apps</ulink> . There is no need to configure a callback URL.</listitem><listitem><computeroutput>salesforce</computeroutput> - Create a login link for SalesForce. Client IDs including API key and secret can be created by logging into <ulink url=\"http://salesforce.com/\">http://salesforce.com/</ulink> and navigating to Setup | Develop | Remote Access. The callback URL needs to be <computeroutput><ulink url=\"https://myhost.com/val/api/thirdparty_callback\">https://myhost.com/val/api/thirdparty_callback</ulink></computeroutput> where <computeroutput>myhost.com</computeroutput> refers to the client's actual host. Salesforce requires the callback URL to be an https URL. Thus, in order to use it the instance of Virtuoso requires setting up an SSL-protected virtual host for /val/api. <bold>Caution:</bold> Settings on Salesforce remote access may take several minutes to take effect.</listitem><listitem><computeroutput>boxnet</computeroutput> - Create a login link for Box.NET. OAuth2 client_id and client_secret can be created at <ulink url=\"https://www.box.com/developers/services/edit/\">https://www.box.com/developers/services/edit/</ulink> . The redirect_uri should be set to the host of the ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem><listitem><computeroutput>xing</computeroutput> - Create a login link for Xing. An OAuth consumer key and secret can be created by visiting <ulink url=\"http://dev.xing.com\">http://dev.xing.com</ulink> and following the steps after clicking \"Register your app\".</listitem><listitem><computeroutput>amazon</computeroutput> - Create a login link for Amazon. OAuth Client ID and Secret can be created by visiting <ulink url=\"https://login.amazon.com/manageApps\">https://login.amazon.com/manageApps</ulink> and setting up an account to create a new application. The <emphasis>Allowed Return URLs</emphasis> should contain the full callback URL as used by ODS: <computeroutput>http[s]://HOST[:PORT]/val/api/thirdparty_callback</computeroutput> (an https URL when ODS SSL endpoints have been configured).</listitem><listitem><computeroutput>soundcloud</computeroutput> Create a login link for SoundCloud. OAuth Client ID and Secret can be created at <ulink url=\"http://soundcloud.com/you/apps\">http://soundcloud.com/you/apps</ulink> . The redirect uri needs to be <computeroutput>http[s]://HOST[:PORT]/val/api/thirdparty_callback</computeroutput> (an https URL when ODS SSL endpoints have been configured).</listitem><listitem><computeroutput>beatport</computeroutput> - Create a login link for Beatport. OAuth API Key and Secret an be created at <ulink url=\"https://accounts.beatport.com/developer/request-api-key\">https://accounts.beatport.com/developer/request-api-key</ulink> . The provided values are not important.</listitem><listitem><computeroutput>spotify</computeroutput> - Create a login link for Spotify. OAuth Client ID and Secret can be created at <ulink url=\"https://developer.spotify.com/my-applications\">https://developer.spotify.com/my-applications</ulink> . Add a Redirect URI value of <computeroutput>http[s]://HOST[:PORT]/val/api/thirdparty_callback</computeroutput> (an https URL when ODS SSL endpoints have been configured).</listitem><listitem><computeroutput>paypal</computeroutput> - Create a login link for PayPal. OAuth Client ID and Secret can be created at <ulink url=\"https://developer.paypal.com/webapps/developer/applications/myapps\">https://developer.paypal.com/webapps/developer/applications/myapps</ulink> . The redirect uri needs to be <computeroutput>http[s]://HOST[:PORT]/val/api/thirdparty_callback</computeroutput> (an https URL when ODS SSL endpoints have been configured).</listitem><listitem><computeroutput>openid</computeroutput> - (The actual OpenID is specified in <computeroutput>data</computeroutput>)</listitem><listitem><computeroutput>webid</computeroutput> - Authenticate via WebID. The method will return an https URL which requests a client certificate.</listitem><listitem>Any ODS instances which has been installed as OAuth provider via <ref kindref=\"member\" refid=\"group__ods__module__admin_1gafb92fea83f401240d25d502c48d8acab\">admin.oauth.odshosts.new()</ref> can also be used here. API Key and API Secret can be created at <ulink url=\"http://HOST/oauth/oauth_apps.vspx\">http://HOST/oauth/oauth_apps.vspx</ulink> where <computeroutput>HOST</computeroutput> matches the configured ODS instances hostname. The callback URL should be set to the host of the client ODS installation. See <computeroutput>facebook</computeroutput> above for an example.</listitem></itemizedlist> <parameterlist kind=\"param\"><li> <parameternamelist> <parametername>service</parametername> </parameternamelist> <parameterdescription> The type of service to authenticate with. See the list above for <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref>. An example would be <computeroutput>google</computeroutput>. Available and enabled (ODS allows to disable certain services for login or registration) can be retrieved via <ref kindref=\"member\" refid=\"group__ods__module__misc_1ga694da38279997cafbe2f2012dfe30c47\">server.getInfo()</ref>. Here it is important to skip the service types that are handled by other functions - namely <computeroutput>digest</computeroutput> (handled by <ref kindref=\"member\" refid=\"group__ods__module__user_1ga6238a5b780bc6a2811d977bfdc2a9f96\">user.authenticate()</ref>). </parameterdescription> </li> <li> <parameternamelist> <parametername>callback</parametername> </parameternamelist> <parameterdescription> The client callback URL. Once the login is complete the user will be redirected here. ODS will add parameters to the URL as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_workflow\">Client Workflow</ref>. </parameterdescription> </li> <li> <parameternamelist> <parametername>action</parametername> </parameternamelist> <parameterdescription> The action that should be taken. Can be one of <computeroutput>authenticate</computeroutput>, <computeroutput>register</computeroutput>, <computeroutput>connect</computeroutput>, or <computeroutput>auto</computeroutput>. See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_action\">Authentication Action Types</ref> for details. </parameterdescription> </li> <li> <parameternamelist> <parametername>confirm</parametername> </parameternamelist> <parameterdescription> The confirmation mode. Can be one of <computeroutput>always</computeroutput>, <computeroutput>never</computeroutput>, or <computeroutput>auto</computeroutput>. See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_confirm\">Authentication Confirmation Mode</ref> for details. </parameterdescription> </li> <li> <parameternamelist> <parametername>data</parametername> </parameternamelist> <parameterdescription> Optional data only required for <computeroutput>openid</computeroutput> login. </parameterdescription> </li> <li> <parameternamelist> <parametername>scope</parametername> </parameternamelist> <parameterdescription> The scope of the authentication. ODS currently supports three meta-scopes which are mapped to the service-dependent scope values if applicable. The scopes can also be combined by comma-separation.<itemizedlist> <listitem><computeroutput>basic</computeroutput> - This will just request basic profile information like username and email</listitem><listitem><computeroutput>profile</computeroutput> - This will request read access to the full profile including friend lists, posts, etc.</listitem><listitem><computeroutput>dav</computeroutput> - This will request read/write access to a service's filesystem (GDrive, DropBox, etc.) </listitem></itemizedlist> </parameterdescription> </li> <li> <parameternamelist> <parametername>client_ip</parametername> </parameternamelist> <parameterdescription> The IP address of the authenticated client. Normally there is no need to specify this since ODS will simply determine it. However, if the ODS instance is hidden behind a proxy this is required since otherwise OAuth authentication with certain services will fail.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A URL pointing to the third-party's login page which will result in a redirection to ODS. Clients need to point their users to this URL. In the case of an error like missing input or a disabled service this method will return with a 4xx HTTP error code.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga6238a5b780bc6a2811d977bfdc2a9f96\">user.authenticate()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1ga974f604be99696e368122af579e4a670\">user.authenticate.webid()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function will provide additional information if authentication via one of the supported methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> is used. </simplesect> </sect1>" ; schema:shortDescription "Create an authentication URL to log into or register with ODS through a third party service or WebID. " ; oplwebsrv:hasParameter <#action_user.authenticate.authenticationUrl_#_service> , <#action_user.authenticate.authenticationUrl_#_callback> , <#action_user.authenticate.authenticationUrl_#_action> , <#action_user.authenticate.authenticationUrl_#_confirm> , <#action_user.authenticate.authenticationUrl_#_data> , <#action_user.authenticate.authenticationUrl_#_scope> , <#action_user.authenticate.authenticationUrl_#_client_ip> . <#action_user.authenticate.authenticationUrl_#_service> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "service" ; schema:name "service" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate.authenticationUrl_#_callback> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "callback" ; schema:name "callback" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate.authenticationUrl_#_action> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "action" ; schema:name "action" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "authenticate" . <#action_user.authenticate.authenticationUrl_#_confirm> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "confirm" ; schema:name "confirm" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "auto" . <#action_user.authenticate.authenticationUrl_#_data> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "data" ; schema:name "data" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.authenticate.authenticationUrl_#_scope> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "scope" ; schema:name "scope" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "basic" . <#action_user.authenticate.authenticationUrl_#_client_ip> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "client_ip" ; schema:name "client_ip" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_e57c8caea0f528b4fedf05cb34656540> a schema:Action ; schema:name "user_authenticate_confirm" ; schema:target <#action_user.authenticate.confirm> . <#action_user.authenticate.confirm> a schema:EntryPoint ; schema:name "EntryPoint - user_authenticate_confirm" ; schema:url <https://vos.openlinksw.com/ods/api/user.authenticate.confirm> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.authenticate.confirm> ; schema:description "Whenever ODS creates an authentication confirmation request as a result to a call to <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> or <ref kindref=\"member\" refid=\"group__ods__module__user_1ga974f604be99696e368122af579e4a670\">user.authenticate.webid()</ref> this method can be used to complete the authentication and create the final account with the verified profile details.If this method is called with authentication credentials as detailed in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> it will not create a new user account. Instead it will connect the 3rd-party serivce id from the confirmation session to the authenticated account.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cid</parametername> </parameternamelist> <parameterdescription> The confirmation session ID. </parameterdescription> </li> <li> <parameternamelist> <parametername>username</parametername> </parameternamelist> <parameterdescription> The username as verified and optionally changed by the user. Will only be used in confirmation mode, when called without user authentication. </parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> The email as verified and optionally changed by the user. Will only be used in confirmation mode, when called without user authentication.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A user session object as details in <ref kindref=\"member\" refid=\"group__ods__module__user_1ga974f604be99696e368122af579e4a670\">user.authenticate.webid()</ref> in the case of success. In the case of an error a code as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref> is returned.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function will provide additional information if authentication via one of the supported methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> is used. </simplesect> " ; schema:shortDescription "Confirm an authentication confirmation request. " ; oplwebsrv:hasParameter <#action_user.authenticate.confirm_#_cid> , <#action_user.authenticate.confirm_#_username> , <#action_user.authenticate.confirm_#_email> . <#action_user.authenticate.confirm_#_cid> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cid" ; schema:name "cid" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The confirmation session ID. " . <#action_user.authenticate.confirm_#_username> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "username" ; schema:name "username" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The username as verified and optionally changed by the user. Will only be used in confirmation mode, when called without user authentication. " . <#action_user.authenticate.confirm_#_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "email" ; schema:name "email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The email as verified and optionally changed by the user. Will only be used in confirmation mode, when called without user authentication." . <#action_974f604be99696e368122af579e4a670> a schema:Action ; schema:name "user_authenticate_webid" ; schema:target <#action_user.authenticate.webid> . <#action_user.authenticate.webid> a schema:EntryPoint ; schema:name "EntryPoint - user_authenticate_webid" ; schema:url <https://vos.openlinksw.com/ods/api/user.authenticate.webid> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.authenticate.webid> ; schema:description "This method represents the ODS support for WebID authentiction. It can be used to connect an ODS account to a WebID, to register a new ODS account using a WebID, or to authenticate a user via their WebID. In addition ODS supports X.509 certificates without an embedded WebID.Clients need to call this method through an SSL connection providing the X.509 client certifcate which should be used for authentication, registration, or to connect to an account. In the case of account connection the user need to authenticate themselves in addition to providing the certificate. Any of the supported ways can be used except for the certificate itself. Typically clients will use a session ID. See <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> for details.VSP or PHP clients that do not have access to the client certifcate's private key can use <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> with a <computeroutput>service</computeroutput> values of <computeroutput>webid</computeroutput>.<sect1 id=\"group__ods__module__user_1ods_user_authenticate_web_storage\"> <title>WebID Storage</title> WedIDs will be stored like other 3rd party online accounts as handled by <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>. As such they are listed via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga74edeb21c990ffa4d8e554fd8dd13eff\">user.onlineAccounts.list()</ref> with service type <computeroutput>\"webid\"</computeroutput> and a <computeroutput>uri</computeroutput> that is the actual WebID.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>action</parametername> </parameternamelist> <parameterdescription> The action to perform. See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_action\">Authentication Action Types</ref> for details on the supported actions. </parameterdescription> </li> <li> <parameternamelist> <parametername>confirm</parametername> </parameternamelist> <parameterdescription> The confirmation mode. See <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_confirm\">Authentication Confirmation Mode</ref> for details on the supported modes.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A valid ODS session or the confirmation session encoded as an XML stream. In case the client authenticated with a session ID for the <computeroutput>connect</computeroutput> action this session ID will be returned.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga6238a5b780bc6a2811d977bfdc2a9f96\">user.authenticate()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref></simplesect> </sect1> <sect1 id=\"group__ods__module__user_1ods_user_session_example\"> <title>Example User Session:</title> The user session object contains:<itemizedlist> <listitem>The session ID <computeroutput>sid</computeroutput> </listitem><listitem>The user with username <computeroutput>uname</computeroutput>, the internal numerical <computeroutput>uid</computeroutput>, and two flags:<itemizedlist> <listitem><computeroutput>dba</computeroutput> indicates if the user is the dba user, ie. has administrator privileges.</listitem><listitem><computeroutput>new</computeroutput> indicates if this user has been newly registered. This is useful for client to show some welcome message or the like.</listitem></itemizedlist> </listitem></itemizedlist> <pre> <userSession> <sid>1de236f5da2f32d92e8c0cce5053a96e</sid> <user> <uname>demo</uname> <uid>127</uid> <new>0</new> <dba>0</dba> </user> </userSession> </pre></sect1> <sect1 id=\"group__ods__module__user_1ods_auth_confirmation_session_example\"> <title>Example Confirmation Session:</title> <pre> <confirmSession> <cid></cid> <user> <name></name> <email></email> </user> <onlineAccount> <service>webid</service> <uid></uid> </onlineAccount> <reason> <code>invalid_username</code> <msg>The login name contains invalid characters</msg> </reason> </confirmSession> </pre><simplesect kind=\"par\"><title>Authentication</title>This function will provide additional information if authentication via one of the supported methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> is used. </simplesect> </sect1>" ; schema:shortDescription "Authenticate with, register with, or connect a WebID. " ; oplwebsrv:hasParameter <#action_user.authenticate.webid_#_action> , <#action_user.authenticate.webid_#_confirm> . <#action_user.authenticate.webid_#_action> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "action" ; schema:name "action" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "authenticate" . <#action_user.authenticate.webid_#_confirm> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "confirm" ; schema:name "confirm" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "auto" . <#action_c4a44364bb01b5a6190ee9891d396c94> a schema:Action ; schema:name "user_bioEvents_delete" ; schema:target <#action_user.bioEvents.delete> . <#action_user.bioEvents.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_bioEvents_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.bioEvents.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.bioEvents.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.bioEvents.delete_#_id> , <#action_user.bioEvents.delete_#_event> , <#action_user.bioEvents.delete_#_date> , <#action_user.bioEvents.delete_#_place> . <#action_user.bioEvents.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.bioEvents.delete_#_event> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "event" ; schema:name "event" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.bioEvents.delete_#_date> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "date" ; schema:name "date" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.bioEvents.delete_#_place> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "place" ; schema:name "place" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_12318092617414e4bf46cf26a5444995> a schema:Action ; schema:name "user_bioEvents_list" ; schema:target <#action_user.bioEvents.list> . <#action_user.bioEvents.list> a schema:EntryPoint ; schema:name "EntryPoint - user_bioEvents_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.bioEvents.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.bioEvents.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" . <#action_20aface7d78e43a59e18321ba68b3b25> a schema:Action ; schema:name "user_bioEvents_new" ; schema:target <#action_user.bioEvents.new> . <#action_user.bioEvents.new> a schema:EntryPoint ; schema:name "EntryPoint - user_bioEvents_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.bioEvents.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.bioEvents.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.bioEvents.new_#_event> , <#action_user.bioEvents.new_#_date> , <#action_user.bioEvents.new_#_place> . <#action_user.bioEvents.new_#_event> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "event" ; schema:name "event" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.bioEvents.new_#_date> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "date" ; schema:name "date" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.bioEvents.new_#_place> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "place" ; schema:name "place" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_0ee2110be2d0c0557a63715de1828a21> a schema:Action ; schema:name "user_certificates_create" ; schema:target <#action_user.certificates.create> . <#action_user.certificates.create> a schema:EntryPoint ; schema:name "EntryPoint - user_certificates_create" ; schema:url <https://vos.openlinksw.com/ods/api/user.certificates.create> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.certificates.create> ; schema:description "ODS is a full-featured WebID server and supports authentication via WebID in all situations. Clients can easily create new WebID certificates via this method.WebID authentication means that the client sends an X.509 certificate with an embedded profile URL denoting the authenticating person. That URL resolves to an RDF profile document containing the public key from the certificate.The simplest way to create a new WebID-enabled X.509 certificate is for the client to use the <computeroutput>keygen</computeroutput> HTML tag to create a new RSA key pair. The public key will be sent to this method. ODS will then prepare the certifcate and return it to the client with mimetype <computeroutput>application/x-x509-user-cert</computeroutput>. The browser will install that certifcate in its key ring. It can then be used in suqsequent authentication actions with ODS or any other WebID enabled system.<bold>Example:</bold> The minimal HTML code to create a new client certificate looks like the following: <programlisting><codeline><highlight class=\"normal\"><sp />{.html}</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><form<sp />action=</highlight><highlight class=\"stringliteral\">\"/ods/api/user.certificates.create\"</highlight><highlight class=\"normal\">></highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><keygen<sp />name=</highlight><highlight class=\"stringliteral\">\"publicKey\"</highlight><highlight class=\"normal\"><sp />/></highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><input<sp />name=</highlight><highlight class=\"stringliteral\">\"sid\"</highlight><highlight class=\"normal\"><sp />type=</highlight><highlight class=\"stringliteral\">\"hidden\"</highlight><highlight class=\"normal\"><sp />value=</highlight><highlight class=\"stringliteral\">\"SID\"</highlight><highlight class=\"normal\"><sp />/></highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><input<sp />name=</highlight><highlight class=\"stringliteral\">\"realm\"</highlight><highlight class=\"normal\"><sp />type=</highlight><highlight class=\"stringliteral\">\"hidden\"</highlight><highlight class=\"normal\"><sp />value=</highlight><highlight class=\"stringliteral\">\"wa\"</highlight><highlight class=\"normal\"><sp />/></highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /><input<sp />type=</highlight><highlight class=\"stringliteral\">\"submit\"</highlight><highlight class=\"normal\"><sp />value=</highlight><highlight class=\"stringliteral\">\"Create<sp />Certificate\"</highlight><highlight class=\"normal\">/></highlight></codeline> <codeline><highlight class=\"normal\"><sp /></form></highlight></codeline> </programlisting>Here the <computeroutput>keygen</computeroutput> tag creates the key pair and makes sure that the public key is sent on form submission. The hidden <computeroutput>input</computeroutput> fields are required for <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>. The <computeroutput>realm</computeroutput> is fixed to <computeroutput>wa</computeroutput>, but the session id value <computeroutput>sid</computeroutput> needs to be provided by the client from a previous authentication. How this value is filled in depends on the programming language used to build the client.Instead of using <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref> via two hidden <computeroutput>input</computeroutput> fields clients could also use classical user digest credentials as detailed in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_password_hash\">Password Hash Authentication</ref>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>commonName</parametername> </parameternamelist> <parameterdescription> The optional common name used for the certificate. If omitted one will be built from the ODS user profile name and the ODS domain name. </parameterdescription> </li> <li> <parameternamelist> <parametername>country</parametername> </parameternamelist> <parameterdescription> The optional country used in the certificate. If omitted the value will be taken from the ODS user profile. </parameterdescription> </li> <li> <parameternamelist> <parametername>organization</parametername> </parameternamelist> <parameterdescription> The optional organization used in the certificate. If omitted the value will be taken from the ODS user profile. </parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> The optional email address used in the certificate. If omitted the value will be taken from the ODS user profile. Be aware That the created certificate can only be used to digitally sign emails if the email address matches. </parameterdescription> </li> <li> <parameternamelist> <parametername>expirationDays</parametername> </parameternamelist> <parameterdescription> The optional number of days this certificate should be valid. This defaults to 365 days, ie. one year. </parameterdescription> </li> <li> <parameternamelist> <parametername>expirationHours</parametername> </parameternamelist> <parameterdescription> The optional number of hours thsi certificate should be valid. This value will be added to the value of <computeroutput>expirationDays</computeroutput> and simply provides a means for a finer-grained expiration control. </parameterdescription> </li> <li> <parameternamelist> <parametername>publicKey</parametername> </parameternamelist> <parameterdescription> The mandatory public key in SPKI format.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The new X.509 certificate with mimetype <computeroutput>application/x-x509-user-cert</computeroutput> or an error code as defined in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>. On error an appropriate HTTP error code will be set in addition to a return value as described in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Create a new client certificate and accociate it with the authenticated user. " ; oplwebsrv:hasParameter <#action_user.certificates.create_#_commonName> , <#action_user.certificates.create_#_country> , <#action_user.certificates.create_#_organization> , <#action_user.certificates.create_#_email> , <#action_user.certificates.create_#_expirationDays> , <#action_user.certificates.create_#_expirationHours> , <#action_user.certificates.create_#_publicKey> . <#action_user.certificates.create_#_commonName> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "commonName" ; schema:name "commonName" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The optional common name used for the certificate. If omitted one will be built from the ODS user profile name and the ODS domain name. " . <#action_user.certificates.create_#_country> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "country" ; schema:name "country" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The optional country used in the certificate. If omitted the value will be taken from the ODS user profile. " . <#action_user.certificates.create_#_organization> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "organization" ; schema:name "organization" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The optional organization used in the certificate. If omitted the value will be taken from the ODS user profile. " . <#action_user.certificates.create_#_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "email" ; schema:name "email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The optional email address used in the certificate. If omitted the value will be taken from the ODS user profile. Be aware That the created certificate can only be used to digitally sign emails if the email address matches. " . <#action_user.certificates.create_#_expirationDays> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "expirationDays" ; schema:name "expirationDays" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The optional number of days this certificate should be valid. This defaults to 365 days, ie. one year. " . <#action_user.certificates.create_#_expirationHours> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "expirationHours" ; schema:name "expirationHours" ; # oplwebsrv:parameterType "float" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0.0" ; schema:description "The optional number of hours thsi certificate should be valid. This value will be added to the value of <computeroutput>expirationDays</computeroutput> and simply provides a means for a finer-grained expiration control. " . <#action_user.certificates.create_#_publicKey> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "publicKey" ; schema:name "publicKey" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The mandatory public key in SPKI format." . <#action_f3cdde03422b5229c1e0da88aecbbc02> a schema:Action ; schema:name "user_certificates_delete" ; schema:target <#action_user.certificates.delete> . <#action_user.certificates.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_certificates_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.certificates.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.certificates.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.certificates.delete_#_id> . <#action_user.certificates.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_807b4d5525d41c3e57153d16b63550b7> a schema:Action ; schema:name "user_certificates_edit" ; schema:target <#action_user.certificates.edit> . <#action_user.certificates.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_certificates_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.certificates.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.certificates.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.certificates.edit_#_id> , <#action_user.certificates.edit_#_certificate> , <#action_user.certificates.edit_#_enableLogin> . <#action_user.certificates.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.certificates.edit_#_certificate> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "certificate" ; schema:name "certificate" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.certificates.edit_#_enableLogin> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "enableLogin" ; schema:name "enableLogin" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_6d06a0c4234b65cdb32592109db723fb> a schema:Action ; schema:name "user_certificates_get" ; schema:target <#action_user.certificates.get> . <#action_user.certificates.get> a schema:EntryPoint ; schema:name "EntryPoint - user_certificates_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.certificates.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.certificates.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.certificates.get_#_id> . <#action_user.certificates.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_08433bad261e430d17a7e1c6243b0f1a> a schema:Action ; schema:name "user_certificates_list" ; schema:target <#action_user.certificates.list> . <#action_user.certificates.list> a schema:EntryPoint ; schema:name "EntryPoint - user_certificates_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.certificates.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.certificates.list> ; schema:description "An ODS account can contain an arbitrary number of certificates which can either be imported via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga2610d8c4c79df52949bdc7691550999c\">user.certificates.new()</ref> or be created via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga0ee2110be2d0c0557a63715de1828a21\">user.certificates.create()</ref>. This method lists all certificates in the profile.<simplesect kind=\"return\">A JSON list of all X.509 certificates accociated with the account. For historical reasons all information is provided twice: once in a plain list and once in a clean JSON map.</simplesect> <bold>Example:</bold> <pre> [ [ 1, \"/CN=Sebastian Trueg (local ODS instance)/emailAddress=trueg@openlinksw.com\", \"1 week(s) ago\", \"67:1C:7A:E3:D2:2D:85:C9:E4:AF:BB:D7:F1:EA:53:3B\", \"Yes\", { \"id\": 1, \"fingerprint\": \"67:1C:7A:E3:D2:2D:85:C9:E4:AF:BB:D7:F1:EA:53:3B\", \"timestamp\": \"2012-10-15 20:31:36\", \"fuzzyTimestamp\": \"1 week(s) ago\", \"subject\": { \"CN\": \"Sebastian Trueg (local ODS instance)\", \"emailAddress\": \"trueg@openlinksw.com\" } } ] ] </pre><simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "List all X.509 certificates accociated with an account. " . <#action_2610d8c4c79df52949bdc7691550999c> a schema:Action ; schema:name "user_certificates_new" ; schema:target <#action_user.certificates.new> . <#action_user.certificates.new> a schema:EntryPoint ; schema:name "EntryPoint - user_certificates_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.certificates.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.certificates.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.certificates.new_#_certificate> , <#action_user.certificates.new_#_enableLogin> . <#action_user.certificates.new_#_certificate> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "certificate" ; schema:name "certificate" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.certificates.new_#_enableLogin> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "enableLogin" ; schema:name "enableLogin" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_e73bd1caaa489c62e79a64337c00edcd> a schema:Action ; schema:name "user_certificateUrl" ; schema:target <#action_user.certificateUrl> . <#action_user.certificateUrl> a schema:EntryPoint ; schema:name "EntryPoint - user_certificateUrl" ; schema:url <https://vos.openlinksw.com/ods/api/user.certificateUrl> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.certificateUrl> ; schema:shortDescription "" . <#action_8b054c0d917f2c0d2238e559a71720bf> a schema:Action ; schema:name "user_checkAvailability" ; schema:target <#action_user.checkAvailability> . <#action_user.checkAvailability> a schema:EntryPoint ; schema:name "EntryPoint - user_checkAvailability" ; schema:url <https://vos.openlinksw.com/ods/api/user.checkAvailability> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.checkAvailability> ; schema:description "Before creating an account via <ref kindref=\"member\" refid=\"group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825\">user.register()</ref> this method can be used to check the availability of the user name and the email address.Although both parameters are marked as optional reliable results are only obtained if both parameters are given.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The user account name to check. </parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> The corresponding email address.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>. If the account name and email address are available <computeroutput>1</computeroutput> is returned. Otherwise an error code and a human readable message indicating the problem are returned and the HTTP status code is set to 400.</simplesect> <simplesect kind=\"par\"><title>Error Codes</title><itemizedlist> <listitem><computeroutput>invalid_username</computeroutput> </listitem><listitem><computeroutput>invalid_email</computeroutput> </listitem><listitem><computeroutput>username_in_use</computeroutput> </listitem><listitem><computeroutput>email_in_use</computeroutput> </listitem></itemizedlist> </simplesect> <bold>Example:</bold> <pre> $ curl -i http://vos.openlinksw.com/ods/api/user.checkAvailability?name=demo2&email=demo2@hello.com HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Tue, 17 Apr 2012 15:44:46 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 57 <result><code>1</code><message>Success</message></result> </pre><simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "Check if a certain user account name is available. " ; oplwebsrv:hasParameter <#action_user.checkAvailability_#_name> , <#action_user.checkAvailability_#_email> . <#action_user.checkAvailability_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user account name to check. " . <#action_user.checkAvailability_#_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "email" ; schema:name "email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The corresponding email address." . <#action_dc0be85f0f17bba11dfbf055c541aef9> a schema:Action ; schema:name "user_customFields_delete" ; schema:target <#action_user.customFields.delete> . <#action_user.customFields.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_customFields_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.customFields.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.customFields.delete> ; schema:description "Clients can provide as many custom fields to delete as required, ie. repeat the parameter below an arbitrary number of times.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>property</parametername> </parameternamelist> <parameterdescription> The field name. The property to store typically this is a full URL denoting the RDF property to use. It can, however, also be a simple string identifier like <computeroutput>myCustomField</computeroutput>. In that case ODS will use a default namespace as a prefix. Qnames will be expanded for all known prefixes.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Delete a previously set custom field value. " ; oplwebsrv:hasParameter <#action_user.customFields.delete_#_property> . <#action_user.customFields.delete_#_property> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "property" ; schema:name "property" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The field name. The property to store typically this is a full URL denoting the RDF property to use. It can, however, also be a simple string identifier like <computeroutput>myCustomField</computeroutput>. In that case ODS will use a default namespace as a prefix. Qnames will be expanded for all known prefixes." . <#action_2bf1904a63e0cda499071b2045488a8e> a schema:Action ; schema:name "user_customFields_set" ; schema:target <#action_user.customFields.set> . <#action_user.customFields.set> a schema:EntryPoint ; schema:name "EntryPoint - user_customFields_set" ; schema:url <https://vos.openlinksw.com/ods/api/user.customFields.set> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.customFields.set> ; schema:description "ODS allows to store any additional details in a user profile. This is simply done by storing the data in a private graph of the Virtuoso triple store.Clients can provide as many custom fields as required, ie. repeat the parameters below an arbitrary number of times. Alternatively custom fields can be provided in JSON format (see below for an example).<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>property</parametername> </parameternamelist> <parameterdescription> The field name. The property to store typically this is a full URL denoting the RDF property to use. It can, however, also be a simple string identifier like <computeroutput>myCustomField</computeroutput>. In that case ODS will use a default namespace as a prefix. Qnames will be expanded for all known prefixes. </parameterdescription> </li> <li> <parameternamelist> <parametername>value</parametername> </parameternamelist> <parameterdescription> The value of the property. By default all values are stored as strings. If the value can be converted into an integer then it is stored as such. </parameterdescription> </li> <li> <parameternamelist> <parametername>fields</parametername> </parameternamelist> <parameterdescription> A JSON stream of custom fields. This needs to be a JSON object containing simple key/value pairs (see below for an example).</parameterdescription> </li> </ul> <bold>Example:</bold> <programlisting><codeline><highlight class=\"normal\"><sp />http:</highlight><highlight class=\"comment\">//web.ods.openlinksw.com/ods/api/user.udpate.customFields?property=myField&value=Foobar&property=myOtherField&value=42</highlight></codeline> </programlisting><bold>JSON</bold> Example: <programlisting><codeline><highlight class=\"normal\"><sp />{</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"myField\"</highlight><highlight class=\"normal\">:<sp /></highlight><highlight class=\"stringliteral\">\"Foobar\"</highlight><highlight class=\"normal\">,</highlight></codeline> <codeline><highlight class=\"normal\"><sp /><sp /><sp /></highlight><highlight class=\"stringliteral\">\"myOtherField\"</highlight><highlight class=\"normal\">:<sp />42</highlight></codeline> <codeline><highlight class=\"normal\"><sp />}</highlight></codeline> </programlisting><simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Add and modify custom field values to an ODS user profile. " ; oplwebsrv:hasParameter <#action_user.customFields.set_#_property> , <#action_user.customFields.set_#_value> , <#action_user.customFields.set_#_fields> . <#action_user.customFields.set_#_property> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "property" ; schema:name "property" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The field name. The property to store typically this is a full URL denoting the RDF property to use. It can, however, also be a simple string identifier like <computeroutput>myCustomField</computeroutput>. In that case ODS will use a default namespace as a prefix. Qnames will be expanded for all known prefixes. " . <#action_user.customFields.set_#_value> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "value" ; schema:name "value" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The value of the property. By default all values are stored as strings. If the value can be converted into an integer then it is stored as such. " . <#action_user.customFields.set_#_fields> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "fields" ; schema:name "fields" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "A JSON stream of custom fields. This needs to be a JSON object containing simple key/value pairs (see below for an example)." . <#action_e4a210b40f67d3263a23fc276d5f2ddd> a schema:Action ; schema:name "user_dataGraphs_delete" ; schema:target <#action_user.dataGraphs.delete> . <#action_user.dataGraphs.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_dataGraphs_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.dataGraphs.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.dataGraphs.delete> ; schema:description "See user.graphs.new() for details on private data graphs.Be aware that deleting the custom fields graph <computeroutput><ulink url=\"http://HOST/dataspace/private/USER/customFields\">http://HOST/dataspace/private/USER/customFields</ulink></computeroutput> will delete all custom fields added via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga2bf1904a63e0cda499071b2045488a8e\">user.customFields.set()</ref>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name or the URI of the graph to delete.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga955bca2ca9ff875e2bdb7f0d676e1c10\">user.dataGraphs.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1gaa383784d1c31a23a5687ddc25485e4e4\">user.dataGraphs.list()</ref> </simplesect> " ; schema:shortDescription "Delete a private data graph. " ; oplwebsrv:hasParameter <#action_user.dataGraphs.delete_#_name> . <#action_user.dataGraphs.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The name or the URI of the graph to delete." . <#action_a383784d1c31a23a5687ddc25485e4e4> a schema:Action ; schema:name "user_dataGraphs_list" ; schema:target <#action_user.dataGraphs.list> . <#action_user.dataGraphs.list> a schema:EntryPoint ; schema:name "EntryPoint - user_dataGraphs_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.dataGraphs.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.dataGraphs.list> ; schema:description "This method lists all private data graphs as created via user.graphs.new().See user.graphs.new() for details on private data graphs.Alternatively the data graph URIs can be queried via SPARQL: <programlisting><codeline><highlight class=\"normal\"><sp />select<sp />?uri<sp />where<sp />{<sp /><USERIRI><sp />fixme:hasPrivateDataGraph<sp />?uri<sp />}</highlight></codeline> </programlisting><simplesect kind=\"return\">A <computeroutput>turtle</computeroutput> document describing the data graphs which are linked to the user account URI via <computeroutput>ods:hasPrivateDataGraph</computeroutput>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga955bca2ca9ff875e2bdb7f0d676e1c10\">user.dataGraphs.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1gae4a210b40f67d3263a23fc276d5f2ddd\">user.dataGraphs.delete()</ref> </simplesect> " ; schema:shortDescription "List all private data graphs. " . <#action_955bca2ca9ff875e2bdb7f0d676e1c10> a schema:Action ; schema:name "user_dataGraphs_new" ; schema:target <#action_user.dataGraphs.new> . <#action_user.dataGraphs.new> a schema:EntryPoint ; schema:name "EntryPoint - user_dataGraphs_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.dataGraphs.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.dataGraphs.new> ; schema:description "Each ODS user has a profile with fixed fields. These are managed via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga777818aa3df3994ecb3fc581e691c18a\">user.update.fields()</ref>. In addition to that each user can store custom fields via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga2bf1904a63e0cda499071b2045488a8e\">user.customFields.set()</ref>. If ODS has been configured to allow the creation of data graphs then each ODS user can in addition create an arbitrary number of private data graphs. Private data graphs are simply named graphs in the Virtuoso triple store which are only accessible to the ODS user (unless they define ACL rules to share the graph). This allows to store any kind of information of any complexity in an ODS user profile in a secure way.Typically <computeroutput>SPARQL</computeroutput> Update queries (<ref kindref=\"member\" refid=\"group__ods__module__query_1gaa414cfba762ecd76d5a58755ab7072f5\">query.sparql()</ref>) will be used to fill the graphs with information.One private data graph is already created when using <ref kindref=\"member\" refid=\"group__ods__module__user_1ga2bf1904a63e0cda499071b2045488a8e\">user.customFields.set()</ref>: <computeroutput><ulink url=\"http://HOST/dataspace/private/USER/customFields.\">http://HOST/dataspace/private/USER/customFields.</ulink></computeroutput> This special graph should not be used to store addition data besides the custom fields, although it is theoretically possible.This method allows to create these private data graphs.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the new graph. This will be incorporated into the graph URI. Ideally it should only contain lower-case letters and no spaces.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The newly created graph in a turtle document or as a plain text URI, depending on the requested content type. On error a code as defined in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref> is returned and an appropriate HTTP status code is set:<itemizedlist> <listitem><computeroutput>409</computeroutput> - A graph with that name already exists and cannot be reused as a data graph.</listitem><listitem><computeroutput>405</computeroutput> - The given graph name refers to an already existing data graph.</listitem></itemizedlist> </simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1gae4a210b40f67d3263a23fc276d5f2ddd\">user.dataGraphs.delete()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1gaa383784d1c31a23a5687ddc25485e4e4\">user.dataGraphs.list()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1ga2bf1904a63e0cda499071b2045488a8e\">user.customFields.set()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__acl_1gab1844fa8dc1ab8360a2117e0c8b0bd8e\">acl.rules.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__query_1gaa414cfba762ecd76d5a58755ab7072f5\">query.sparql()</ref> </simplesect> " ; schema:shortDescription "Create a new private data graph. " ; oplwebsrv:hasParameter <#action_user.dataGraphs.new_#_name> . <#action_user.dataGraphs.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The name of the new graph. This will be incorporated into the graph URI. Ideally it should only contain lower-case letters and no spaces." . <#action_aeccd6c639e21209915c5d1f846f4925> a schema:Action ; schema:name "user_delete" ; schema:target <#action_user.delete> . <#action_user.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.delete> ; schema:description "This function allows an administrator to delete a user account and all the user's data. This requires administrator privileges.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the user account to delete.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga74749a74f6dc1347e1df25b7c0082739\">user.disable()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Delete a user account. " ; oplwebsrv:hasParameter <#action_user.delete_#_name> . <#action_user.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The name of the user account to delete." . <#action_74749a74f6dc1347e1df25b7c0082739> a schema:Action ; schema:name "user_disable" ; schema:target <#action_user.disable> . <#action_user.disable> a schema:EntryPoint ; schema:name "EntryPoint - user_disable" ; schema:url <https://vos.openlinksw.com/ods/api/user.disable> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.disable> ; schema:description "This function allows an administrator to disable a user account. A disabled user account does not allow authentication anymore, however all data is kept. Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gaaeccd6c639e21209915c5d1f846f4925\">user.delete()</ref> to permanently delete an account and <ref kindref=\"member\" refid=\"group__ods__module__user_1ga1c155be33ae582553ab7ddd8e2b85a5c\">user.enable()</ref> to re-enable a disabled account. If the given <computeroutput>name</computeroutput> is not the authenticated user administrator privileges are required.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the user account to disable. If omitted the authenticated user account is disabled.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga1c155be33ae582553ab7ddd8e2b85a5c\">user.enable()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Disable a user account. " ; oplwebsrv:hasParameter <#action_user.disable_#_name> . <#action_user.disable_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The name of the user account to disable. If omitted the authenticated user account is disabled." . <#action_1c155be33ae582553ab7ddd8e2b85a5c> a schema:Action ; schema:name "user_enable" ; schema:target <#action_user.enable> . <#action_user.enable> a schema:EntryPoint ; schema:name "EntryPoint - user_enable" ; schema:url <https://vos.openlinksw.com/ods/api/user.enable> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.enable> ; schema:description "This function allows an administrator to enable a user account which is disabled. This requires administrator privileges.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the user account to enable.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga74749a74f6dc1347e1df25b7c0082739\">user.disable()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Enable a previously disabled user account. " ; oplwebsrv:hasParameter <#action_user.enable_#_name> . <#action_user.enable_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The name of the user account to enable." . <#action_f1e7bb7f65ea19f106a4f89495a42e51> a schema:Action ; schema:name "user_favorites_delete" ; schema:target <#action_user.favorites.delete> . <#action_user.favorites.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_favorites_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.favorites.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.favorites.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.favorites.delete_#_id> . <#action_user.favorites.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_cc35aebac06452361e5294175ed63841> a schema:Action ; schema:name "user_favorites_edit" ; schema:target <#action_user.favorites.edit> . <#action_user.favorites.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_favorites_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.favorites.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.favorites.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.favorites.edit_#_id> , <#action_user.favorites.edit_#_flag> , <#action_user.favorites.edit_#_label> , <#action_user.favorites.edit_#_uri> , <#action_user.favorites.edit_#_properties> . <#action_user.favorites.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.favorites.edit_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.favorites.edit_#_label> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "label" ; schema:name "label" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.favorites.edit_#_uri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uri" ; schema:name "uri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.favorites.edit_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_f43f1ade207c62354db52ae9b741164d> a schema:Action ; schema:name "user_favorites_get" ; schema:target <#action_user.favorites.get> . <#action_user.favorites.get> a schema:EntryPoint ; schema:name "EntryPoint - user_favorites_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.favorites.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.favorites.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.favorites.get_#_id> . <#action_user.favorites.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_8a8fa955de45599b5a5b8c5088a70436> a schema:Action ; schema:name "user_favorites_list" ; schema:target <#action_user.favorites.list> . <#action_user.favorites.list> a schema:EntryPoint ; schema:name "EntryPoint - user_favorites_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.favorites.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.favorites.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" . <#action_64ab2cc30f97cc05cb3a405047959545> a schema:Action ; schema:name "user_favorites_new" ; schema:target <#action_user.favorites.new> . <#action_user.favorites.new> a schema:EntryPoint ; schema:name "EntryPoint - user_favorites_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.favorites.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.favorites.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.favorites.new_#_flag> , <#action_user.favorites.new_#_label> , <#action_user.favorites.new_#_uri> , <#action_user.favorites.new_#_properties> . <#action_user.favorites.new_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.favorites.new_#_label> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "label" ; schema:name "label" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.favorites.new_#_uri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uri" ; schema:name "uri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.favorites.new_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_544c77f703c7c8c9373e06bf97428258> a schema:Action ; schema:name "user_get" ; schema:target <#action_user.get> . <#action_user.get> a schema:EntryPoint ; schema:name "EntryPoint - user_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.get> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.get_#_name> . <#action_user.get_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_a17e86489578968ab0aabaa53c9e44cc> a schema:Action ; schema:name "user_getFacebookData" ; schema:target <#action_user.getFacebookData> . <#action_user.getFacebookData> a schema:EntryPoint ; schema:name "EntryPoint - user_getFacebookData" ; schema:url <https://vos.openlinksw.com/ods/api/user.getFacebookData> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.getFacebookData> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.getFacebookData_#_fb> , <#action_user.getFacebookData_#_fields> , <#action_user.getFacebookData_#_outputMode> . <#action_user.getFacebookData_#_fb> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "fb" ; schema:name "fb" ; # oplwebsrv:parameterType "DB.DBA.Facebook" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.getFacebookData_#_fields> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "fields" ; schema:name "fields" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "uid,name" . <#action_user.getFacebookData_#_outputMode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "outputMode" ; schema:name "outputMode" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_0238f6cb1f76ec1db5572e9c79a6c3fe> a schema:Action ; schema:name "user_getFOAFData" ; schema:target <#action_user.getFOAFData> . <#action_user.getFOAFData> a schema:EntryPoint ; schema:name "EntryPoint - user_getFOAFData" ; schema:url <https://vos.openlinksw.com/ods/api/user.getFOAFData> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.getFOAFData> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>foafIRI</parametername> </parameternamelist> <parameterdescription> The URL of the FOAF profile to lookup. </parameterdescription> </li> <li> <parameternamelist> <parametername>spongerMode</parametername> </parameternamelist> <parameterdescription> <emphasis>unused</emphasis> </parameterdescription> </li> <li> <parameternamelist> <parametername>sslFOAFCheck</parametername> </parameternamelist> <parameterdescription> If set to anything but <computeroutput>0</computeroutput> no action will be taken unless the connection is secure. </parameterdescription> </li> <li> <parameternamelist> <parametername>outputMode</parametername> </parameternamelist> <parameterdescription> <emphasis>unused</emphasis> </parameterdescription> </li> <li> <parameternamelist> <parametername>sslLoginCheck</parametername> </parameternamelist> <parameterdescription> <emphasis>unused</emphasis> </parameterdescription> </li> </ul> <simplesect kind=\"return\">The details of the FOAF profile serialized as a JSON stream. This stream can be used in <ref kindref=\"member\" refid=\"group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825\">user.register()</ref>.</simplesect> <bold>FIXME:</bold> support CN and fix outputMode.<simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "Fetch the contents of a FOAF user profile. " ; oplwebsrv:hasParameter <#action_user.getFOAFData_#_foafIRI> , <#action_user.getFOAFData_#_spongerMode> , <#action_user.getFOAFData_#_sslFOAFCheck> , <#action_user.getFOAFData_#_outputMode> , <#action_user.getFOAFData_#_sslLoginCheck> . <#action_user.getFOAFData_#_foafIRI> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "foafIRI" ; schema:name "foafIRI" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The URL of the FOAF profile to lookup. " . <#action_user.getFOAFData_#_spongerMode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "spongerMode" ; schema:name "spongerMode" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "<emphasis>unused</emphasis> " . <#action_user.getFOAFData_#_sslFOAFCheck> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sslFOAFCheck" ; schema:name "sslFOAFCheck" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "If set to anything but <computeroutput>0</computeroutput> no action will be taken unless the connection is secure. " . <#action_user.getFOAFData_#_outputMode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "outputMode" ; schema:name "outputMode" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" ; schema:description "<emphasis>unused</emphasis> " . <#action_user.getFOAFData_#_sslLoginCheck> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sslLoginCheck" ; schema:name "sslLoginCheck" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "<emphasis>unused</emphasis> " . <#action_290c5fd3bbbd86c5b1d768515f6b2fff> a schema:Action ; schema:name "user_getFOAFSSLData" ; schema:target <#action_user.getFOAFSSLData> . <#action_user.getFOAFSSLData> a schema:EntryPoint ; schema:name "EntryPoint - user_getFOAFSSLData" ; schema:url <https://vos.openlinksw.com/ods/api/user.getFOAFSSLData> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.getFOAFSSLData> ; schema:description "The client needs to provide the WebID X.509 certificate as an additional context attribute.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>sslFOAFCheck</parametername> </parameternamelist> <parameterdescription> <emphasis>unused</emphasis> </parameterdescription> </li> <li> <parameternamelist> <parametername>outputMode</parametername> </parameternamelist> <parameterdescription> <emphasis>unused</emphasis> </parameterdescription> </li> <li> <parameternamelist> <parametername>sslLoginCheck</parametername> </parameternamelist> <parameterdescription> <emphasis>unused</emphasis> </parameterdescription> </li> </ul> <simplesect kind=\"return\">The details of the FOAF profile serialized as a JSON stream.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requires a client certificate with an embedded WebID. See also <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_webid\">Authentication via WebID</ref>. </simplesect> " ; schema:shortDescription "Fetch the FOAF profile for a WebID certificate. " ; oplwebsrv:hasParameter <#action_user.getFOAFSSLData_#_sslFOAFCheck> , <#action_user.getFOAFSSLData_#_outputMode> , <#action_user.getFOAFSSLData_#_sslLoginCheck> . <#action_user.getFOAFSSLData_#_sslFOAFCheck> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sslFOAFCheck" ; schema:name "sslFOAFCheck" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "<emphasis>unused</emphasis> " . <#action_user.getFOAFSSLData_#_outputMode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "outputMode" ; schema:name "outputMode" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" ; schema:description "<emphasis>unused</emphasis> " . <#action_user.getFOAFSSLData_#_sslLoginCheck> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sslLoginCheck" ; schema:name "sslLoginCheck" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "<emphasis>unused</emphasis> " . <#action_3126592d72decd62dbc22a3c1ea2b185> a schema:Action ; schema:name "user_getKnowsData" ; schema:target <#action_user.getKnowsData> . <#action_user.getKnowsData> a schema:EntryPoint ; schema:name "EntryPoint - user_getKnowsData" ; schema:url <https://vos.openlinksw.com/ods/api/user.getKnowsData> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.getKnowsData> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.getKnowsData_#_sourceURI> , <#action_user.getKnowsData_#_spongerMode> . <#action_user.getKnowsData_#_sourceURI> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sourceURI" ; schema:name "sourceURI" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.getKnowsData_#_spongerMode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "spongerMode" ; schema:name "spongerMode" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" . <#action_2014031675de3dbd1542fe80d0cbdcd6> a schema:Action ; schema:name "user_hyperlinking_rules_add" ; schema:target <#action_user.hyperlinking_rules.add> . <#action_user.hyperlinking_rules.add> a schema:EntryPoint ; schema:name "EntryPoint - user_hyperlinking_rules_add" ; schema:url <https://vos.openlinksw.com/ods/api/user.hyperlinking_rules.add> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.hyperlinking_rules.add> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.hyperlinking_rules.add_#_rules> . <#action_user.hyperlinking_rules.add_#_rules> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rules" ; schema:name "rules" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_108187adebaca2104cdfa59094951872> a schema:Action ; schema:name "user_hyperlinking_rules_delete" ; schema:target <#action_user.hyperlinking_rules.delete> . <#action_user.hyperlinking_rules.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_hyperlinking_rules_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.hyperlinking_rules.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.hyperlinking_rules.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.hyperlinking_rules.delete_#_rules> . <#action_user.hyperlinking_rules.delete_#_rules> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rules" ; schema:name "rules" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_05f810efd14314e3f8390f14efdd01c1> a schema:Action ; schema:name "user_hyperlinking_rules_update" ; schema:target <#action_user.hyperlinking_rules.update> . <#action_user.hyperlinking_rules.update> a schema:EntryPoint ; schema:name "EntryPoint - user_hyperlinking_rules_update" ; schema:url <https://vos.openlinksw.com/ods/api/user.hyperlinking_rules.update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.hyperlinking_rules.update> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.hyperlinking_rules.update_#_rules> . <#action_user.hyperlinking_rules.update_#_rules> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rules" ; schema:name "rules" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_81c931a41511460716d7cb43e748a839> a schema:Action ; schema:name "user_info" ; schema:target <#action_user.info> . <#action_user.info> a schema:EntryPoint ; schema:name "EntryPoint - user_info" ; schema:url <https://vos.openlinksw.com/ods/api/user.info> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.info> ; schema:description "This method allows to fetch details about an ODS user. If no user name is given the authenticated user is returned. This means that <ref kindref=\"member\" refid=\"group__ods__module__user_1ga81c931a41511460716d7cb43e748a839\">user.info()</ref> can be used to get user information for an authentication session (see also <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>).<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The optional ODS user name. Defaults to the authenticated user. </parameterdescription> </li> <li> <parameternamelist> <parametername>short</parametername> </parameternamelist> <parameterdescription> An optional boolean setting. If <computeroutput>1</computeroutput> only the most basic information is returned.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An XML stream encoding the user details such as uid, name, or the personal URL.</simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/user.info?sid=07e6e4b8da77691c729e6c95e3016ac8&short=1\" HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Sat, 21 Apr 2012 09:52:46 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 157 <user><uid>127</uid><iri>http://vos.openlinksw.com/dataspace/person/demo#this</iri><name>demo</name><nickName>demo</nickName><fullName>Demo User </fullName></user> </pre><simplesect kind=\"par\"><title>Authentication</title>This function will provide additional information if authentication via one of the supported methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref> is used. </simplesect> " ; schema:shortDescription "Fetch basic information about a user. " ; oplwebsrv:hasParameter <#action_user.info_#_name> , <#action_user.info_#_short> . <#action_user.info_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The optional ODS user name. Defaults to the authenticated user. " . <#action_user.info_#_short> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "short" ; schema:name "short" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "An optional boolean setting. If <computeroutput>1</computeroutput> only the most basic information is returned." . <#action_61ff7d0b1f9dcba8346c32d7bbff32be> a schema:Action ; schema:name "user_info_webID" ; schema:target <#action_user.info.webID> . <#action_user.info.webID> a schema:EntryPoint ; schema:name "EntryPoint - user_info_webID" ; schema:url <https://vos.openlinksw.com/ods/api/user.info.webID> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.info.webID> ; schema:description "This method returns public information about an ODS user based on their specific ODS WebID.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>webID</parametername> </parameternamelist> <parameterdescription> The WebID of the user to lookup. </parameterdescription> </li> <li> <parameternamelist> <parametername>output</parametername> </parameternamelist> <parameterdescription> The output type. Can be either <computeroutput>xml</computeroutput> or <computeroutput>json</computeroutput>. Defaults to <computeroutput>xml</computeroutput>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The details of the requested user serialized as an xml stream.s</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "Fetch details about an ODS user based on their WebID. " ; oplwebsrv:hasParameter <#action_user.info.webID_#_webID> , <#action_user.info.webID_#_output> . <#action_user.info.webID_#_webID> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "webID" ; schema:name "webID" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The WebID of the user to lookup. " . <#action_user.info.webID_#_output> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "output" ; schema:name "output" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "xml" ; schema:description "The output type. Can be either <computeroutput>xml</computeroutput> or <computeroutput>json</computeroutput>. Defaults to <computeroutput>xml</computeroutput>." . <#action_86c9649a7994f79bdf41b484ee88f76b> a schema:Action ; schema:name "user_instances_list" ; schema:target <#action_user.instances.list> . <#action_user.instances.list> a schema:EntryPoint ; schema:name "EntryPoint - user_instances_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.instances.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.instances.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" . <#action_d47d0fcb342013c577dcb92a5ee3b8c8> a schema:Action ; schema:name "user_invitation" ; schema:target <#action_user.invitation> . <#action_user.invitation> a schema:EntryPoint ; schema:name "EntryPoint - user_invitation" ; schema:url <https://vos.openlinksw.com/ods/api/user.invitation> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.invitation> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000015\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gaf0abb9656d7a4b1ccd34a5eecdb68e00\">user.invitation.approve()</ref> instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.invitation_#_invitation_id> , <#action_user.invitation_#_approve> . <#action_user.invitation_#_invitation_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "invitation_id" ; schema:name "invitation_id" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.invitation_#_approve> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "approve" ; schema:name "approve" ; # oplwebsrv:parameterType "smallint" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_f0abb9656d7a4b1ccd34a5eecdb68e00> a schema:Action ; schema:name "user_invitation_approve" ; schema:target <#action_user.invitation.approve> . <#action_user.invitation.approve> a schema:EntryPoint ; schema:name "EntryPoint - user_invitation_approve" ; schema:url <https://vos.openlinksw.com/ods/api/user.invitation.approve> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.invitation.approve> ; schema:description "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.This method allow to approve or reject invitations from other users.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>invitation_id</parametername> </parameternamelist> <parameterdescription> The id of the invitation as reported by <ref kindref=\"member\" refid=\"group__ods__module__user_1ga33086cfe66b0e314e5b8a3e83ae33437\">user.invitation.list()</ref>. </parameterdescription> </li> <li> <parameternamelist> <parametername>approve</parametername> </parameternamelist> <parameterdescription> Either <computeroutput>1</computeroutput> or <computeroutput>0</computeroutput> to <emphasis>approve</emphasis> or <emphasis>reject</emphasis> the invitation.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga3937eecbf3d82e29667c487f4c404e3f\">user.invitation.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1ga33086cfe66b0e314e5b8a3e83ae33437\">user.invitation.list()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Approve an invitation from another user. " ; oplwebsrv:hasParameter <#action_user.invitation.approve_#_invitation_id> , <#action_user.invitation.approve_#_approve> . <#action_user.invitation.approve_#_invitation_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "invitation_id" ; schema:name "invitation_id" ; # oplwebsrv:parameterType "int" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The id of the invitation as reported by <ref kindref=\"member\" refid=\"group__ods__module__user_1ga33086cfe66b0e314e5b8a3e83ae33437\">user.invitation.list()</ref>. " . <#action_user.invitation.approve_#_approve> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "approve" ; schema:name "approve" ; # oplwebsrv:parameterType "smallint" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "Either <computeroutput>1</computeroutput> or <computeroutput>0</computeroutput> to <emphasis>approve</emphasis> or <emphasis>reject</emphasis> the invitation." . <#action_33086cfe66b0e314e5b8a3e83ae33437> a schema:Action ; schema:name "user_invitation_list" ; schema:target <#action_user.invitation.list> . <#action_user.invitation.list> a schema:EntryPoint ; schema:name "EntryPoint - user_invitation_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.invitation.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.invitation.list> ; schema:description "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.This method lists the invitations other users sent to the authenticated user and invitations the authenticated user sent to others.<simplesect kind=\"return\">A JSON stream listing all invitations.</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>.<simplesect kind=\"see\"><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></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Get a list of pending and rejected invitations. " . <#action_3937eecbf3d82e29667c487f4c404e3f> a schema:Action ; schema:name "user_invitation_new" ; schema:target <#action_user.invitation.new> . <#action_user.invitation.new> a schema:EntryPoint ; schema:name "EntryPoint - user_invitation_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.invitation.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.invitation.new> ; schema:description "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.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>friends_email</parametername> </parameternamelist> <parameterdescription> 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. </parameterdescription> </li> <li> <parameternamelist> <parametername>custom_message</parametername> </parameternamelist> <parameterdescription> 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><computeroutput>app%</computeroutput> - The title of the web service or the server's hostname as a fallback.</listitem><listitem><computeroutput>user%</computeroutput> - The full name of the user sending the invitation.</listitem><listitem><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.</listitem><listitem><computeroutput>invitation%</computeroutput> - The <computeroutput>custom_message</computeroutput> provided as a parameter. </listitem></itemizedlist> </parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><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></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Invite someone to join the user's social network. " ; oplwebsrv:hasParameter <#action_user.invitation.new_#_friends_email> , <#action_user.invitation.new_#_custom_message> . <#action_user.invitation.new_#_friends_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "friends_email" ; schema:name "friends_email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "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. " . <#action_user.invitation.new_#_custom_message> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "custom_message" ; schema:name "custom_message" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "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><computeroutput>app%</computeroutput> - The title of the web service or the server's hostname as a fallback.</listitem><listitem><computeroutput>user%</computeroutput> - The full name of the user sending the invitation.</listitem><listitem><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.</listitem><listitem><computeroutput>invitation%</computeroutput> - The <computeroutput>custom_message</computeroutput> provided as a parameter. </listitem></itemizedlist> " . <#action_cb40815a971206657c42e68ab0a2ab77> a schema:Action ; schema:name "user_invitations_get" ; schema:target <#action_user.invitations.get> . <#action_user.invitations.get> a schema:EntryPoint ; schema:name "EntryPoint - user_invitations_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.invitations.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.invitations.get> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000016\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use <ref kindref=\"member\" refid=\"group__ods__module__user_1ga33086cfe66b0e314e5b8a3e83ae33437\">user.invitation.list()</ref> instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" . <#action_b7ea59582c5db9d82c8e85730a8b11ed> a schema:Action ; schema:name "user_invite" ; schema:target <#action_user.invite> . <#action_user.invite> a schema:EntryPoint ; schema:name "EntryPoint - user_invite" ; schema:url <https://vos.openlinksw.com/ods/api/user.invite> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.invite> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000014\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use <ref kindref=\"member\" refid=\"group__ods__module__user_1ga3937eecbf3d82e29667c487f4c404e3f\">user.invitation.new()</ref> instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.invite_#_friends_email> , <#action_user.invite_#_custom_message> . <#action_user.invite_#_friends_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "friends_email" ; schema:name "friends_email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.invite_#_custom_message> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "custom_message" ; schema:name "custom_message" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_e6be624a2c149c799944c6bd9e4a6c34> a schema:Action ; schema:name "user_knows_delete" ; schema:target <#action_user.knows.delete> . <#action_user.knows.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_knows_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.knows.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.knows.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.knows.delete_#_id> . <#action_user.knows.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_2eaa526f2fce7feb41bb996db7c27e53> a schema:Action ; schema:name "user_knows_edit" ; schema:target <#action_user.knows.edit> . <#action_user.knows.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_knows_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.knows.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.knows.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.knows.edit_#_id> , <#action_user.knows.edit_#_flag> , <#action_user.knows.edit_#_uri> , <#action_user.knows.edit_#_label> . <#action_user.knows.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.knows.edit_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.knows.edit_#_uri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uri" ; schema:name "uri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.knows.edit_#_label> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "label" ; schema:name "label" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_c6890a069c5aa6d17e09ab482033d34f> a schema:Action ; schema:name "user_knows_get" ; schema:target <#action_user.knows.get> . <#action_user.knows.get> a schema:EntryPoint ; schema:name "EntryPoint - user_knows_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.knows.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.knows.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.knows.get_#_id> . <#action_user.knows.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_e2f5c10016376f74a32b39be2ad7296a> a schema:Action ; schema:name "user_knows_list" ; schema:target <#action_user.knows.list> . <#action_user.knows.list> a schema:EntryPoint ; schema:name "EntryPoint - user_knows_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.knows.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.knows.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" . <#action_4574db9a55aaf933a9bfe71bb5c0165e> a schema:Action ; schema:name "user_knows_new" ; schema:target <#action_user.knows.new> . <#action_user.knows.new> a schema:EntryPoint ; schema:name "EntryPoint - user_knows_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.knows.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.knows.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.knows.new_#_flag> , <#action_user.knows.new_#_uri> , <#action_user.knows.new_#_label> . <#action_user.knows.new_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.knows.new_#_uri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uri" ; schema:name "uri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.knows.new_#_label> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "label" ; schema:name "label" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_90a9689419bbfd1bf7b3a9078ef1ff3d> a schema:Action ; schema:name "user_likes_delete" ; schema:target <#action_user.likes.delete> . <#action_user.likes.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_likes_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.likes.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.likes.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.likes.delete_#_id> . <#action_user.likes.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_3ba22eb29e8e6d14db09fbae7478ba8b> a schema:Action ; schema:name "user_likes_edit" ; schema:target <#action_user.likes.edit> . <#action_user.likes.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_likes_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.likes.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.likes.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.likes.edit_#_id> , <#action_user.likes.edit_#_flag> , <#action_user.likes.edit_#_uri> , <#action_user.likes.edit_#_type> , <#action_user.likes.edit_#_name> , <#action_user.likes.edit_#_comment> , <#action_user.likes.edit_#_properties> . <#action_user.likes.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.edit_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.likes.edit_#_uri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uri" ; schema:name "uri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.edit_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.edit_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.edit_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.edit_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_81e805511be84bc4dad5af6aaf147ec4> a schema:Action ; schema:name "user_likes_get" ; schema:target <#action_user.likes.get> . <#action_user.likes.get> a schema:EntryPoint ; schema:name "EntryPoint - user_likes_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.likes.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.likes.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.likes.get_#_id> . <#action_user.likes.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_862a10c7c945f08c3b32406aeeebee35> a schema:Action ; schema:name "user_likes_list" ; schema:target <#action_user.likes.list> . <#action_user.likes.list> a schema:EntryPoint ; schema:name "EntryPoint - user_likes_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.likes.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.likes.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" . <#action_9336f54c75d7d31d23e6d41b33800dcb> a schema:Action ; schema:name "user_likes_new" ; schema:target <#action_user.likes.new> . <#action_user.likes.new> a schema:EntryPoint ; schema:name "EntryPoint - user_likes_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.likes.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.likes.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.likes.new_#_flag> , <#action_user.likes.new_#_uri> , <#action_user.likes.new_#_type> , <#action_user.likes.new_#_name> , <#action_user.likes.new_#_comment> , <#action_user.likes.new_#_properties> . <#action_user.likes.new_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.likes.new_#_uri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uri" ; schema:name "uri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.new_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.new_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.likes.new_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_d6fa906ebe473bb8220ff82b2c9ed357> a schema:Action ; schema:name "user_login" ; schema:target <#action_user.login> . <#action_user.login> a schema:EntryPoint ; schema:name "EntryPoint - user_login" ; schema:url <https://vos.openlinksw.com/ods/api/user.login> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.login> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000011\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use <ref kindref=\"member\" refid=\"group__ods__module__user_1ga6238a5b780bc6a2811d977bfdc2a9f96\">user.authenticate()</ref> instead.</xrefdescription></xrefsect>Calling this method is similar to calling <ref kindref=\"member\" refid=\"group__ods__module__user_1ga6238a5b780bc6a2811d977bfdc2a9f96\">user.authenticate()</ref> with the password hash method.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>user_name</parametername> </parameternamelist> <parameterdescription> The user name of the account created via <ref kindref=\"member\" refid=\"group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825\">user.register()</ref>. </parameterdescription> </li> <li> <parameternamelist> <parametername>password_hash</parametername> </parameternamelist> <parameterdescription> The password hash as explained in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_password_hash\">Password Hash Authentication</ref>.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The session id of the newly created session. This session id can then be used to authenticate other method calls as explained in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>. </simplesect> " ; schema:shortDescription "Start a new user session. " ; oplwebsrv:hasParameter <#action_user.login_#_user_name> , <#action_user.login_#_password_hash> . <#action_user.login_#_user_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "user_name" ; schema:name "user_name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user name of the account created via <ref kindref=\"member\" refid=\"group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825\">user.register()</ref>. " . <#action_user.login_#_password_hash> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "password_hash" ; schema:name "password_hash" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The password hash as explained in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_password_hash\">Password Hash Authentication</ref>." . <#action_553df274a6ec61c6f89bb62ea78303f6> a schema:Action ; schema:name "user_logout" ; schema:target <#action_user.logout> . <#action_user.logout> a schema:EntryPoint ; schema:name "EntryPoint - user_logout" ; schema:url <https://vos.openlinksw.com/ods/api/user.logout> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.logout> ; schema:description "This method ends a user session created via <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6fa906ebe473bb8220ff82b2c9ed357\">user.login()</ref> or <ref kindref=\"member\" refid=\"group__ods__module__user_1ga6238a5b780bc6a2811d977bfdc2a9f96\">user.authenticate()</ref>. The user session needs to be specified via <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>.<simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "End a user session. " . <#action_154c3ab12e48efadeb13afcc896b3dd4> a schema:Action ; schema:name "user_mades_delete" ; schema:target <#action_user.mades.delete> . <#action_user.mades.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_mades_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.mades.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.mades.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.mades.delete_#_id> . <#action_user.mades.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_caf917d50a8dc97695b4fe9e3a88ca6e> a schema:Action ; schema:name "user_mades_edit" ; schema:target <#action_user.mades.edit> . <#action_user.mades.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_mades_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.mades.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.mades.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.mades.edit_#_id> , <#action_user.mades.edit_#_property> , <#action_user.mades.edit_#_url> , <#action_user.mades.edit_#_description> . <#action_user.mades.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.mades.edit_#_property> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "property" ; schema:name "property" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.mades.edit_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.mades.edit_#_description> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "description" ; schema:name "description" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_2b062b3446ec84819f7acc71233e4212> a schema:Action ; schema:name "user_mades_get" ; schema:target <#action_user.mades.get> . <#action_user.mades.get> a schema:EntryPoint ; schema:name "EntryPoint - user_mades_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.mades.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.mades.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.mades.get_#_id> . <#action_user.mades.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_e05afcd744f27a47a1f18e842cbc1176> a schema:Action ; schema:name "user_mades_list" ; schema:target <#action_user.mades.list> . <#action_user.mades.list> a schema:EntryPoint ; schema:name "EntryPoint - user_mades_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.mades.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.mades.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" . <#action_cc5a2898879bbd842fb442dae97320a6> a schema:Action ; schema:name "user_mades_new" ; schema:target <#action_user.mades.new> . <#action_user.mades.new> a schema:EntryPoint ; schema:name "EntryPoint - user_mades_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.mades.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.mades.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.mades.new_#_property> , <#action_user.mades.new_#_url> , <#action_user.mades.new_#_description> . <#action_user.mades.new_#_property> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "property" ; schema:name "property" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.mades.new_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.mades.new_#_description> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "description" ; schema:name "description" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_0d9d97fd1ef32c38c14949e9e14fe401> a schema:Action ; schema:name "user_oauth_linkedin_authenticationUrl" ; schema:target <#action_user.oauth.linkedin.authenticationUrl> . <#action_user.oauth.linkedin.authenticationUrl> a schema:EntryPoint ; schema:name "EntryPoint - user_oauth_linkedin_authenticationUrl" ; schema:url <https://vos.openlinksw.com/ods/api/user.oauth.linkedin.authenticationUrl> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.oauth.linkedin.authenticationUrl> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000005\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.oauth.linkedin.authenticationUrl_#_hostUrl> . <#action_user.oauth.linkedin.authenticationUrl_#_hostUrl> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "hostUrl" ; schema:name "hostUrl" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_006798044e5635c8892bd40547a0914d> a schema:Action ; schema:name "user_oauth_linkedin_registrationData" ; schema:target <#action_user.oauth.linkedin.registrationData> . <#action_user.oauth.linkedin.registrationData> a schema:EntryPoint ; schema:name "EntryPoint - user_oauth_linkedin_registrationData" ; schema:url <https://vos.openlinksw.com/ods/api/user.oauth.linkedin.registrationData> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.oauth.linkedin.registrationData> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000007\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.oauth.linkedin.registrationData_#_sid> , <#action_user.oauth.linkedin.registrationData_#_oauth_verifier> , <#action_user.oauth.linkedin.registrationData_#_oauth_token> . <#action_user.oauth.linkedin.registrationData_#_sid> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sid" ; schema:name "sid" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.oauth.linkedin.registrationData_#_oauth_verifier> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_verifier" ; schema:name "oauth_verifier" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.oauth.linkedin.registrationData_#_oauth_token> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_token" ; schema:name "oauth_token" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_85cc5b04ec6073a6ad71aa006da7250f> a schema:Action ; schema:name "user_oauth_twitter_authenticationUrl" ; schema:target <#action_user.oauth.twitter.authenticationUrl> . <#action_user.oauth.twitter.authenticationUrl> a schema:EntryPoint ; schema:name "EntryPoint - user_oauth_twitter_authenticationUrl" ; schema:url <https://vos.openlinksw.com/ods/api/user.oauth.twitter.authenticationUrl> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.oauth.twitter.authenticationUrl> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000001\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.oauth.twitter.authenticationUrl_#_hostUrl> . <#action_user.oauth.twitter.authenticationUrl_#_hostUrl> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "hostUrl" ; schema:name "hostUrl" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_f9826a4dd0a1d11dc8d3d6c57dc46978> a schema:Action ; schema:name "user_oauth_twitter_registrationData" ; schema:target <#action_user.oauth.twitter.registrationData> . <#action_user.oauth.twitter.registrationData> a schema:EntryPoint ; schema:name "EntryPoint - user_oauth_twitter_registrationData" ; schema:url <https://vos.openlinksw.com/ods/api/user.oauth.twitter.registrationData> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.oauth.twitter.registrationData> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000003\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.oauth.twitter.registrationData_#_sid> , <#action_user.oauth.twitter.registrationData_#_oauth_verifier> , <#action_user.oauth.twitter.registrationData_#_oauth_token> . <#action_user.oauth.twitter.registrationData_#_sid> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sid" ; schema:name "sid" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.oauth.twitter.registrationData_#_oauth_verifier> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_verifier" ; schema:name "oauth_verifier" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.oauth.twitter.registrationData_#_oauth_token> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_token" ; schema:name "oauth_token" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_281290eba4d4cac10cfd292d275141e8> a schema:Action ; schema:name "user_offers_delete" ; schema:target <#action_user.offers.delete> . <#action_user.offers.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_offers_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.offers.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.offers.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.offers.delete_#_id> . <#action_user.offers.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_2f8d4e7b37e631657c0badc9918ba5e3> a schema:Action ; schema:name "user_offers_edit" ; schema:target <#action_user.offers.edit> . <#action_user.offers.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_offers_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.offers.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.offers.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.offers.edit_#_id> , <#action_user.offers.edit_#_type> , <#action_user.offers.edit_#_flag> , <#action_user.offers.edit_#_name> , <#action_user.offers.edit_#_comment> , <#action_user.offers.edit_#_properties> . <#action_user.offers.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.offers.edit_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.offers.edit_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.offers.edit_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.offers.edit_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.offers.edit_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_1d1203c1c7e0c3679c9395cf66eb1829> a schema:Action ; schema:name "user_offers_get" ; schema:target <#action_user.offers.get> . <#action_user.offers.get> a schema:EntryPoint ; schema:name "EntryPoint - user_offers_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.offers.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.offers.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.offers.get_#_id> . <#action_user.offers.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_e672214e6c9e8e75ae37c84a96f63297> a schema:Action ; schema:name "user_offers_list" ; schema:target <#action_user.offers.list> . <#action_user.offers.list> a schema:EntryPoint ; schema:name "EntryPoint - user_offers_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.offers.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.offers.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.offers.list_#_type> . <#action_user.offers.list_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_de5c458c1efcb2e4aeef1426adbb4ecf> a schema:Action ; schema:name "user_offers_new" ; schema:target <#action_user.offers.new> . <#action_user.offers.new> a schema:EntryPoint ; schema:name "EntryPoint - user_offers_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.offers.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.offers.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.offers.new_#_type> , <#action_user.offers.new_#_flag> , <#action_user.offers.new_#_name> , <#action_user.offers.new_#_comment> , <#action_user.offers.new_#_properties> . <#action_user.offers.new_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.offers.new_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.offers.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.offers.new_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.offers.new_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_7c97030b0e756dddbfb433103c475a17> a schema:Action ; schema:name "user_onlineAccounts_delete" ; schema:target <#action_user.onlineAccounts.delete> . <#action_user.onlineAccounts.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_onlineAccounts_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.onlineAccounts.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.onlineAccounts.delete> ; schema:description "An ODS user profile can contain an arbitrary number of online accounts from any service available. This function removes such an account.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the online account service provider (Examples: <computeroutput>facebook</computeroutput>, <computeroutput>disqus</computeroutput>) </parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> The service account identifier or username.</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>. On error an appropriate HTTP status code is set.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Disconnect an online account from the ODS profile. " ; oplwebsrv:hasParameter <#action_user.onlineAccounts.delete_#_name> , <#action_user.onlineAccounts.delete_#_url> . <#action_user.onlineAccounts.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The name of the online account service provider (Examples: <computeroutput>facebook</computeroutput>, <computeroutput>disqus</computeroutput>) " . <#action_user.onlineAccounts.delete_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The service account identifier or username." . <#action_36b7a808d985734d162e3b76098891ff> a schema:Action ; schema:name "user_onlineAccounts_edit" ; schema:target <#action_user.onlineAccounts.edit> . <#action_user.onlineAccounts.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_onlineAccounts_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.onlineAccounts.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.onlineAccounts.edit> ; schema:description "An ODS user profile can contain an arbitrary number of online accounts from any service available. This function change an access type of an account to 'public' or 'private'.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the online account service provider (Examples: <computeroutput>facebook</computeroutput>, <computeroutput>disqus</computeroutput>) </parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> The service account identifier or username. </parameterdescription> </li> <li> <parameternamelist> <parametername>access</parametername> </parameternamelist> <parameterdescription> The online account access type: 1 (public) or 0 (private).. </parameterdescription> </li> <li> <parameternamelist> <parametername>type</parametername> </parameternamelist> <parameterdescription> The online account type: P (personal) or B (business).</parameterdescription> </li> </ul> <simplesect kind=\"return\">An error code as defined in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>. On error an appropriate HTTP status code is set.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Edit an access type of an online account from the ODS profile. " ; oplwebsrv:hasParameter <#action_user.onlineAccounts.edit_#_name> , <#action_user.onlineAccounts.edit_#_url> , <#action_user.onlineAccounts.edit_#_access> , <#action_user.onlineAccounts.edit_#_type> . <#action_user.onlineAccounts.edit_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The name of the online account service provider (Examples: <computeroutput>facebook</computeroutput>, <computeroutput>disqus</computeroutput>) " . <#action_user.onlineAccounts.edit_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The service account identifier or username. " . <#action_user.onlineAccounts.edit_#_access> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "access" ; schema:name "access" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" ; schema:description "The online account access type: 1 (public) or 0 (private).. " . <#action_user.onlineAccounts.edit_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The online account type: P (personal) or B (business)." . <#action_74edeb21c990ffa4d8e554fd8dd13eff> a schema:Action ; schema:name "user_onlineAccounts_list" ; schema:target <#action_user.onlineAccounts.list> . <#action_user.onlineAccounts.list> a schema:EntryPoint ; schema:name "EntryPoint - user_onlineAccounts_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.onlineAccounts.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.onlineAccounts.list> ; schema:description "An ODS user profile can contain an arbitrary number of online accounts from any service available. This function lists the connected accounts.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>type</parametername> </parameternamelist> <parameterdescription> Either <computeroutput>P</computeroutput> for private accounts or <computeroutput>B</computeroutput> for business accounts.</parameterdescription> </li> </ul> The following list gives an overview of the supported services (See also <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_authentication_url_services\">Supported Services</ref>) and the identifiers used in ODS:Service Type | Identifier used | Example ---------------|-------------------------|-------- <computeroutput>facebook</computeroutput> | The profile URL | <ulink url=\"http://www.facebook.com/sebastian.trug\">http://www.facebook.com/sebastian.trug</ulink> | <computeroutput>twitter</computeroutput> | The profile URL | <ulink url=\"http://twitter.com/tmptrueg\">http://twitter.com/tmptrueg</ulink> | <computeroutput>linkedin</computeroutput> | The profile URL | <ulink url=\"https://www.linkedin.com/in/trueg\">https://www.linkedin.com/in/trueg</ulink> | <computeroutput>windowslive</computeroutput> | The profile URL | <ulink url=\"http://profile.live.com/cid-7a6b1666d21a866b/\">http://profile.live.com/cid-7a6b1666d21a866b/</ulink> | <computeroutput>google</computeroutput> | The Google Plus URL | <ulink url=\"https://plus.google.com/100942621970840297012\">https://plus.google.com/100942621970840297012</ulink> | <computeroutput>wordpress</computeroutput> | The main blog URL | <ulink url=\"http://trueg.wordpress.com\">http://trueg.wordpress.com</ulink> | <computeroutput>disqus</computeroutput> | The profile URL | <ulink url=\"http://disqus.com/strueg/\">http://disqus.com/strueg/</ulink> | <computeroutput>instagram</computeroutput> | An acct: URL | acct:176087504 | <computeroutput>yahoo</computeroutput> | The profile URL | <ulink url=\"http://profile.yahoo.com/S4KF6WXGWUBRV74G4TD6GOPCAE\">http://profile.yahoo.com/S4KF6WXGWUBRV74G4TD6GOPCAE</ulink> | <computeroutput>tumblr</computeroutput> | The profile URL | <ulink url=\"http://trueg.tumblr.com/\">http://trueg.tumblr.com/</ulink> | <computeroutput>bitly</computeroutput> | The profile URL | <ulink url=\"http://bitly.com/u/webods\">http://bitly.com/u/webods</ulink> | <computeroutput>dropbox</computeroutput> | An acct: URL | acct:trueg@dropbox.com | <computeroutput>flickr</computeroutput> | The profile URL | <ulink url=\"http://www.flickr.com/people/91384569\">http://www.flickr.com/people/91384569</ulink>@N06/ | <computeroutput>bitly</computeroutput> | The profile URL | <ulink url=\"http://bitly.com/u/strueg\">http://bitly.com/u/strueg</ulink> | <computeroutput>foursquare</computeroutput> | An acct: URL | acct:39809951@foursquare.com | <computeroutput>github</computeroutput> | The profile URL | <ulink url=\"https://api.github.com/users/trueg\">https://api.github.com/users/trueg</ulink> | <computeroutput>meetup</computeroutput> | The profile URL | <ulink url=\"http://www.meetup.com/members/73346552\">http://www.meetup.com/members/73346552</ulink> | <computeroutput>salesforce</computeroutput> | The profile URL | <ulink url=\"https://login.salesforce.com/id/00Db0000000J2hSEAS/005b0000000QUONAA4\">https://login.salesforce.com/id/00Db0000000J2hSEAS/005b0000000QUONAA4</ulink> | <computeroutput>boxnet</computeroutput> | An acct: URL | acct:189578964@box.com | <computeroutput>xing</computeroutput> | A profile URL | <ulink url=\"https://www.xing.com/profile/Max_Mustermann\">https://www.xing.com/profile/Max_Mustermann</ulink> | <computeroutput>beatport</computeroutput> | An acct: URL | acct:trueg@beatport.com | <computeroutput>amazon</computeroutput> | An acct: URL | acct:amzn1.account.AGTL7CUF4HT3FTBFX3JWF7QFGKFG@amazon.com | <computeroutput>soundcloud</computeroutput> | A profile URL | <ulink url=\"http://soundcloud.com/user922973331\">http://soundcloud.com/user922973331</ulink> | <computeroutput>webid</computeroutput> | The personal URI | <ulink url=\"http://web.ods.openlinksw.com/dataspace/person/trueg#this\">http://web.ods.openlinksw.com/dataspace/person/trueg#this</ulink> | <computeroutput>openid</computeroutput> | The OpenID URL | |<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "List connected online accounts. " ; oplwebsrv:hasParameter <#action_user.onlineAccounts.list_#_type> . <#action_user.onlineAccounts.list_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "P" ; schema:description "Either <computeroutput>P</computeroutput> for private accounts or <computeroutput>B</computeroutput> for business accounts." . <#action_da9926a1513e45b817e6f15ec9faf882> a schema:Action ; schema:name "user_onlineAccounts_new" ; schema:target <#action_user.onlineAccounts.new> . <#action_user.onlineAccounts.new> a schema:EntryPoint ; schema:name "EntryPoint - user_onlineAccounts_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.onlineAccounts.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.onlineAccounts.new> ; schema:description "An ODS user profile can contain an arbitrary number of online accounts from any service available. Only two main things are required: the name of the service and the service identifier.For many services adding an online account will result in the user being able to log into their ODS account through that service (See <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> and <ref kindref=\"member\" refid=\"group__ods__module__user_1ga974f604be99696e368122af579e4a670\">user.authenticate.webid()</ref>). In order for this connection to work properly the online accounts need to be added in a special form (be aware that the <computeroutput>connect</computeroutput> action in the mentioned authentication methods allow to add online accounts automatically).<xrefsect id=\"deprecated_1_deprecated000018\"><xreftitle>Deprecated</xreftitle><xrefdescription>Adding online accounts without authentication is not allowed anymore. Please use user.authenticate.authenticationUrl instead. </xrefdescription></xrefsect>" ; schema:shortDescription "Add a new online account to an ODS account. " ; oplwebsrv:hasParameter <#action_user.onlineAccounts.new_#_name> , <#action_user.onlineAccounts.new_#_url> , <#action_user.onlineAccounts.new_#_uri> , <#action_user.onlineAccounts.new_#_access> , <#action_user.onlineAccounts.new_#_type> , <#action_user.onlineAccounts.new_#_oauth_sid> . <#action_user.onlineAccounts.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.onlineAccounts.new_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.onlineAccounts.new_#_uri> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "uri" ; schema:name "uri" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.onlineAccounts.new_#_access> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "access" ; schema:name "access" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.onlineAccounts.new_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.onlineAccounts.new_#_oauth_sid> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "oauth_sid" ; schema:name "oauth_sid" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_69f5d32f2fd7170073a205cff531b823> a schema:Action ; schema:name "user_onlineAccounts_uri" ; schema:target <#action_user.onlineAccounts.uri> . <#action_user.onlineAccounts.uri> a schema:EntryPoint ; schema:name "EntryPoint - user_onlineAccounts_uri" ; schema:url <https://vos.openlinksw.com/ods/api/user.onlineAccounts.uri> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.onlineAccounts.uri> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.onlineAccounts.uri_#_url> . <#action_user.onlineAccounts.uri_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_4d6e56e08decb6b2422a68f5ce113c55> a schema:Action ; schema:name "user_openid_loginUrl" ; schema:target <#action_user.openid.loginUrl> . <#action_user.openid.loginUrl> a schema:EntryPoint ; schema:name "EntryPoint - user_openid_loginUrl" ; schema:url <https://vos.openlinksw.com/ods/api/user.openid.loginUrl> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.openid.loginUrl> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000010\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.openid.loginUrl_#_url> . <#action_user.openid.loginUrl_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_4d30ccc3e6f6b1167521d664f1214f11> a schema:Action ; schema:name "user_openid_registrationData" ; schema:target <#action_user.openid.registrationData> . <#action_user.openid.registrationData> a schema:EntryPoint ; schema:name "EntryPoint - user_openid_registrationData" ; schema:url <https://vos.openlinksw.com/ods/api/user.openid.registrationData> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.openid.registrationData> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000009\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use user.authentication.authenticationUrl() instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.openid.registrationData_#_url> . <#action_user.openid.registrationData_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_fcc423fd90ed7ac701ae720b51165e83> a schema:Action ; schema:name "user_owns_delete" ; schema:target <#action_user.owns.delete> . <#action_user.owns.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_owns_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.owns.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.owns.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.owns.delete_#_id> . <#action_user.owns.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_5f5768af135ac0828bc448665994de30> a schema:Action ; schema:name "user_owns_edit" ; schema:target <#action_user.owns.edit> . <#action_user.owns.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_owns_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.owns.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.owns.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.owns.edit_#_id> , <#action_user.owns.edit_#_type> , <#action_user.owns.edit_#_flag> , <#action_user.owns.edit_#_name> , <#action_user.owns.edit_#_comment> , <#action_user.owns.edit_#_properties> . <#action_user.owns.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.owns.edit_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "3" . <#action_user.owns.edit_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.owns.edit_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.owns.edit_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.owns.edit_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_ef22ce041897114f92c941bda43ff66f> a schema:Action ; schema:name "user_owns_get" ; schema:target <#action_user.owns.get> . <#action_user.owns.get> a schema:EntryPoint ; schema:name "EntryPoint - user_owns_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.owns.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.owns.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.owns.get_#_id> . <#action_user.owns.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_2181b5d57683550ed4d9af556df237b5> a schema:Action ; schema:name "user_owns_list" ; schema:target <#action_user.owns.list> . <#action_user.owns.list> a schema:EntryPoint ; schema:name "EntryPoint - user_owns_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.owns.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.owns.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.owns.list_#_type> . <#action_user.owns.list_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "3" . <#action_3345fcd06099b890890e0b1266147ac5> a schema:Action ; schema:name "user_owns_new" ; schema:target <#action_user.owns.new> . <#action_user.owns.new> a schema:EntryPoint ; schema:name "EntryPoint - user_owns_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.owns.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.owns.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.owns.new_#_type> , <#action_user.owns.new_#_flag> , <#action_user.owns.new_#_name> , <#action_user.owns.new_#_comment> , <#action_user.owns.new_#_properties> . <#action_user.owns.new_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "3" . <#action_user.owns.new_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.owns.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.owns.new_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.owns.new_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_454e9821088a774ba245ffcef0f16965> a schema:Action ; schema:name "user_password_change" ; schema:target <#action_user.password.change> . <#action_user.password.change> a schema:EntryPoint ; schema:name "EntryPoint - user_password_change" ; schema:url <https://vos.openlinksw.com/ods/api/user.password.change> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.password.change> ; schema:description "This method allows to change the password on a user account. Since passwords are transmitted in plain text it is recommended to use an encrypted connection.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>old_password</parametername> </parameternamelist> <parameterdescription> The old password in plain text. The old password can be omitted if the pwd is changed for the first time. Alternatively <computeroutput>old_password</computeroutput> can be set to the pin as generated by <ref kindref=\"member\" refid=\"group__ods__module__user_1ga51949c776742c1f3b5c16d49e5d4fd02\">user.password.recover.email()</ref>. </parameterdescription> </li> <li> <parameternamelist> <parametername>new_password</parametername> </parameternamelist> <parameterdescription> The new password in plain text.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>. On error the HTTP status code will be set to <computeroutput>403</computeroutput> or <computeroutput>400</computeroutput>, depending on the type of error.</simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/user.password.change?user_name=test123&password_hash=4674a4b44e89011cfa581ff90967ebc52fd1080d&old_password=1&new_password=2\" HTTP/1.1 200 OK Server: Virtuoso/05.12.3041 (Solaris) x86_64-sun-solaris2.10-64 VDB Connection: Keep-Alive Date: Mon, 28 Dec 2009 22:46:56 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"ISO-8859-1\" Content-Length: 57 <result> <code>1</code> <message>Success</message> </result> </pre><simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga51949c776742c1f3b5c16d49e5d4fd02\">user.password.recover.email()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Change the password of a user account. " ; oplwebsrv:hasParameter <#action_user.password.change_#_old_password> , <#action_user.password.change_#_new_password> . <#action_user.password.change_#_old_password> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "old_password" ; schema:name "old_password" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The old password in plain text. The old password can be omitted if the pwd is changed for the first time. Alternatively <computeroutput>old_password</computeroutput> can be set to the pin as generated by <ref kindref=\"member\" refid=\"group__ods__module__user_1ga51949c776742c1f3b5c16d49e5d4fd02\">user.password.recover.email()</ref>. " . <#action_user.password.change_#_new_password> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "new_password" ; schema:name "new_password" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The new password in plain text." . <#action_51949c776742c1f3b5c16d49e5d4fd02> a schema:Action ; schema:name "user_password_recover_email" ; schema:target <#action_user.password.recover.email> . <#action_user.password.recover.email> a schema:EntryPoint ; schema:name "EntryPoint - user_password_recover_email" ; schema:url <https://vos.openlinksw.com/ods/api/user.password.recover.email> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.password.recover.email> ; schema:description "This method can be used to send a password reminder email to an account owner. The email will contain a link that can be used to change the password of the account in question.ODS uses a template to create the password reminder emails. This template can contain a set of variables that will be replaced with the appropriate values:<itemizedlist> <listitem><computeroutput>%username%</computeroutput> - The user name of the account.</listitem><listitem><computeroutput>%fullname%</computeroutput> - The full name configured in the account, username as fallback.</listitem><listitem><computeroutput>%pwdchangeurl%</computeroutput> - The URL to the password changing page. This can be configured via <ref kindref=\"member\" refid=\"group__ods__module__admin_1gadd8898e6ee5bf737acd77741115e9d61\">admin.config.set()</ref> and config option <computeroutput>templates.urls.passwordChange</computeroutput> which is a template which contains two variables: <computeroutput>%sid%</computeroutput> and <computeroutput>%pin%</computeroutput> which are the session id and the password recovery PIN respectively. The latter can be used instead of the old password in <ref kindref=\"member\" refid=\"group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965\">user.password.change()</ref>.</listitem></itemizedlist> The template is stored in the Virtuoso DAV system and can easily be changed by uploading a new file and configuring its path to be the new password reminder email template via admin.config.set and config option <computeroutput>templates.emails.passwordReminder</computeroutput>.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>username</parametername> </parameternamelist> <parameterdescription> The account for which a password reminded should be sent. </parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> Alternatively to the username the account email can be provided. </parameterdescription> </li> <li> <parameternamelist> <parametername>pwdChangeUrl</parametername> </parameternamelist> <parameterdescription> The password recovery page which should be used in the email. Only URLs on registered clients are allowed (see also <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga675af873f023acb812a8d7694a1d3b9f\">admin.clients.new()</ref>). This parameter is a template which contains two variables: <computeroutput>%sid%</computeroutput> and <computeroutput>%pin%</computeroutput> which are the session id and the password recovery PIN respectively. The latter can be used instead of the old password in <ref kindref=\"member\" refid=\"group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965\">user.password.change()</ref>.</parameterdescription> </li> </ul> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965\">user.password.change()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "Send a password reminder email to an account owner. " ; oplwebsrv:hasParameter <#action_user.password.recover.email_#_username> , <#action_user.password.recover.email_#_email> , <#action_user.password.recover.email_#_pwdChangeUrl> . <#action_user.password.recover.email_#_username> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "username" ; schema:name "username" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The account for which a password reminded should be sent. " . <#action_user.password.recover.email_#_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "email" ; schema:name "email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "Alternatively to the username the account email can be provided. " . <#action_user.password.recover.email_#_pwdChangeUrl> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "pwdChangeUrl" ; schema:name "pwdChangeUrl" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The password recovery page which should be used in the email. Only URLs on registered clients are allowed (see also <ref kindref=\"member\" refid=\"group__ods__module__admin_1ga675af873f023acb812a8d7694a1d3b9f\">admin.clients.new()</ref>). This parameter is a template which contains two variables: <computeroutput>%sid%</computeroutput> and <computeroutput>%pin%</computeroutput> which are the session id and the password recovery PIN respectively. The latter can be used instead of the old password in <ref kindref=\"member\" refid=\"group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965\">user.password.change()</ref>." . <#action_13c32dc03db0eaa27d7af5219f8aac86> a schema:Action ; schema:name "user_password_change" ; schema:target <#action_user.password_change> . <#action_user.password_change> a schema:EntryPoint ; schema:name "EntryPoint - user_password_change" ; schema:url <https://vos.openlinksw.com/ods/api/user.password_change> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.password_change> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000012\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use <ref kindref=\"member\" refid=\"group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965\">user.password.change()</ref> instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.password_change_#_old_password> , <#action_user.password_change_#_new_password> . <#action_user.password_change_#_old_password> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "old_password" ; schema:name "old_password" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.password_change_#_new_password> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "new_password" ; schema:name "new_password" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_44832721d52264f13a216cba592fb11c> a schema:Action ; schema:name "user_profile_import" ; schema:target <#action_user.profile.import> . <#action_user.profile.import> a schema:EntryPoint ; schema:name "EntryPoint - user_profile_import" ; schema:url <https://vos.openlinksw.com/ods/api/user.profile.import> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.profile.import> ; schema:description "ODS supports profile import from a variety of services thanks to the power of Virtuoso's Sponger cartridges. This API method uses the Sponger to fetch profile details from another service and optionally merge them into the ODS profile.The method has two modes of operations:<itemizedlist> <listitem>Clients can either provide a <computeroutput>serviceId</computeroutput> which is already connected to the authenticated user account (see <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>) to import the data directly from the third-party service.</listitem><listitem>Or they can provide a blob of FOAF or VCard data in any of the supported RDF serializations in the request body.</listitem></itemizedlist> Be aware that the method will signal an error if no profile data can be found, ie. if there is no Sponger cartridge available to handle the given service.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>service</parametername> </parameternamelist> <parameterdescription> The service type like \"facebook\" or \"webid\" </parameterdescription> </li> <li> <parameternamelist> <parametername>serviceId</parametername> </parameternamelist> <parameterdescription> The identifier like the facebook profile URL or the actual WebID. If empty, the data is read from the HTTP request body. Before being able to import profile details the service ID first has to be connected to the authenticated ODS account. This is typically done via <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>. </parameterdescription> </li> <li> <parameternamelist> <parametername>target</parametername> </parameternamelist> <parameterdescription> Where to import the profile data to. This can be one of <computeroutput>personal</computeroutput>, <computeroutput>business</computeroutput>, or <computeroutput>none</computeroutput>. In the latter case the data is only imported into a private data graph but not into the ODS profile. </parameterdescription> </li> <li> <parameternamelist> <parametername>keepGraph</parametername> </parameternamelist> <parameterdescription> If <computeroutput>keep</computeroutput> then the profile data will be kept in a private data graph in addition to storing it in the ODS profile. If <computeroutput>clear</computeroutput> then the original data will be thrown away after import. Be aware that a <computeroutput>target</computeroutput> value of <computeroutput>none</computeroutput> in combination with a <computeroutput>keepGraph</computeroutput> value of <computeroutput>clear</computeroutput> does not make much sense.</parameterdescription> </li> </ul> On error an appropriate HTTP status code will be set.<simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1gaa383784d1c31a23a5687ddc25485e4e4\">user.dataGraphs.list()</ref> </simplesect> " ; schema:shortDescription "Import profile data from another service or from a data stream. " ; oplwebsrv:hasParameter <#action_user.profile.import_#_service> , <#action_user.profile.import_#_serviceId> , <#action_user.profile.import_#_target> , <#action_user.profile.import_#_keepGraph> . <#action_user.profile.import_#_service> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "service" ; schema:name "service" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The service type like \"facebook\" or \"webid\" " . <#action_user.profile.import_#_serviceId> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "serviceId" ; schema:name "serviceId" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The identifier like the facebook profile URL or the actual WebID. If empty, the data is read from the HTTP request body. Before being able to import profile details the service ID first has to be connected to the authenticated ODS account. This is typically done via <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref>. " . <#action_user.profile.import_#_target> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "target" ; schema:name "target" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "personal" ; schema:description "Where to import the profile data to. This can be one of <computeroutput>personal</computeroutput>, <computeroutput>business</computeroutput>, or <computeroutput>none</computeroutput>. In the latter case the data is only imported into a private data graph but not into the ODS profile. " . <#action_user.profile.import_#_keepGraph> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "keepGraph" ; schema:name "keepGraph" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "keep" ; schema:description "If <computeroutput>keep</computeroutput> then the profile data will be kept in a private data graph in addition to storing it in the ODS profile. If <computeroutput>clear</computeroutput> then the original data will be thrown away after import. Be aware that a <computeroutput>target</computeroutput> value of <computeroutput>none</computeroutput> in combination with a <computeroutput>keepGraph</computeroutput> value of <computeroutput>clear</computeroutput> does not make much sense." . <#action_bff5adf64d0a8d144eea3bf00c186825> a schema:Action ; schema:name "user_register" ; schema:target <#action_user.register> . <#action_user.register> a schema:EntryPoint ; schema:name "EntryPoint - user_register" ; schema:url <https://vos.openlinksw.com/ods/api/user.register> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.register> ; schema:description "ODS allows to register new accounts in several ways, ranging from simple a username/password combination to registration through an existing Twitter account. Some registration methods such as the registration via OAuth or OpenID requires more than one step. This function is used for classicaly username/password registration. Other registration methods like WebID, OpenID, or any OAuth-based service are supported through the <computeroutput>register</computeroutput> action in <ref kindref=\"member\" refid=\"group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8\">user.authenticate.authenticationUrl()</ref> and <ref kindref=\"member\" refid=\"group__ods__module__user_1ga974f604be99696e368122af579e4a670\">user.authenticate.webid()</ref>.For security reasons it is highly recommended to perform any registration calls through a secure connection.Registration via username and password is as easy as calling <ref kindref=\"member\" refid=\"group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825\">user.register()</ref> with the <computeroutput>name</computeroutput>, <computeroutput>password</computeroutput>, and <computeroutput>email</computeroutput> parameters filled. If the <computeroutput>name</computeroutput> is not in use yet and the <computeroutput>email</computeroutput> address is either unique or ODS has been configured to allow non-unique email addresses, then a new user account will be created which can immediately be used for <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.<simplesect kind=\"par\"><title>Post Registration</title>ODS accounts which have not beed created with a classical password have a random password which can be changed later on via <ref kindref=\"member\" refid=\"group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965\">user.password.change()</ref> to enable classical <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_password_hash\">Password Hash Authentication</ref>. In addition any of the supported registration and authentication methods can be added to an existing account at any time through the <ref kindref=\"member\" refid=\"group__ods__module__user_1ga0ee8a3214520a223cd188b1ed0b65784\">user.update()</ref> or <ref kindref=\"member\" refid=\"group__ods__module__user_1ga777818aa3df3994ecb3fc581e691c18a\">user.update.fields()</ref> functions.</simplesect> <parameterlist kind=\"param\"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The user name for the new account. </parameterdescription> </li> <li> <parameternamelist> <parametername>password</parametername> </parameternamelist> <parameterdescription> The password for the new account. </parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> The email address for the new account. </parameterdescription> </li> <li> <parameternamelist> <parametername>mode</parametername> </parameternamelist> <parameterdescription> <emphasis>deprecated</emphasis> </parameterdescription> </li> <li> <parameternamelist> <parametername>data</parametername> </parameternamelist> <parameterdescription> <emphasis>deprecated</emphasis> </parameterdescription> </li> </ul> <simplesect kind=\"return\">On success a new user session as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_user_session_example\">Example User Session:</ref> is returned which can be used as described in <ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_session_id\">Authentication via Session Id</ref>. On error an appropriate HTTP status code is set and an error message as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref> is returned.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"ods_authentication_1ods_authentication_oauth\">Authentication via OAuth</ref></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/user.register?name=test123&password=1&email=test@yahoo.com\" HTTP/1.1 200 OK Server: Virtuoso/05.12.3041 (Solaris) x86_64-sun-solaris2.10-64 VDB Connection: Keep-Alive Date: Mon, 28 Dec 2009 22:18:59 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"ISO-8859-1\" Content-Length: 59 <userSession> <sid>1de236f5da2f32d92e8c0cce5053a96e</sid> <user> <uname>test123</uname> <uid>132</uid> <new>1</new> <dba>0</dba> </user> </userSession> </pre><simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "Register a new user account. " ; oplwebsrv:hasParameter <#action_user.register_#_name> , <#action_user.register_#_password> , <#action_user.register_#_email> , <#action_user.register_#_mode> , <#action_user.register_#_data> . <#action_user.register_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user name for the new account. " . <#action_user.register_#_password> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "password" ; schema:name "password" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The password for the new account. " . <#action_user.register_#_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "email" ; schema:name "email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The email address for the new account. " . <#action_user.register_#_mode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "mode" ; schema:name "mode" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "0" ; schema:description "<emphasis>deprecated</emphasis> " . <#action_user.register_#_data> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "data" ; schema:name "data" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "<emphasis>deprecated</emphasis> " . <#action_ed278f53a1c3b676a7bfa90300bd787c> a schema:Action ; schema:name "user_relation_delete" ; schema:target <#action_user.relation.delete> . <#action_user.relation.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_relation_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.relation.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.relation.delete> ; schema:description "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.This method allows to remove a connection that has been created through an approved invitation.<simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga3937eecbf3d82e29667c487f4c404e3f\">user.invitation.new()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1ga33086cfe66b0e314e5b8a3e83ae33437\">user.invitation.list()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Delete a connection to another user. " ; oplwebsrv:hasParameter <#action_user.relation.delete_#_friend> . <#action_user.relation.delete_#_friend> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "friend" ; schema:name "friend" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_09e8a2b568e0a2ab718d062a7864f6b2> a schema:Action ; schema:name "user_relation_terminate" ; schema:target <#action_user.relation_terminate> . <#action_user.relation_terminate> a schema:EntryPoint ; schema:name "EntryPoint - user_relation_terminate" ; schema:url <https://vos.openlinksw.com/ods/api/user.relation_terminate> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.relation_terminate> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000017\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use <ref kindref=\"member\" refid=\"group__ods__module__user_1gaed278f53a1c3b676a7bfa90300bd787c\">user.relation.delete()</ref> instead. </xrefdescription></xrefsect>" ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.relation_terminate_#_friend> . <#action_user.relation_terminate_#_friend> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "friend" ; schema:name "friend" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_53a3a01c23b0bd22c6f8b5a5c8b93407> a schema:Action ; schema:name "user_relation_update" ; schema:target <#action_user.relation_update> . <#action_user.relation_update> a schema:EntryPoint ; schema:name "EntryPoint - user_relation_update" ; schema:url <https://vos.openlinksw.com/ods/api/user.relation_update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.relation_update> ; schema:shortDescription "Change connection details. FIXME: this does nothing! " ; oplwebsrv:hasParameter <#action_user.relation_update_#_friend> , <#action_user.relation_update_#_relation_details> . <#action_user.relation_update_#_friend> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "friend" ; schema:name "friend" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.relation_update_#_relation_details> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "relation_details" ; schema:name "relation_details" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_4a14817a0eca5c100dc15d0621f5db02> a schema:Action ; schema:name "user_search" ; schema:target <#action_user.search> . <#action_user.search> a schema:EntryPoint ; schema:name "EntryPoint - user_search" ; schema:url <https://vos.openlinksw.com/ods/api/user.search> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.search> ; schema:description "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>pattern</parametername> </parameternamelist> <parameterdescription> An SQL contains pattern.</parameterdescription> </li> </ul> <simplesect kind=\"return\">A SPARQL query result with fields <computeroutput>user</computeroutput>, <computeroutput>property</computeroutput>, and <computeroutput>value</computeroutput>.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function does not require any authentication. </simplesect> " ; schema:shortDescription "Search for a user. " ; oplwebsrv:hasParameter <#action_user.search_#_pattern> . <#action_user.search_#_pattern> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "pattern" ; schema:name "pattern" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "An SQL contains pattern." . <#action_84bde539ffa09ed354e538962177f350> a schema:Action ; schema:name "user_seeks_delete" ; schema:target <#action_user.seeks.delete> . <#action_user.seeks.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_seeks_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.seeks.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.seeks.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.seeks.delete_#_id> . <#action_user.seeks.delete_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_8393abcc162d8c1e9d4ec0eb781519de> a schema:Action ; schema:name "user_seeks_edit" ; schema:target <#action_user.seeks.edit> . <#action_user.seeks.edit> a schema:EntryPoint ; schema:name "EntryPoint - user_seeks_edit" ; schema:url <https://vos.openlinksw.com/ods/api/user.seeks.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.seeks.edit> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.seeks.edit_#_id> , <#action_user.seeks.edit_#_type> , <#action_user.seeks.edit_#_flag> , <#action_user.seeks.edit_#_name> , <#action_user.seeks.edit_#_comment> , <#action_user.seeks.edit_#_properties> . <#action_user.seeks.edit_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.seeks.edit_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "2" . <#action_user.seeks.edit_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.seeks.edit_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.seeks.edit_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.seeks.edit_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_1bf6fe6fccafb1adf6af9942407ee6c4> a schema:Action ; schema:name "user_seeks_get" ; schema:target <#action_user.seeks.get> . <#action_user.seeks.get> a schema:EntryPoint ; schema:name "EntryPoint - user_seeks_get" ; schema:url <https://vos.openlinksw.com/ods/api/user.seeks.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.seeks.get> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.seeks.get_#_id> . <#action_user.seeks.get_#_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "id" ; schema:name "id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_a5d73f8ca8a1759c75487303857c221b> a schema:Action ; schema:name "user_seeks_list" ; schema:target <#action_user.seeks.list> . <#action_user.seeks.list> a schema:EntryPoint ; schema:name "EntryPoint - user_seeks_list" ; schema:url <https://vos.openlinksw.com/ods/api/user.seeks.list> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.seeks.list> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" . <#action_a2a5c29541fd9a2aa1750da6c7c3cf48> a schema:Action ; schema:name "user_seeks_new" ; schema:target <#action_user.seeks.new> . <#action_user.seeks.new> a schema:EntryPoint ; schema:name "EntryPoint - user_seeks_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.seeks.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.seeks.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.seeks.new_#_type> , <#action_user.seeks.new_#_flag> , <#action_user.seeks.new_#_name> , <#action_user.seeks.new_#_comment> , <#action_user.seeks.new_#_properties> . <#action_user.seeks.new_#_type> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "type" ; schema:name "type" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "2" . <#action_user.seeks.new_#_flag> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "flag" ; schema:name "flag" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_user.seeks.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.seeks.new_#_comment> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment" ; schema:name "comment" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.seeks.new_#_properties> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "properties" ; schema:name "properties" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_590988d4501680d3842e4f6c45f7a399> a schema:Action ; schema:name "user_tagging_rules_add" ; schema:target <#action_user.tagging_rules.add> . <#action_user.tagging_rules.add> a schema:EntryPoint ; schema:name "EntryPoint - user_tagging_rules_add" ; schema:url <https://vos.openlinksw.com/ods/api/user.tagging_rules.add> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.tagging_rules.add> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.tagging_rules.add_#_rulelist_name> , <#action_user.tagging_rules.add_#_rules> , <#action_user.tagging_rules.add_#_is_public> . <#action_user.tagging_rules.add_#_rulelist_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rulelist_name" ; schema:name "rulelist_name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.tagging_rules.add_#_rules> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rules" ; schema:name "rules" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.tagging_rules.add_#_is_public> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "is_public" ; schema:name "is_public" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; oplwebsrv:parameterExampleValue "1" . <#action_48d34c70383a8a61eca6e2a038728bed> a schema:Action ; schema:name "user_tagging_rules_delete" ; schema:target <#action_user.tagging_rules.delete> . <#action_user.tagging_rules.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_tagging_rules_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.tagging_rules.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.tagging_rules.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.tagging_rules.delete_#_rulelist_name> . <#action_user.tagging_rules.delete_#_rulelist_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rulelist_name" ; schema:name "rulelist_name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_2ee5c858e3093c0bc9dd67aa6ee15fc8> a schema:Action ; schema:name "user_tagging_rules_update" ; schema:target <#action_user.tagging_rules.update> . <#action_user.tagging_rules.update> a schema:EntryPoint ; schema:name "EntryPoint - user_tagging_rules_update" ; schema:url <https://vos.openlinksw.com/ods/api/user.tagging_rules.update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.tagging_rules.update> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.tagging_rules.update_#_rulelist_name> , <#action_user.tagging_rules.update_#_rules> . <#action_user.tagging_rules.update_#_rulelist_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rulelist_name" ; schema:name "rulelist_name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.tagging_rules.update_#_rules> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "rules" ; schema:name "rules" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_e66454567e88ef6de5c7bf836025d308> a schema:Action ; schema:name "user_thingOfInterest_delete" ; schema:target <#action_user.thingOfInterest.delete> . <#action_user.thingOfInterest.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_thingOfInterest_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.thingOfInterest.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.thingOfInterest.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.thingOfInterest.delete_#_thingURI> . <#action_user.thingOfInterest.delete_#_thingURI> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "thingURI" ; schema:name "thingURI" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_7f589b9c2410f02aeaff41d4e054d735> a schema:Action ; schema:name "user_thingOfInterest_new" ; schema:target <#action_user.thingOfInterest.new> . <#action_user.thingOfInterest.new> a schema:EntryPoint ; schema:name "EntryPoint - user_thingOfInterest_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.thingOfInterest.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.thingOfInterest.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.thingOfInterest.new_#_thingURI> , <#action_user.thingOfInterest.new_#_thingLabel> . <#action_user.thingOfInterest.new_#_thingURI> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "thingURI" ; schema:name "thingURI" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.thingOfInterest.new_#_thingLabel> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "thingLabel" ; schema:name "thingLabel" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_41282c102ba666f7c49f212b6bcf1afa> a schema:Action ; schema:name "user_topicOfInterest_delete" ; schema:target <#action_user.topicOfInterest.delete> . <#action_user.topicOfInterest.delete> a schema:EntryPoint ; schema:name "EntryPoint - user_topicOfInterest_delete" ; schema:url <https://vos.openlinksw.com/ods/api/user.topicOfInterest.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.topicOfInterest.delete> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.topicOfInterest.delete_#_topicURI> . <#action_user.topicOfInterest.delete_#_topicURI> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "topicURI" ; schema:name "topicURI" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_76e99d5d1f8306ec6a003747917129be> a schema:Action ; schema:name "user_topicOfInterest_new" ; schema:target <#action_user.topicOfInterest.new> . <#action_user.topicOfInterest.new> a schema:EntryPoint ; schema:name "EntryPoint - user_topicOfInterest_new" ; schema:url <https://vos.openlinksw.com/ods/api/user.topicOfInterest.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.topicOfInterest.new> ; schema:description "<simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_user.topicOfInterest.new_#_topicURI> , <#action_user.topicOfInterest.new_#_topicLabel> . <#action_user.topicOfInterest.new_#_topicURI> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "topicURI" ; schema:name "topicURI" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_user.topicOfInterest.new_#_topicLabel> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "topicLabel" ; schema:name "topicLabel" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> . <#action_0ee8a3214520a223cd188b1ed0b65784> a schema:Action ; schema:name "user_update" ; schema:target <#action_user.update> . <#action_user.update> a schema:EntryPoint ; schema:name "EntryPoint - user_update" ; schema:url <https://vos.openlinksw.com/ods/api/user.update> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.update> ; schema:description "This method allows to update any key/value pair in the user profile.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>user_info</parametername> </parameternamelist> <parameterdescription> A comma-separated list of <computeroutput>key=value</computeroutput> pairs identifying details in the user profile of the authenticated user. The following keys are supported:<itemizedlist> <listitem><computeroutput>WAUI_TITLE</computeroutput> </listitem><listitem><computeroutput>WAUI_FIRST_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_LAST_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_FULL_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_GENDER</computeroutput> </listitem><listitem><computeroutput>WAUI_BIRTHDAY</computeroutput> </listitem><listitem><computeroutput>WAUI_WEBPAGE</computeroutput> </listitem><listitem><computeroutput>WAUI_MSIGNATURE</computeroutput> </listitem><listitem><computeroutput>WAUI_ICQ</computeroutput> </listitem><listitem><computeroutput>WAUI_SKYPE</computeroutput> </listitem><listitem><computeroutput>WAUI_AIM</computeroutput> </listitem><listitem><computeroutput>WAUI_YAHOO</computeroutput> </listitem><listitem><computeroutput>WAUI_MSN</computeroutput> </listitem><listitem><computeroutput>WAUI_HADDRESS1</computeroutput> </listitem><listitem><computeroutput>WAUI_HADDRESS2</computeroutput> </listitem><listitem><computeroutput>WAUI_HCODE</computeroutput> </listitem><listitem><computeroutput>WAUI_HCITY</computeroutput> </listitem><listitem><computeroutput>WAUI_HSTATE</computeroutput> </listitem><listitem><computeroutput>WAUI_HCOUNTRY</computeroutput> </listitem><listitem><computeroutput>WAUI_HTZONE</computeroutput> </listitem><listitem><computeroutput>WAUI_HPHONE</computeroutput> </listitem><listitem><computeroutput>WAUI_HPHONE_EXT</computeroutput> </listitem><listitem><computeroutput>WAUI_HMOBILE</computeroutput> </listitem><listitem><computeroutput>WAUI_BINDUSTRY</computeroutput> </listitem><listitem><computeroutput>WAUI_BORG</computeroutput> </listitem><listitem><computeroutput>WAUI_BJOB</computeroutput> </listitem><listitem><computeroutput>WAUI_BADDRESS1</computeroutput> </listitem><listitem><computeroutput>WAUI_BADDRESS2</computeroutput> </listitem><listitem><computeroutput>WAUI_BCODE</computeroutput> </listitem><listitem><computeroutput>WAUI_BCITY</computeroutput> </listitem><listitem><computeroutput>WAUI_BSTATE</computeroutput> </listitem><listitem><computeroutput>WAUI_BCOUNTRY</computeroutput> </listitem><listitem><computeroutput>WAUI_BTZONE</computeroutput> </listitem><listitem><computeroutput>WAUI_BLAT</computeroutput> </listitem><listitem><computeroutput>WAUI_BLNG</computeroutput> </listitem><listitem><computeroutput>WAUI_BPHONE</computeroutput> </listitem><listitem><computeroutput>WAUI_BPHONE_EXT</computeroutput> </listitem><listitem><computeroutput>WAUI_BMOBILE</computeroutput> </listitem><listitem><computeroutput>WAUI_BREGNO</computeroutput> </listitem><listitem><computeroutput>WAUI_BCAREER</computeroutput> </listitem><listitem><computeroutput>WAUI_BEMPTOTAL</computeroutput> </listitem><listitem><computeroutput>WAUI_BVENDOR</computeroutput> </listitem><listitem><computeroutput>WAUI_BSERVICE</computeroutput> </listitem><listitem><computeroutput>WAUI_BOTHER</computeroutput> </listitem><listitem><computeroutput>WAUI_BNETWORK</computeroutput> </listitem><listitem><computeroutput>WAUI_SUMMARY</computeroutput> </listitem><listitem><computeroutput>WAUI_RESUME</computeroutput> </listitem><listitem><computeroutput>WAUI_SEC_QUESTION</computeroutput> </listitem><listitem><computeroutput>WAUI_SEC_ANSWER</computeroutput> </listitem><listitem><computeroutput>WAUI_PHOTO_URL</computeroutput> </listitem><listitem><computeroutput>WAUI_TEMPLATE</computeroutput> </listitem><listitem><computeroutput>WAUI_LAT</computeroutput> </listitem><listitem><computeroutput>WAUI_LNG</computeroutput> </listitem><listitem><computeroutput>WAUI_LATLNG_VISIBLE</computeroutput> </listitem><listitem><computeroutput>WAUI_USER_SEARCHABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_AUDIO_CLIP</computeroutput> </listitem><listitem><computeroutput>WAUI_FAVORITE_BOOKS</computeroutput> </listitem><listitem><computeroutput>WAUI_FAVORITE_MUSIC</computeroutput> </listitem><listitem><computeroutput>WAUI_FAVORITE_MOVIES</computeroutput> </listitem><listitem><computeroutput>WAUI_SEARCHABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_SHOWACTIVE</computeroutput> </listitem><listitem><computeroutput>WAUI_LATLNG_HBDEF</computeroutput> </listitem><listitem><computeroutput>WAUI_SITE_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_INTERESTS</computeroutput> </listitem><listitem><computeroutput>WAUI_INTEREST_TOPICS</computeroutput> </listitem><listitem><computeroutput>WAUI_BORG_HOMEPAGE</computeroutput> </listitem><listitem><computeroutput>WAUI_OPENID_URL</computeroutput> </listitem><listitem><computeroutput>WAUI_OPENID_SERVER</computeroutput> </listitem><listitem><computeroutput>WAUI_FACEBOOK_ID</computeroutput> </listitem><listitem><computeroutput>WAUI_IS_ORG</computeroutput> </listitem><listitem><computeroutput>WAUI_APP_ENABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_SPB_ENABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_NICK</computeroutput> </listitem><listitem><computeroutput>WAUI_BICQ</computeroutput> </listitem><listitem><computeroutput>WAUI_BSKYPE</computeroutput> </listitem><listitem><computeroutput>WAUI_BAIM</computeroutput> </listitem><listitem><computeroutput>WAUI_BYAHOO</computeroutput> </listitem><listitem><computeroutput>WAUI_BMSN</computeroutput> </listitem><listitem><computeroutput>WAUI_MESSAGING</computeroutput> </listitem><listitem><computeroutput>WAUI_BMESSAGING</computeroutput> </listitem><listitem><computeroutput>WAUI_CERT_LOGIN</computeroutput> </listitem><listitem><computeroutput>WAUI_CERT_FINGERPRINT</computeroutput> </listitem><listitem><computeroutput>WAUI_CERT</computeroutput> </listitem><listitem><computeroutput>WAUI_ACL</computeroutput> - A serialized array of ACLs which is nearly impossible to create as a client since the serialization requires an internal Virtuoso function called serialize().</listitem><listitem><computeroutput>WAUI_SALMON_KEY</computeroutput> </listitem><listitem><computeroutput>WAUI_SETTINGS</computeroutput> </listitem><listitem><computeroutput>WAUI_JOIN_DATE</computeroutput> </listitem><listitem><computeroutput>WAUI_FOAF</computeroutput> </listitem></itemizedlist> </parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga777818aa3df3994ecb3fc581e691c18a\">user.update.fields()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Change user profile information. " ; oplwebsrv:hasParameter <#action_user.update_#_user_info> . <#action_user.update_#_user_info> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "user_info" ; schema:name "user_info" ; # oplwebsrv:parameterType "any" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "A comma-separated list of <computeroutput>key=value</computeroutput> pairs identifying details in the user profile of the authenticated user. The following keys are supported:<itemizedlist> <listitem><computeroutput>WAUI_TITLE</computeroutput> </listitem><listitem><computeroutput>WAUI_FIRST_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_LAST_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_FULL_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_GENDER</computeroutput> </listitem><listitem><computeroutput>WAUI_BIRTHDAY</computeroutput> </listitem><listitem><computeroutput>WAUI_WEBPAGE</computeroutput> </listitem><listitem><computeroutput>WAUI_MSIGNATURE</computeroutput> </listitem><listitem><computeroutput>WAUI_ICQ</computeroutput> </listitem><listitem><computeroutput>WAUI_SKYPE</computeroutput> </listitem><listitem><computeroutput>WAUI_AIM</computeroutput> </listitem><listitem><computeroutput>WAUI_YAHOO</computeroutput> </listitem><listitem><computeroutput>WAUI_MSN</computeroutput> </listitem><listitem><computeroutput>WAUI_HADDRESS1</computeroutput> </listitem><listitem><computeroutput>WAUI_HADDRESS2</computeroutput> </listitem><listitem><computeroutput>WAUI_HCODE</computeroutput> </listitem><listitem><computeroutput>WAUI_HCITY</computeroutput> </listitem><listitem><computeroutput>WAUI_HSTATE</computeroutput> </listitem><listitem><computeroutput>WAUI_HCOUNTRY</computeroutput> </listitem><listitem><computeroutput>WAUI_HTZONE</computeroutput> </listitem><listitem><computeroutput>WAUI_HPHONE</computeroutput> </listitem><listitem><computeroutput>WAUI_HPHONE_EXT</computeroutput> </listitem><listitem><computeroutput>WAUI_HMOBILE</computeroutput> </listitem><listitem><computeroutput>WAUI_BINDUSTRY</computeroutput> </listitem><listitem><computeroutput>WAUI_BORG</computeroutput> </listitem><listitem><computeroutput>WAUI_BJOB</computeroutput> </listitem><listitem><computeroutput>WAUI_BADDRESS1</computeroutput> </listitem><listitem><computeroutput>WAUI_BADDRESS2</computeroutput> </listitem><listitem><computeroutput>WAUI_BCODE</computeroutput> </listitem><listitem><computeroutput>WAUI_BCITY</computeroutput> </listitem><listitem><computeroutput>WAUI_BSTATE</computeroutput> </listitem><listitem><computeroutput>WAUI_BCOUNTRY</computeroutput> </listitem><listitem><computeroutput>WAUI_BTZONE</computeroutput> </listitem><listitem><computeroutput>WAUI_BLAT</computeroutput> </listitem><listitem><computeroutput>WAUI_BLNG</computeroutput> </listitem><listitem><computeroutput>WAUI_BPHONE</computeroutput> </listitem><listitem><computeroutput>WAUI_BPHONE_EXT</computeroutput> </listitem><listitem><computeroutput>WAUI_BMOBILE</computeroutput> </listitem><listitem><computeroutput>WAUI_BREGNO</computeroutput> </listitem><listitem><computeroutput>WAUI_BCAREER</computeroutput> </listitem><listitem><computeroutput>WAUI_BEMPTOTAL</computeroutput> </listitem><listitem><computeroutput>WAUI_BVENDOR</computeroutput> </listitem><listitem><computeroutput>WAUI_BSERVICE</computeroutput> </listitem><listitem><computeroutput>WAUI_BOTHER</computeroutput> </listitem><listitem><computeroutput>WAUI_BNETWORK</computeroutput> </listitem><listitem><computeroutput>WAUI_SUMMARY</computeroutput> </listitem><listitem><computeroutput>WAUI_RESUME</computeroutput> </listitem><listitem><computeroutput>WAUI_SEC_QUESTION</computeroutput> </listitem><listitem><computeroutput>WAUI_SEC_ANSWER</computeroutput> </listitem><listitem><computeroutput>WAUI_PHOTO_URL</computeroutput> </listitem><listitem><computeroutput>WAUI_TEMPLATE</computeroutput> </listitem><listitem><computeroutput>WAUI_LAT</computeroutput> </listitem><listitem><computeroutput>WAUI_LNG</computeroutput> </listitem><listitem><computeroutput>WAUI_LATLNG_VISIBLE</computeroutput> </listitem><listitem><computeroutput>WAUI_USER_SEARCHABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_AUDIO_CLIP</computeroutput> </listitem><listitem><computeroutput>WAUI_FAVORITE_BOOKS</computeroutput> </listitem><listitem><computeroutput>WAUI_FAVORITE_MUSIC</computeroutput> </listitem><listitem><computeroutput>WAUI_FAVORITE_MOVIES</computeroutput> </listitem><listitem><computeroutput>WAUI_SEARCHABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_SHOWACTIVE</computeroutput> </listitem><listitem><computeroutput>WAUI_LATLNG_HBDEF</computeroutput> </listitem><listitem><computeroutput>WAUI_SITE_NAME</computeroutput> </listitem><listitem><computeroutput>WAUI_INTERESTS</computeroutput> </listitem><listitem><computeroutput>WAUI_INTEREST_TOPICS</computeroutput> </listitem><listitem><computeroutput>WAUI_BORG_HOMEPAGE</computeroutput> </listitem><listitem><computeroutput>WAUI_OPENID_URL</computeroutput> </listitem><listitem><computeroutput>WAUI_OPENID_SERVER</computeroutput> </listitem><listitem><computeroutput>WAUI_FACEBOOK_ID</computeroutput> </listitem><listitem><computeroutput>WAUI_IS_ORG</computeroutput> </listitem><listitem><computeroutput>WAUI_APP_ENABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_SPB_ENABLE</computeroutput> </listitem><listitem><computeroutput>WAUI_NICK</computeroutput> </listitem><listitem><computeroutput>WAUI_BICQ</computeroutput> </listitem><listitem><computeroutput>WAUI_BSKYPE</computeroutput> </listitem><listitem><computeroutput>WAUI_BAIM</computeroutput> </listitem><listitem><computeroutput>WAUI_BYAHOO</computeroutput> </listitem><listitem><computeroutput>WAUI_BMSN</computeroutput> </listitem><listitem><computeroutput>WAUI_MESSAGING</computeroutput> </listitem><listitem><computeroutput>WAUI_BMESSAGING</computeroutput> </listitem><listitem><computeroutput>WAUI_CERT_LOGIN</computeroutput> </listitem><listitem><computeroutput>WAUI_CERT_FINGERPRINT</computeroutput> </listitem><listitem><computeroutput>WAUI_CERT</computeroutput> </listitem><listitem><computeroutput>WAUI_ACL</computeroutput> - A serialized array of ACLs which is nearly impossible to create as a client since the serialization requires an internal Virtuoso function called serialize().</listitem><listitem><computeroutput>WAUI_SALMON_KEY</computeroutput> </listitem><listitem><computeroutput>WAUI_SETTINGS</computeroutput> </listitem><listitem><computeroutput>WAUI_JOIN_DATE</computeroutput> </listitem><listitem><computeroutput>WAUI_FOAF</computeroutput> </listitem></itemizedlist> " . <#action_777818aa3df3994ecb3fc581e691c18a> a schema:Action ; schema:name "user_update_fields" ; schema:target <#action_user.update.fields> . <#action_user.update.fields> a schema:EntryPoint ; schema:name "EntryPoint - user_update_fields" ; schema:url <https://vos.openlinksw.com/ods/api/user.update.fields> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.update.fields> ; schema:description "This method allows to update details in the user profile. Any parameter can be omitted which will result in its value not being touched.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>nickName</parametername> </parameternamelist> <parameterdescription> The user's nick name. Typically a short name used in chats and such. </parameterdescription> </li> <li> <parameternamelist> <parametername>mail</parametername> </parameternamelist> <parameterdescription> The user's email address. </parameterdescription> </li> <li> <parameternamelist> <parametername>title</parametername> </parameternamelist> <parameterdescription> The user's title. Can be something like \"Mr.\" or \"Ms.\" </parameterdescription> </li> <li> <parameternamelist> <parametername>firstName</parametername> </parameternamelist> <parameterdescription> The user's first name. </parameterdescription> </li> <li> <parameternamelist> <parametername>lastName</parametername> </parameternamelist> <parameterdescription> The user's last name. </parameterdescription> </li> <li> <parameternamelist> <parametername>fullName</parametername> </parameternamelist> <parameterdescription> The user's full name including any middle names. </parameterdescription> </li> <li> <parameternamelist> <parametername>gender</parametername> </parameternamelist> <parameterdescription> The user's gender. Can be either <computeroutput>\"male\"</computeroutput> or <computeroutput>\"female\"</computeroutput>. </parameterdescription> </li> <li> <parameternamelist> <parametername>birthday</parametername> </parameternamelist> <parameterdescription> The user's birthday. The date format is <computeroutput>YYYY.MM.DD</computeroutput>. </parameterdescription> </li> <li> <parameternamelist> <parametername>homepage</parametername> </parameternamelist> <parameterdescription> The user's homepage. </parameterdescription> </li> <li> <parameternamelist> <parametername>mailSignature</parametername> </parameternamelist> <parameterdescription> The user's mail signature to be attached to each mail written. </parameterdescription> </li> <li> <parameternamelist> <parametername>sumary</parametername> </parameternamelist> <parameterdescription> A piece of text giving a summary of the user. This can be anything. The summary is subject to privacy settings as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_user_privacy\">ODS User Privacy Settings</ref>. </parameterdescription> </li> <li> <parameternamelist> <parametername>appSetting</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>spbEnable</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>inSearch</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>showActive</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>webIDs</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>interests</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>topicInterests</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>icq</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>skype</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>yahoo</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>aim</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>msn</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>messaging</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>defaultMapLocation</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeCountry</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeState</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeCity</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeCode</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeAddress1</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeAddress2</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeTimezone</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeLatitude</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeLongitude</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homePhone</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homePhoneExt</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>homeMobile</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessIndustry</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessOrganization</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessHomePage</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessJob</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessRegNo</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessCareer</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessEmployees</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessVendor</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessService</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessOther</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessNetwork</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessResume</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessCountry</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessState</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessCity</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessCode</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessAddress1</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessAddress2</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessTimezone</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessLatitude</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessLongitude</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessPhone</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessPhoneExt</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessMobile</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessIcq</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessSkype</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessYahoo</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessAim</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessMsn</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>businessMessaging</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>securityOpenID</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>securityFacebookID</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>securitySecretQuestion</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>securitySecretAnswer</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>securitySiocLimit</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>photo</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>photoContent</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>audio</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>audioContent</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>mode</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>onlineAccounts</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga0ee8a3214520a223cd188b1ed0b65784\">user.update()</ref> </simplesect> " ; schema:shortDescription "Change user profile information. " ; oplwebsrv:hasParameter <#action_user.update.fields_#_nickName> , <#action_user.update.fields_#_mail> , <#action_user.update.fields_#_title> , <#action_user.update.fields_#_firstName> , <#action_user.update.fields_#_lastName> , <#action_user.update.fields_#_fullName> , <#action_user.update.fields_#_gender> , <#action_user.update.fields_#_birthday> , <#action_user.update.fields_#_homepage> , <#action_user.update.fields_#_mailSignature> , <#action_user.update.fields_#_sumary> , <#action_user.update.fields_#_appSetting> , <#action_user.update.fields_#_spbEnable> , <#action_user.update.fields_#_inSearch> , <#action_user.update.fields_#_showActive> , <#action_user.update.fields_#_webIDs> , <#action_user.update.fields_#_interests> , <#action_user.update.fields_#_topicInterests> , <#action_user.update.fields_#_icq> , <#action_user.update.fields_#_skype> , <#action_user.update.fields_#_yahoo> , <#action_user.update.fields_#_aim> , <#action_user.update.fields_#_msn> , <#action_user.update.fields_#_messaging> , <#action_user.update.fields_#_defaultMapLocation> , <#action_user.update.fields_#_homeCountry> , <#action_user.update.fields_#_homeState> , <#action_user.update.fields_#_homeCity> , <#action_user.update.fields_#_homeCode> , <#action_user.update.fields_#_homeAddress1> , <#action_user.update.fields_#_homeAddress2> , <#action_user.update.fields_#_homeTimezone> , <#action_user.update.fields_#_homeLatitude> , <#action_user.update.fields_#_homeLongitude> , <#action_user.update.fields_#_homePhone> , <#action_user.update.fields_#_homePhoneExt> , <#action_user.update.fields_#_homeMobile> , <#action_user.update.fields_#_businessIndustry> , <#action_user.update.fields_#_businessOrganization> , <#action_user.update.fields_#_businessHomePage> , <#action_user.update.fields_#_businessJob> , <#action_user.update.fields_#_businessRegNo> , <#action_user.update.fields_#_businessCareer> , <#action_user.update.fields_#_businessEmployees> , <#action_user.update.fields_#_businessVendor> , <#action_user.update.fields_#_businessService> , <#action_user.update.fields_#_businessOther> , <#action_user.update.fields_#_businessNetwork> , <#action_user.update.fields_#_businessResume> , <#action_user.update.fields_#_businessCountry> , <#action_user.update.fields_#_businessState> , <#action_user.update.fields_#_businessCity> , <#action_user.update.fields_#_businessCode> , <#action_user.update.fields_#_businessAddress1> , <#action_user.update.fields_#_businessAddress2> , <#action_user.update.fields_#_businessTimezone> , <#action_user.update.fields_#_businessLatitude> , <#action_user.update.fields_#_businessLongitude> , <#action_user.update.fields_#_businessPhone> , <#action_user.update.fields_#_businessPhoneExt> , <#action_user.update.fields_#_businessMobile> , <#action_user.update.fields_#_businessIcq> , <#action_user.update.fields_#_businessSkype> , <#action_user.update.fields_#_businessYahoo> , <#action_user.update.fields_#_businessAim> , <#action_user.update.fields_#_businessMsn> , <#action_user.update.fields_#_businessMessaging> , <#action_user.update.fields_#_securityOpenID> , <#action_user.update.fields_#_securityFacebookID> , <#action_user.update.fields_#_securitySecretQuestion> , <#action_user.update.fields_#_securitySecretAnswer> , <#action_user.update.fields_#_securitySiocLimit> , <#action_user.update.fields_#_photo> , <#action_user.update.fields_#_photoContent> , <#action_user.update.fields_#_audio> , <#action_user.update.fields_#_audioContent> , <#action_user.update.fields_#_mode> , <#action_user.update.fields_#_onlineAccounts> . <#action_user.update.fields_#_nickName> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "nickName" ; schema:name "nickName" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's nick name. Typically a short name used in chats and such. " . <#action_user.update.fields_#_mail> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "mail" ; schema:name "mail" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's email address. " . <#action_user.update.fields_#_title> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "title" ; schema:name "title" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's title. Can be something like \"Mr.\" or \"Ms.\" " . <#action_user.update.fields_#_firstName> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "firstName" ; schema:name "firstName" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's first name. " . <#action_user.update.fields_#_lastName> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "lastName" ; schema:name "lastName" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's last name. " . <#action_user.update.fields_#_fullName> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "fullName" ; schema:name "fullName" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's full name including any middle names. " . <#action_user.update.fields_#_gender> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "gender" ; schema:name "gender" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's gender. Can be either <computeroutput>\"male\"</computeroutput> or <computeroutput>\"female\"</computeroutput>. " . <#action_user.update.fields_#_birthday> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "birthday" ; schema:name "birthday" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's birthday. The date format is <computeroutput>YYYY.MM.DD</computeroutput>. " . <#action_user.update.fields_#_homepage> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homepage" ; schema:name "homepage" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's homepage. " . <#action_user.update.fields_#_mailSignature> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "mailSignature" ; schema:name "mailSignature" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "The user's mail signature to be attached to each mail written. " . <#action_user.update.fields_#_sumary> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "sumary" ; schema:name "sumary" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "A piece of text giving a summary of the user. This can be anything. The summary is subject to privacy settings as detailed in <ref kindref=\"member\" refid=\"group__ods__module__user_1ods_user_privacy\">ODS User Privacy Settings</ref>. " . <#action_user.update.fields_#_appSetting> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "appSetting" ; schema:name "appSetting" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_spbEnable> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "spbEnable" ; schema:name "spbEnable" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_inSearch> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "inSearch" ; schema:name "inSearch" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_showActive> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "showActive" ; schema:name "showActive" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_webIDs> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "webIDs" ; schema:name "webIDs" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_interests> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "interests" ; schema:name "interests" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_topicInterests> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "topicInterests" ; schema:name "topicInterests" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_icq> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "icq" ; schema:name "icq" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_skype> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "skype" ; schema:name "skype" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_yahoo> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "yahoo" ; schema:name "yahoo" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_aim> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "aim" ; schema:name "aim" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_msn> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "msn" ; schema:name "msn" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_messaging> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "messaging" ; schema:name "messaging" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_defaultMapLocation> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "defaultMapLocation" ; schema:name "defaultMapLocation" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeCountry> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeCountry" ; schema:name "homeCountry" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeState> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeState" ; schema:name "homeState" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeCity> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeCity" ; schema:name "homeCity" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeCode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeCode" ; schema:name "homeCode" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeAddress1> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeAddress1" ; schema:name "homeAddress1" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeAddress2> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeAddress2" ; schema:name "homeAddress2" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeTimezone> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeTimezone" ; schema:name "homeTimezone" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeLatitude> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeLatitude" ; schema:name "homeLatitude" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeLongitude> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeLongitude" ; schema:name "homeLongitude" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homePhone> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homePhone" ; schema:name "homePhone" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homePhoneExt> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homePhoneExt" ; schema:name "homePhoneExt" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_homeMobile> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "homeMobile" ; schema:name "homeMobile" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessIndustry> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessIndustry" ; schema:name "businessIndustry" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessOrganization> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessOrganization" ; schema:name "businessOrganization" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessHomePage> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessHomePage" ; schema:name "businessHomePage" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessJob> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessJob" ; schema:name "businessJob" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessRegNo> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessRegNo" ; schema:name "businessRegNo" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessCareer> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessCareer" ; schema:name "businessCareer" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessEmployees> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessEmployees" ; schema:name "businessEmployees" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessVendor> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessVendor" ; schema:name "businessVendor" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessService> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessService" ; schema:name "businessService" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessOther> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessOther" ; schema:name "businessOther" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessNetwork> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessNetwork" ; schema:name "businessNetwork" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessResume> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessResume" ; schema:name "businessResume" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessCountry> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessCountry" ; schema:name "businessCountry" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessState> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessState" ; schema:name "businessState" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessCity> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessCity" ; schema:name "businessCity" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessCode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessCode" ; schema:name "businessCode" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessAddress1> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessAddress1" ; schema:name "businessAddress1" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessAddress2> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessAddress2" ; schema:name "businessAddress2" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessTimezone> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessTimezone" ; schema:name "businessTimezone" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessLatitude> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessLatitude" ; schema:name "businessLatitude" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessLongitude> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessLongitude" ; schema:name "businessLongitude" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessPhone> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessPhone" ; schema:name "businessPhone" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessPhoneExt> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessPhoneExt" ; schema:name "businessPhoneExt" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessMobile> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessMobile" ; schema:name "businessMobile" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessIcq> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessIcq" ; schema:name "businessIcq" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessSkype> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessSkype" ; schema:name "businessSkype" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessYahoo> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessYahoo" ; schema:name "businessYahoo" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessAim> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessAim" ; schema:name "businessAim" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessMsn> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessMsn" ; schema:name "businessMsn" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_businessMessaging> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "businessMessaging" ; schema:name "businessMessaging" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_securityOpenID> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "securityOpenID" ; schema:name "securityOpenID" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_securityFacebookID> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "securityFacebookID" ; schema:name "securityFacebookID" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_securitySecretQuestion> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "securitySecretQuestion" ; schema:name "securitySecretQuestion" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_securitySecretAnswer> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "securitySecretAnswer" ; schema:name "securitySecretAnswer" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_securitySiocLimit> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "securitySiocLimit" ; schema:name "securitySiocLimit" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_photo> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "photo" ; schema:name "photo" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_photoContent> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "photoContent" ; schema:name "photoContent" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_audio> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "audio" ; schema:name "audio" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_audioContent> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "audioContent" ; schema:name "audioContent" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_mode> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "mode" ; schema:name "mode" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_user.update.fields_#_onlineAccounts> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "onlineAccounts" ; schema:name "onlineAccounts" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSUserModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSUserModuleAPIDoc> ; schema:description "" . <#action_d209f4dae81756549e7a8bd5698b049a> a schema:Action ; schema:name "user_upload" ; schema:target <#action_user.upload> . <#action_user.upload> a schema:EntryPoint ; schema:name "EntryPoint - user_upload" ; schema:url <https://vos.openlinksw.com/ods/api/user.upload> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.upload> ; schema:description "<xrefsect id=\"deprecated_1_deprecated000013\"><xreftitle>Deprecated</xreftitle><xrefdescription>Use <ref kindref=\"member\" refid=\"group__ods__module__user_1ga0ee8a3214520a223cd188b1ed0b65784\">user.update()</ref> instead.</xrefdescription></xrefsect>The ODS user profile contains an optional user photo and user audio file. These can be uploaded through this method.For this purpose an HTTP POST needs to be performed with the following paramters:<itemizedlist> <listitem><computeroutput>pf_photo</computeroutput> - The file name of the photo.</listitem><listitem><computeroutput>pf_photoContent</computeroutput> - The content of the photo file (jpg, gif, or png)</listitem><listitem><computeroutput>pf_audio</computeroutput> - The file name of the audio.</listitem><listitem><computeroutput>pf_audioContent</computeroutput> - The content of the audio file.</listitem></itemizedlist> <simplesect kind=\"return\"><simplesectsep />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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__user_1ga0ee8a3214520a223cd188b1ed0b65784\">user.update()</ref>, <ref kindref=\"member\" refid=\"group__ods__module__user_1ga777818aa3df3994ecb3fc581e691c18a\">user.update.fields()</ref></simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Upload binary user data. " . <#action_e4ab377e106ca7c8bbd52b84cedd7e1b> a schema:Action ; schema:name "user_validate" ; schema:target <#action_user.validate> . <#action_user.validate> a schema:EntryPoint ; schema:name "EntryPoint - user_validate" ; schema:url <https://vos.openlinksw.com/ods/api/user.validate> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSUserModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/user.validate> ; schema:description "This method can be used to check user authentication credentials as detailed in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>.<simplesect kind=\"return\">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>. If the authentication credentials are valid <computeroutput>1</computeroutput> is returned.</simplesect> <simplesect kind=\"par\"><title>Authentication</title>This function requries authentication via one of the supported authentication methods as described in <ref kindref=\"compound\" refid=\"ods_authentication\">ODS Authentication</ref>. </simplesect> " ; schema:shortDescription "Validate user authentication credentials. " . </script> <script type="text/javascript" src="oat/loader.js"></script> <script type="text/javascript"> OAT.Preferences.imagePath = '/ods/images/oat/'; OAT.Preferences.stylePath = '/ods/oat/styles/'; OAT.Preferences.showAjax = false; OAT.Loader.load(["dialog"]); </script> <script type="text/javascript" src="js/common.js"></script> <script type="text/javascript" src="js/validate.js"></script> <script type="text/javascript" src="js/info_dialog.js"></script> <form name="page_form" method="post" action="/ods/login.vspx" enctype="multipart/form-data" onsubmit="sflag=true;"> <input type="hidden" name="page__DAV_VAD_wa_login_vspx_view_state" value="wbwEtQZsb2dpbjHBvAS1FXZsX2xvZ291dF9pbl9wcm9ncmVzc7wAtRB2bF9hdXRoZW50aWNh dGVkvAC1G3BhZ2VfX0RBVl9WQURfd2FfbG9naW5fdnNweMG8PLUDdXJstVZodHRwOi8vdm9z Lm9wZW5saW5rc3cuY29tL293aWtpL3dpa2kvVk9TL1ZPUy9WaXJ0Q3VzdG9taXplU1BBUlFM RW5kcG9pbnQ/Y29tbWFuZD1lZGl0JrUFZm5hbWXMtQVmbmlja8y1BXV0eXBlzLULZl9mdWxs X25hbWXMtQpvaWRfc2VydmVyzLUHb2lkX3VybMy1BmJhbm5lcrUEZG9jc7UFcHJvbW+1ALUQ Y3VycmVudF90ZW1wbGF0Zcy1FGhhdmVfY3VzdG9tX3RlbXBsYXRlvAG1FWN1cnJlbnRfdGVt cGxhdGVfbmFtZcy1BnVfaG9tZcy1Bm9rX21zZ8y1CGFwcF90eXBlzLUIdGVtcGxhdGXMtQ10 b3BtZW51X2xldmVstQEwtQ9vZHNiYXJfYXBwX3R5cGXMtRRvZHNiYXJfYXBwX2RhdGFzcGFj Zcy1E29kc2Jhcl9hcHBpbnN0X3R5cGXMtQxvZHNiYXJfZm5hbWXMtQ1vZHNiYXJfdV9ob21l tQC1Em9kc2Jhcl9sb2dpbnBhcmFtc7UAtRJvZHNiYXJfc2hvd19zaWduaW61BHRydWW1EG9k c2Jhcl9vZHNfZ3BhdGi1I2h0dHA6Ly92b3Mub3Blbmxpbmtzdy5jb206ODg5NS9vZHMvtRVv ZHNiYXJfZGF0YXNwYWNlX3BhdGi1KWh0dHA6Ly92b3Mub3Blbmxpbmtzdy5jb206ODg5NS9k YXRhc3BhY2UvtRBvZHNiYXJfaW5vdXRfYXJytQC1Em9kc2Jhcl9jdXJyZW50X3VybLWBL29k cy8vbG9naW4udnNweD9VUkw9aHR0cCUzQSUyRiUyRnZvcy5vcGVubGlua3N3LmNvbSUyRm93 aWtpJTJGd2lraSUyRlZPUyUyRlZPUyUyRlZpcnRDdXN0b21pemVTUEFSUUxFbmRwb2ludCUz RmNvbW1hbmQlM0RlZGl0JTI2tQd3YV9uYW1lzLUFcmVhbG3M" /> <input type="hidden" name="nonce" value="f995ced89c16dfbbd8a3107ecef56e26" /> <input type="hidden" name="__submit_func" value="" /> <input type="hidden" name="__event_target" value="" /> <input type="hidden" name="__event_initiator" value="" /> <div id="HD"> <div id="odsBarCss" style="display:none"> #ods_bar { margin: 0; padding: 0; width: 100%; float: left; clear: both; color: #444; font-size: 9pt; font-family: Arial, Helvetica, sans-serif; background-color: #ddeff9} #ods_bar ul { list-style-type: none} #ods_bar ul li { display: inline} #ods_bar a { text-decoration: none; color: inherit} #ods_bar img { float: none; border: 0; margin: 0} #ods_bar input { margin-right: 8px; font-size: 7pt; color: #555;} #ods_bar_handle { width: 10px; float: left} #ods_bar_content { float: left; width: 100%; background-color: #ddeff9} #ods_bar_top { float: left; width: 100%; background-color: #fff} #ods_bar_bot { float: left; clear: left; width: 100%; padding-top: 2px; padding-bottom: 2px; background-color: #85b9d2} #ods_bar_top_cmds { font-size: 7.5pt; margin-top: 4px; color: #42abc4; background-color: #fff; float: right; padding-right: 8px} #ods_bar_top_cmds img { vertical-align: middle;} #ods_bar_top_cmds a { text-decoration: none} #ods_bar_top_cmds a.user_profile_lnk { text-transform: none} #ods_bar_first_lvl { float: left; padding: 0; margin: 0; color: #fff; background: #0075A8 url("/ods/images/navlv1default.png")} #ods_bar_first_lvl li { padding: 0; padding-left: 4px; margin: 0} #ods_bar_first_lvl li a { margin-top: 0px; padding: 6px 3px 6px 3px; vertical-align: middle; color: #fff; /* Required due to buggy CSS in IE */} #ods_bar_first_lvl li a img { margin-top: 2px; margin-bottom: 5px; vertical-align: middle;} #ods_bar_first_lvl li.sel a { color: #455; background: #b1d4e5 url("/ods/images/navlv1sel.png")} #ods_bar_second_lvl { width: 100%; height: 20px; float: left; clear: left; margin: 0; padding: 0; padding-top: 4px; background: #ddeff9 url("/ods/images/navlv2default.png")} #ods_bar_second_lvl li { margin-right: 5px} #ods_bar_second_lvl li:first-child { margin-left: 27px;} #ods_bar_second_lvl li a { vertical-align: middle; color: #444; /* Required by buggy IE CSS implementation */ } #ods_bar_home_path { margin: 2px 0px 0px 36px; padding: 0; font-size: 8pt} .popup { position: absolute; background-color: #fff; border: 1px dotted #4800F4; padding: 0.5em; font-size: 80%; } #ods_bar_odslogin { font-size: 7.5pt; margin-top: 4px; color: #42abc4; background-color: #fff; float: right; padding-right: 8px; } #ods_bar_odslogin img { vertical-align: middle; margin-left: 8px; } #ods_bar_odslogin a { margin-left: 3px; color: inherit; text-decoration: none; } </div><script type="text/javascript">  </script> <div id="ods_bar_loading" style="background-color:#DDEFF9;height: 62px;padding:5px 0px 0px 5px;display:none;"><img src="/ods/images/oat/Ajax_throbber.gif" alt="loading..." /> Loading... please wait. </div> <div id="ods_bar_odslogin" style="display:none;text-align:right"><a href="http://vos.openlinksw.com:8895/ods/login.vspx?URL=%2Fods%2F%2Flogin.vspx%3FURL%3Dhttp%253A%252F%252Fvos.openlinksw.com%252Fowiki%252Fwiki%252FVOS%252FVOS%252FVirtCustomizeSPARQLEndpoint%253Fcommand%253Dedit%2526">Sign In</a> | Sign Up </div> <div id="HD_ODS_BAR" style="display:none;"> <div id="ods_bar"> <div id="ods_bar_content"> <div id="ods_bar_top"> <ul id="ods_bar_first_lvl"> <li class="home_lnk"> <a href="http://vos.openlinksw.com:8895/ods/sfront.vspx" ><img src="http://vos.openlinksw.com:8895/ods/images/odslogosml.png" border="0" title="ODS Home" /></a> </li> <li class=""><a href="http://vos.openlinksw.com:8895/dataspace/all/weblog">Weblog</a> </li> <li class=""><a href="http://vos.openlinksw.com:8895/dataspace/all/wiki">Wiki</a> </li> <li class=""><a href="http://vos.openlinksw.com:8895/ods/gtags.vspx">Tags</a> </li> <li class=""> <a href="http://vos.openlinksw.com:8895/ods/search.vspx"><img class="tab_img" src="http://vos.openlinksw.com:8895/ods/images/search.png" alt="search icon" /> </a> </li> <li><input type="text" name="odsbar_search_text" value="" size="10" id="odsbar_search_text" class="textbox" onkeypress="return getUrlOnEnter(event)" /> </li> </ul> <div id="ods_bar_top_cmds"> <a href="http://vos.openlinksw.com:8895/ods/login.vspx?URL=%2Fods%2F%2Flogin.vspx%3FURL%3Dhttp%253A%252F%252Fvos.openlinksw.com%252Fowiki%252Fwiki%252FVOS%252FVOS%252FVirtCustomizeSPARQLEndpoint%253Fcommand%253Dedit%2526">Sign In</a> | Sign Up | <a href="http://vos.openlinksw.com:8895/ods/help.vspx" target="_blank">Help</a> | About <script type="text/javascript"> ODSInitArray.push(function(){OAT.Loader.load(["ajax", "json"], function(){showSSLLink();});}); </script> </div> </div> <ul id="ods_bar_second_lvl"><li> </li> </ul> </div> <div id="ods_bar_bot"> <div id="ods_bar_home_path"><a href="/ods/?sid=&realm=wa">ODS Home</a> > Login </div> <div id="ods_bar_data_space_indicator"> </div> </div> </div> </div> <script type="text/javascript">  </script> </div> <div id="MD"> <div class="error_msg" id="page_error_msg" style="display:none;padding: 0px 0px 0px 5px;"> </div> <div id="fb-root"> </div> <div style="margin-left: 20px;"> <h1 class="page_title"> docs </h1> <script type="text/javascript"> if (readCookie('interface') === 'js') { window.parent.postMessage({ 'fnc': 'logoutFunc', 'msg': 'logout' }, "*"); OAT.Dom.hide('MD'); } </script> <script type="text/javascript" src="/ods/js/login.js"></script> <script type="text/javascript"> ODS_SIGNIN.interface = 'old'; ODSInitArray.push(function(){OAT.Loader.load(["ajax", "tab"], function(){ODS_SIGNIN.init()});}); </script> <table cellspacing="0"> <tr> <td valign="top"><img id="lf_logo" src="/ods/images/odslogo_200.png" /> </td> <td valign="top"> <div id="lf" class="form"> <div class="header"> Please identify yourself <img id="lf_throbber" src="/ods/images/oat/Ajax_throbber.gif" style="float: right; margin-right: 10px; display: none" /> </div> <ul id="lf_tabs" class="tabs"><li id="lf_tab_0" title="Digest" style="display: none;">Digest</li><li id="lf_tab_1" title="WebID" style="display: none;">WebID</li><li id="lf_tab_2" title="OpenID" style="display: none;">OpenID</li><li id="lf_tab_3" title="3rd-party Accounts" style="display: none;">3rd-party Accounts</li><li id="lf_tab_4" style="display: none;" /> </ul> <div style="min-height: 110px; border: 1px solid #aaa; margin: -13px 5px 5px 5px;"> <div id="lf_content"> </div> <div id="lf_page_0" class="tabContent" style="display: none;"> <table class="form" cellspacing="5"> <tr> <th width="20%" nowrap="nowrap"> <label for="lf_uid">Login Name<div style="font-weight: normal; display:inline; color:red;"> *</div> </label> </th> <td><input type="text" name="lf_uid" value="" id="lf_uid" style="width: 150px;" autofocus="" /> </td> </tr> <tr> <th nowrap="nowrap"> <label for="lf_password">Password<div style="font-weight: normal; display:inline; color:red;"> *</div> </label> </th> <td><input type="password" name="lf_password" value="" id="lf_password" style="width: 150px;" /> </td> </tr> </table> <div class="footer"><input type="button" name="lf_login_0" id="lf_login_0" value="Sign In" onclick="javascript: return ODS_SIGNIN.submit('digest');" /> </div> </div> <div id="lf_page_1" class="tabContent" style="display: none;"> <table id="lf_table_1" class="form" cellspacing="5"> <tr id="lf_table_1_throbber" colspan="2"> <td style="text-align: center;"> <img alt="Import WebID Data" src="/ods/images/oat/Ajax_throbber.gif" /> </td> </tr> </table> <div id="lf_footer_1" class="footer" style="display: none;"><input type="button" name="lf_login_1" id="lf_login_1" value="WebID Sign In" onclick="javascript: return ODS_SIGNIN.submit('webid');" /> </div> </div> <div id="lf_page_2" class="tabContent" style="display: none;"> <table class="form" cellspacing="5"> <tr> <th width="20%"> <label for="lf_openId">OpenID URI<div style="font-weight: normal; display:inline; color:red;"> *</div> </label> </th> <td nowrap="nowrap"> <input type="text" name="lf_openid" value="" id="lf_openid" style="width: 300px;" /> </td> </tr> </table> <div class="footer"><input type="button" name="lf_login_2" id="lf_login_2" value="OpenID Sign In" onclick="javascript: return ODS_SIGNIN.submit('openid');" /> </div> </div> <div id="lf_page_3" class="tabContent" style="display: none;"> <table class="form" cellspacing="5"> <tr> <td style="text-align: center;" id="lf_page_3_td"> </td> </tr> </table> </div> <div id="lf_page_4" class="tabContent" style="display: none;"> <table id="lf_table_4" class="form" cellspacing="5" width="100%"> <tr> <td style="text-align: center;">The sign in is not allowed! </td> </tr> </table> </div> <div id="lf_forget" class="footer" style="background-color: #FFF; display: none;"><a href="pass_recovery.vspx">Forgot your password?</a> </div> </div> </div> </td> </tr> </table> </div> <script type="text/javascript"> if (document.page_form.username != null) document.page_form.username.focus(); </script> </div> <div id="FT"> <div id="FT_L"> <a href="http://www.openlinksw.com/virtuoso"><img alt="Powered by OpenLink Virtuoso Universal Server" src="images/virt_power_no_border.png" border="0" /> </a> </div> <div id="FT_R"><a href="faq.html">FAQ</a> | <a href="privacy.html">Privacy</a> | <a href="rabuse.vspx">Report Abuse</a> <div> Copyright © 1998-2023 OpenLink Software </div> <div> </div> </div> </div></form> ....</body> </html>