MDL-21695 help files replaced by standard strings - basic infrastructure in place...
[moodle.git] / lang / en / webservice.php
CommitLineData
cc93c7da 1<?php
9baf6825 2
5593d2dc 3$string['accessexception'] = 'Access control exception';
b0a9a0cd 4$string['accessnotallowed'] = 'Access to web service not allowed';
3785c9e2 5$string['activatehttps'] = '******************';
3e6161fb 6$string['addcapabilitytousers'] = 'Check users capability';
0d4b9d09 7$string['addcapabilitytousersdescription'] = 'To use web services, users need to have two different capabilities: \'/webservice:createtoken\' and a capability matching the web service protocols (\'webservice/rest:use\', \'webservice/soap:use\', ...). <br/>Advice: one way to set this up is to create a new \'Web Service\' system role with the \'webservice:createtoken\' capability and some protocol capabilities. Then assign this system role to the web service user.';
cc93c7da 8$string['addfunction'] = 'Add function';
8399c714 9$string['addfunctions'] = 'Add functions';
3e6161fb 10$string['addfunctionsdescription'] = 'On the <strong>Manage service</strong> page, click the <strong>Functions</strong> link for the newly created service. Add some functions to the service.';
1d1b17f2 11$string['addfunctionhelp'] = 'Select the function to add to the service.';
bb1dff21 12$string['addrequiredcapability'] = 'Assign/Unassign the required capability';
3b59ba8c 13$string['addservice'] = 'Add a new service: $a->name (id: $a->id)';
a3103a10 14$string['addaservice'] = 'Add service';
cc93c7da 15$string['actwebserviceshhdr'] = 'Active web service protocols';
1bd06507 16$string['allusers'] = 'All users';
d4c6ef70 17$string['apiexplorer'] = 'API explorer';
18$string['apiexplorernotavalaible'] = 'API explorer not available yet.';
19$string['arguments'] = 'Arguments';
3785c9e2 20$string['authmethod'] = 'Authentication method';
3e6161fb 21$string['checkusercapability'] = 'Check user capability';
0d4b9d09 22$string['checkusercapabilitydescription'] = 'To use the web services, a user needs to have a capability matching the web service protocols (\'webservice/rest:use\', \'webservice/soap:use\', ...). <br/>Advice: one way to set this up is to create a new \'Web Service\' system role with protocol capabilities defined. Then you assign this system role to the web service user.';
abd9a3d1 23$string['configwebserviceplugins'] = 'For security reasons, only protocols that are in use should be enabled.';
5ae9f539 24$string['context'] = 'Context';
3e6161fb 25$string['createservicedescription'] = 'A service is a set of web service functions. You will allow the user to access to a new service. On the <strong>Add service</strong> page check \'Enable\' and \'Authorised users\' options. Select \'No required capability\'.';
26$string['createserviceforusersdescription'] = 'A service is a set of web service functions. You will allow users to access to a new service. On the <strong>Add service</strong> page check \'Enable\' and uncheck \'Authorised users\' options. Select \'No required capability\'.';
15e417fe 27$string['createtoken'] = 'Create token';
3e6161fb 28$string['createtokenforuser'] = 'Create a token for a user';
29$string['createtokenforuserdescription'] = 'On the <strong>Manage token</strong> page, click on \'Add\'. Then select the created user and service.';
30$string['createuser'] = 'Create a specific user';
31$string['createuserdescription'] = 'You need to create a specific user for the system controlling Moodle.';
382b9cea 32$string['default'] = 'Default to \"$a\"';
3b59ba8c 33$string['deleteservice'] = 'Delete the service: $a->name (id: $a->id)';
a3103a10 34$string['deleteaservice'] = 'Delete service';
cc93c7da 35$string['deleteserviceconfirm'] = 'Do you really want to delete external service \"$a\"?';
15e417fe 36$string['deletetokenconfirm'] = 'Do you really want to delete this web service token for <strong>$a->user</strong> on the service <strong>$a->service</strong>?';
3d5a7b60 37$string['disabledwarning'] = 'All web service protocols are disabled. The \"Enable web services\" setting can be found in Advanced features.';
4b4b53a7 38$string['documentation'] = 'web service documentation';
3b59ba8c 39$string['editservice'] = 'Edit the service: $a->name (id: $a->id)';
a3103a10 40$string['editaservice'] = 'Edit service';
86c252b4 41$string['enabled'] = 'Enabled';
abd9a3d1 42$string['enabledocumentation'] = 'Enable developer documentation';
3e6161fb 43$string['enabledocumentationdescription'] = 'Check it to give to the developers of the external system access to a detailed web services documentation. The developers only see the documentation of the service they have access to.';
44$string['enablews'] = 'Enable web services';
abd9a3d1 45$string['enablewsdescription'] = 'Web services must be enabled in Advanced features.';
3e6161fb 46$string['enableprotocols'] = 'Enable protocols';
abd9a3d1 47$string['enableprotocolsdescription'] = 'At least one protocol should be enabled. In counter part, even though Moodle takes a very good care about security issues, more you have enabled protocols, more your Moodle site is subject to external attacks.';
85b4c447 48$string['entertoken'] = 'Enter a security key/token:';
d4c6ef70 49$string['error'] = 'Error: $a';
abf7dc44 50$string['errorcodes'] = 'Error message';
eae18ab6 51$string['errorinvalidparamsapi'] = 'Invalid external api parameter';
52$string['errorinvalidparamsdesc'] = 'Invalid external api description';
d07ff72d 53$string['errorinvalidresponseapi'] = 'Invalid external api response';
54$string['errorinvalidresponsedesc'] = 'Invalid external api response description';
eae18ab6 55$string['errormissingkey'] = 'Missing required key in single structure: $a';
56$string['erroronlyarray'] = 'Only arrays accepted.';
57$string['errorscalartype'] = 'Scalar type expected, array or object received.';
58$string['errorunexpectedkey'] = 'Unexpected keys detected in parameter array.';
f5072177 59$string['execute'] = 'Execute';
60$string['executewarnign'] = 'WARNING: if you press execute your database will be modified and changes can not be reverted automatically!';
cc93c7da 61$string['externalservices'] = 'External services';
62$string['externalservice'] = 'External service';
63$string['externalservicefunctions'] = 'External service functions';
64$string['externalserviceusers'] = 'External service users';
1e29fe3f 65$string['failedtolog'] = 'Failed to log';
cc93c7da 66$string['function'] = 'Function';
67$string['functions'] = 'Functions';
abf7dc44 68$string['generalstructure'] = 'General structure';
5ae9f539 69$string['httpswarning'] = 'Token strings are only displayed if your connection is secured (https)';
8399c714 70$string['information'] = 'Information';
559a5dbd 71$string['invalidextparam'] = 'Invalid external api parameter: $a';
d07ff72d 72$string['invalidextresponse'] = 'Invalid external api response: $a';
3785c9e2 73$string['invalidiptoken'] = 'Invalid token - your IP is not supported';
74$string['invalidtimedtoken'] = 'Invalid token - token expired';
75$string['invalidtoken'] = 'Invalid token - token not found';
bb1dff21 76$string['iprestriction'] = 'IP restriction';
94e90ab7 77$string['key'] = 'Key';
cc93c7da 78$string['manageprotocols'] = 'Manage protocols';
5ae9f539 79$string['managetokens'] = 'Manage tokens';
b0a9a0cd 80$string['missingpassword'] = 'Missing password';
81$string['missingusername'] = 'Missing username';
09179b78 82$string['norequiredcapability'] = 'No required capability';
94e90ab7 83$string['notoken'] = 'The token list is empty.';
3e6161fb 84$string['onesystemcontrolling'] = 'One system controlling Moodle with token';
abd9a3d1 85$string['onesystemcontrollingdescription'] = 'The following steps help you to set up the Moodle web service for one system controlling Moodle (e.g a student information system). These steps also help to set up the recommended token (security keys) authentication method.';
5ae9f539 86$string['operation'] = 'Operation';
d4c6ef70 87$string['optional'] = 'Optional';
360e9415 88$string['phpparam'] = 'XML-RPC (PHP structure)';
89$string['phpresponse'] = 'XML-RPC (PHP structure)';
90$string['postrestparam'] = 'PHP code for REST (POST request)';
86c252b4 91$string['potusers'] = 'Not authorised users';
92$string['potusersmatching'] = 'Not authorised users matching';
cdb0bd6a 93$string['print'] = 'Print All';
cc93c7da 94$string['protocol'] = 'Protocol';
95$string['removefunction'] = 'Remove';
96$string['removefunctionconfirm'] = 'Do you really want to remove function \"$a->function\" from service \"$a->service\"?';
d4c6ef70 97$string['requireauthentication'] = 'This method requires authentication with xxx permission.';
98$string['required'] = 'Required';
cc93c7da 99$string['requiredcapability'] = 'Required capability';
94e90ab7 100$string['resettokenconfirm'] = 'Do you really want to reset this web service key for <strong>$a->user</strong> on the service <strong>$a->service</strong>?';
d4c6ef70 101$string['response'] = 'Response';
360e9415 102$string['restcode'] = 'REST';
abf7dc44 103$string['restexception'] = 'REST';
886e3bfb 104$string['restparam'] = 'REST (POST parameters)';
86c252b4 105$string['restrictedusers'] = 'Authorised users only';
94e90ab7 106$string['securitykeys'] = 'Security keys';
abd9a3d1 107$string['selectedcapabilitydoesntexit'] = 'The currently set required capability ($a) doesn\'t exist any more. Please change it and save the changes.';
09179b78 108$string['selectedcapability'] = 'Selected';
1e29fe3f 109$string['simpleauthlog'] = 'Simple authentication login';
3e6161fb 110$string['step'] = 'Step';
85b4c447 111$string['securitykey'] = 'Security key (token)';
f05d2193 112$string['selectservice'] = 'Select a service';
3e6161fb 113$string['selectspecificuser'] = 'Select a specific user';
114$string['selectspecificuserdescription'] = 'On the <strong>Manage service</strong> page, click on \'Authorised users\' and add the user to the authorised users list.';
5ae9f539 115$string['service'] = 'Service';
abd9a3d1 116$string['servicehelpexplanation'] = 'A service is a set of functions. A service can be accessed by all users or just specified users. <strong>Custom services</strong> are services that you created. <strong>Default services</strong> are services that were added by default to Moodle. You can not change functions from a <strong>Default service</strong>.';
b5c6b61d 117$string['servicename'] = 'Service name';
cc93c7da 118$string['servicesbuiltin'] = 'Built-in services';
119$string['servicescustom'] = 'Custom services';
86c252b4 120$string['serviceusers'] = 'Authorised users';
121$string['serviceusersmatching'] = 'Authorised users matching';
122$string['serviceuserssettings'] = 'Change settings for the authorised users';
f0dafb3c 123$string['testclient'] = 'Web service test client';
bdf40a4c 124$string['testclientdescription'] = '* The web service test client <strong>executes</strong> the functions for <strong>REAL</strong>. Do not test functions that you don\'t know. <br/>* All existing web service functions are not yet implemented into the test client. <br/>* In order to check that a user cannot access some functions, you can test some functions that you didn\'t allow.<br/>* To see clearer error messages set the debugging to <strong>$a->mode</strong> into $a->atag';
f54dfa54 125$string['testwithtestclient'] = 'Test the service';
126$string['testauserwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Before going there, log on as a user set with the "moodle/webservice:createtoken" capability, and get his security key (token) from his "my moodle" block. You will use this token in the test client. In the test client, also choose an enabled protocol with the token authentication. <strong>Warning: the functions that you test WILL BE EXECUTED for this user, be carefull what you choose to test!!!</strong>';
127$string['testwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Use an enabled protocol with token authentication. <strong>Warning: the functions that you test WILL BE EXECUTED, be carefull what you choose to test!!!</strong>';
5ae9f539 128$string['token'] = 'Token';
1e29fe3f 129$string['tokenauthlog'] = 'Token authentication';
1bd06507 130$string['tokencreatedbyadmin'] = 'Can only be reset by administrator (*)';
b721742a 131$string['tokencreator'] = 'Creator';
132$string['keyshelp'] = 'The keys are used to access your Moodle account from external applications.';
bb1dff21 133$string['validuntil'] = 'Valid until';
3e6161fb 134$string['userasclients'] = 'Users as clients with token';
abd9a3d1 135$string['userasclientsdescription'] = 'The following steps help you to set up the Moodle web service for users as clients. These steps also help to set up the recommended token (security keys) authentication method. In this use case, the user will generate his token from his <strong>Security keys</strong> profile page.';
cc93c7da 136$string['webservices'] = 'Web services';
3e6161fb 137$string['webservicesoverview'] = 'Overview';
5ae9f539 138$string['webservicetokens'] = 'Web service tokens';
b0a9a0cd 139$string['wrongusernamepassword'] = 'Wrong username or password';
140$string['wsauthmissing'] = 'The web service authentication plugin is missing.';
141$string['wsauthnotenabled'] = 'The web service authentication plugin is disabled.';
d4c6ef70 142$string['wsdocumentation'] = 'Web service documentation';
7886efc4 143$string['wsdocumentationdisable'] = 'Web service documentation is disabled.';
f897719f 144$string['wsdocumentationintro'] = 'Following is a listing of web service functions available for the username <b>$a</b>.<br/>To create a client we advise you to read the <a href=\"http://docs.moodle.org/en/Development:Creating_a_web_service_and_a_web_service_function#Create_your_own_client\">Moodle documentation</a>';
85b4c447 145$string['wsdocumentationlogin'] = 'or enter your web service username and password:';
d4c6ef70 146$string['wspassword'] = 'Web service password';
147$string['wsusername'] = 'Web service username';
abf7dc44 148