MDL-28650 add a page in the administration to the full web service API (API documenta...
[moodle.git] / lang / en / webservice.php
cc93c7da 1<?php
9baf6825 2
3// This file is part of Moodle -
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// GNU General Public License for more details.
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <>.
19 * Strings for component 'webservice', language 'en', branch 'MOODLE_20_STABLE'
20 *
21 * @package webservice
22 * @copyright 1999 onwards Martin Dougiamas {@link}
23 * @license GNU GPL v3 or later
24 */
5593d2dc 26$string['accessexception'] = 'Access control exception';
b0a9a0cd 27$string['accessnotallowed'] = 'Access to web service not allowed';
28$string['actwebserviceshhdr'] = 'Active web service protocols';
29$string['addaservice'] = 'Add service';
3e6161fb 30$string['addcapabilitytousers'] = 'Check users capability';
a203cb67 31$string['addcapabilitytousersdescription'] = 'Users should have two capabilities - webservice:createtoken and a capability matching the protocols used, for example webservice/rest:use, webservice/soap:use. To achieve this, create a web services role with the appropriate capabilities allowed and assign it to the web services user as a system role.';
cc93c7da 32$string['addfunction'] = 'Add function';
30c8dd34 33$string['addfunctionhelp'] = 'Select the function to add to the service.';
8399c714 34$string['addfunctions'] = 'Add functions';
a203cb67 35$string['addfunctionsdescription'] = 'Select required functions for the newly created service.';
f085c3ec 36$string['addrequiredcapability'] = 'Assign/unassign the required capability';
30c8dd34 37$string['addservice'] = 'Add a new service: {$a->name} (id: {$a->id})';
1d2a1936 38$string['addservicefunction'] = 'Add functions to the service "{$a}"';
1bd06507 39$string['allusers'] = 'All users';
47ee1c35 40$string['amftestclient'] = 'AMF test client';
d4c6ef70 41$string['apiexplorer'] = 'API explorer';
42$string['apiexplorernotavalaible'] = 'API explorer not available yet.';
43$string['arguments'] = 'Arguments';
3785c9e2 44$string['authmethod'] = 'Authentication method';
13ea96c4 45$string['cannotcreatemobiletoken'] = 'No permission to create web service token for mobile access.';
abd9a3d1 46$string['configwebserviceplugins'] = 'For security reasons, only protocols that are in use should be enabled.';
5ae9f539 47$string['context'] = 'Context';
3e6161fb 48$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\'.';
49$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 50$string['createtoken'] = 'Create token';
3e6161fb 51$string['createtokenforuser'] = 'Create a token for a user';
13ea96c4 52$string['createtokenforuserauto'] = 'Create a token for a user automatically';
a203cb67 53$string['createtokenforuserdescription'] = 'Create a token for the web services user.';
3e6161fb 54$string['createuser'] = 'Create a specific user';
a203cb67 55$string['createuserdescription'] = 'A web services user is required to represent the system controlling Moodle.';
30c8dd34 56$string['default'] = 'Default to "{$a}"';
a3103a10 57$string['deleteaservice'] = 'Delete service';
30c8dd34 58$string['deleteservice'] = 'Delete the service: {$a->name} (id: {$a->id})';
c25662b0 59$string['deleteserviceconfirm'] = 'Deleting a service will also delete the tokens related to this service. Do you really want to delete external service "{$a}"?';
60$string['deletetokenconfirm'] = 'Do you really want to delete this web service token for <strong>{$a->user}</strong> on the service <strong>{$a->service}</strong>?';
61$string['disabledwarning'] = 'All web service protocols are disabled. The "Enable web services" setting can be found in Advanced features.';
9ef728d6 62$string['doc'] = 'Documentation';
63$string['docaccessrefused'] = 'You are not allowed to see the documentation for this token';
4b4b53a7 64$string['documentation'] = 'web service documentation';
a3103a10 65$string['editaservice'] = 'Edit service';
30c8dd34 66$string['editservice'] = 'Edit the service: {$a->name} (id: {$a->id})';
86c252b4 67$string['enabled'] = 'Enabled';
abd9a3d1 68$string['enabledocumentation'] = 'Enable developer documentation';
a203cb67 69$string['enabledocumentationdescription'] = 'Detailed web services documentation is available for enabled protocols.';
3e6161fb 70$string['enableprotocols'] = 'Enable protocols';
a203cb67 71$string['enableprotocolsdescription'] = 'At least one protocol should be enabled. For security reasons, only protocols that are to be used should be enabled.';
72$string['enablews'] = 'Enable web services';
73$string['enablewsdescription'] = 'Web services must be enabled in Advanced features.';
85b4c447 74$string['entertoken'] = 'Enter a security key/token:';
30c8dd34 75$string['error'] = 'Error: {$a}';
6bb31e40 76$string['errorcatcontextnotvalid'] = 'You cannot execute functions in the category context (category id:{$a->catid}). The context error message was: {$a->message}';
abf7dc44 77$string['errorcodes'] = 'Error message';
e21c56bd 78$string['errorcoursecontextnotvalid'] = 'You cannot execute functions in the course context (course id:{$a->courseid}). The context error message was: {$a->message}';
6bb31e40 79$string['errorinvalidparam'] = 'The param "{$a}" is invalid.';
eae18ab6 80$string['errorinvalidparamsapi'] = 'Invalid external api parameter';
81$string['errorinvalidparamsdesc'] = 'Invalid external api description';
d07ff72d 82$string['errorinvalidresponseapi'] = 'Invalid external api response';
83$string['errorinvalidresponsedesc'] = 'Invalid external api response description';
30c8dd34 84$string['errormissingkey'] = 'Missing required key in single structure: {$a}';
774b1b0f 85$string['errornotemptydefaultparamarray'] = 'The web service description parameter named \'{$a}\' is an single or multiple structure. The default can only be empty array. Check web service description.';
eae18ab6 86$string['erroronlyarray'] = 'Only arrays accepted.';
774b1b0f 87$string['erroroptionalparamarray'] = 'The web service description parameter named \'{$a}\' is an single or multiple structure. It can not be set as VALUE_OPTIONAL. Check web service description.';
476c0e82 88$string['errorresponsemissingkey'] = 'Error in response - Missing following required key in a single structure: {$a}';
eae18ab6 89$string['errorscalartype'] = 'Scalar type expected, array or object received.';
ceb1bad4 90$string['errorunexpectedkey'] = 'Unexpected keys ({$a}) detected in parameter array.';
f5072177 91$string['execute'] = 'Execute';
a203cb67 92$string['executewarnign'] = 'WARNING: If you press execute your database will be modified and changes can not be reverted automatically!';
cc93c7da 93$string['externalservice'] = 'External service';
94$string['externalservicefunctions'] = 'External service functions';
30c8dd34 95$string['externalservices'] = 'External services';
cc93c7da 96$string['externalserviceusers'] = 'External service users';
1e29fe3f 97$string['failedtolog'] = 'Failed to log';
cc93c7da 98$string['function'] = 'Function';
99$string['functions'] = 'Functions';
abf7dc44 100$string['generalstructure'] = 'General structure';
30c8dd34 101$string['checkusercapability'] = 'Check user capability';
a203cb67 102$string['checkusercapabilitydescription'] = 'The user should have appropriate capabilities according to the protocols used, for example webservice/rest:use, webservice/soap:use. To achieve this, create a web services role with protocol capabilities allowed and assign it to the web services user as a system role.';
8399c714 103$string['information'] = 'Information';
104$string['installserviceshortnameerror'] = 'Coding error: the service shortname "{$a}" should have contains numbers, letters and _-.. only.';
105$string['installexistingserviceshortnameerror'] = 'A web service with the shortname "{$a}" already exists. Can not install/update a different web service with this shortname.';
106$string['invalidextparam'] = 'Invalid external api parameter: {$a}';
107$string['invalidextresponse'] = 'Invalid external api response: {$a}';
3785c9e2 108$string['invalidiptoken'] = 'Invalid token - your IP is not supported';
109$string['invalidtimedtoken'] = 'Invalid token - token expired';
110$string['invalidtoken'] = 'Invalid token - token not found';
2d0acbd5 111$string['invalidtokensession'] = 'Invalid session based token - session not found or expired';
bb1dff21 112$string['iprestriction'] = 'IP restriction';
86dcc6f0 113$string['iprestriction_help'] = 'The user will need to call web service from the listed IPs.';
94e90ab7 114$string['key'] = 'Key';
30c8dd34 115$string['keyshelp'] = 'The keys are used to access your Moodle account from external applications.';
cc93c7da 116$string['manageprotocols'] = 'Manage protocols';
5ae9f539 117$string['managetokens'] = 'Manage tokens';
118$string['missingcaps'] = 'Missing capabilities';
119$string['missingcaps_help'] = 'List of required capabilities for the service which the selected user does not have. Missing capabilities must be added to the user\'s role in order to use the service.';
b0a9a0cd 120$string['missingpassword'] = 'Missing password';
121$string['missingusername'] = 'Missing username';
0bf486a6 122$string['missingversionfile'] = 'Coding error: version.php file is missing for the component {$a}';
1d2a1936 123$string['nofunctions'] = 'This service has no functions.';
09179b78 124$string['norequiredcapability'] = 'No required capability';
94e90ab7 125$string['notoken'] = 'The token list is empty.';
126$string['onesystemcontrolling'] = 'One system controlling Moodle with a token';
127$string['onesystemcontrollingdescription'] = 'The following steps help you to set up the Moodle web service for a system to control Moodle. These steps also help to set up the recommended token (security keys) authentication method.';
5ae9f539 128$string['operation'] = 'Operation';
d4c6ef70 129$string['optional'] = 'Optional';
13ea96c4 130$string['passwordisexpired'] = 'Password is expired.';
360e9415 131$string['phpparam'] = 'XML-RPC (PHP structure)';
132$string['phpresponse'] = 'XML-RPC (PHP structure)';
133$string['postrestparam'] = 'PHP code for REST (POST request)';
86c252b4 134$string['potusers'] = 'Not authorised users';
135$string['potusersmatching'] = 'Not authorised users matching';
f085c3ec 136$string['print'] = 'Print all';
cc93c7da 137$string['protocol'] = 'Protocol';
138$string['removefunction'] = 'Remove';
30c8dd34 139$string['removefunctionconfirm'] = 'Do you really want to remove function "{$a->function}" from service "{$a->service}"?';
d4c6ef70 140$string['requireauthentication'] = 'This method requires authentication with xxx permission.';
141$string['required'] = 'Required';
cc93c7da 142$string['requiredcapability'] = 'Required capability';
fbbaa58e 143$string['requiredcapability_help'] = 'If set, only users with the required capability can access the service.';
72f68b51 144$string['requiredcaps'] = 'Required capabilities';
30c8dd34 145$string['resettokenconfirm'] = 'Do you really want to reset this web service key for <strong>{$a->user}</strong> on the service <strong>{$a->service}</strong>?';
1a5deabd 146$string['resettokenconfirmsimple'] = 'Do you really want to reset this key? Any saved links containing the old key will not work anymore.';
d4c6ef70 147$string['response'] = 'Response';
360e9415 148$string['restcode'] = 'REST';
abf7dc44 149$string['restexception'] = 'REST';
886e3bfb 150$string['restparam'] = 'REST (POST parameters)';
86c252b4 151$string['restrictedusers'] = 'Authorised users only';
a203cb67 152$string['restrictedusers_help'] = 'This setting determines whether all users with the permission to create a web services token can generate a token for this service via their security keys page or whether only authorised users can do so.';
13ea96c4 153$string['restoredaccountresetpassword'] = 'Restored account need to reset password before getting a token.';
30c8dd34 154$string['securitykey'] = 'Security key (token)';
94e90ab7 155$string['securitykeys'] = 'Security keys';
86dcc6f0 156$string['selectauthorisedusers'] = 'Select authorised users';
09179b78 157$string['selectedcapability'] = 'Selected';
30c8dd34 158$string['selectedcapabilitydoesntexit'] = 'The currently set required capability ({$a}) doesn\'t exist any more. Please change it and save the changes.';
f05d2193 159$string['selectservice'] = 'Select a service';
3e6161fb 160$string['selectspecificuser'] = 'Select a specific user';
a203cb67 161$string['selectspecificuserdescription'] = 'Add the web services user as an authorised user.';
5ae9f539 162$string['service'] = 'Service';
a203cb67 163$string['servicehelpexplanation'] = 'A service is a set of functions. A service can be accessed by all users or just specified users.';
b5c6b61d 164$string['servicename'] = 'Service name';
cc93c7da 165$string['servicesbuiltin'] = 'Built-in services';
166$string['servicescustom'] = 'Custom services';
86c252b4 167$string['serviceusers'] = 'Authorised users';
86dcc6f0 168$string['serviceusersettings'] = 'User settings';
86c252b4 169$string['serviceusersmatching'] = 'Authorised users matching';
170$string['serviceuserssettings'] = 'Change settings for the authorised users';
171$string['simpleauthlog'] = 'Simple authentication login';
172$string['step'] = 'Step';
a203cb67 173$string['testauserwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Before doing so, login as a user with the moodle/webservice:createtoken capability and obtain the security key (token) via My profile settings. 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, so be careful what you choose to test!</strong>';
f0dafb3c 174$string['testclient'] = 'Web service test client';
47ee1c35 175$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}<br/>* Access the {$a->amfatag}.';
f54dfa54 176$string['testwithtestclient'] = 'Test the service';
a203cb67 177$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, so be careful what you choose to test!</strong>';
5ae9f539 178$string['token'] = 'Token';
1e29fe3f 179$string['tokenauthlog'] = 'Token authentication';
1bd06507 180$string['tokencreatedbyadmin'] = 'Can only be reset by administrator (*)';
b721742a 181$string['tokencreator'] = 'Creator';
86dcc6f0 182$string['updateusersettings'] = 'Update';
3e6161fb 183$string['userasclients'] = 'Users as clients with token';
184$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 the security keys page via My profile settings.';
185$string['usermissingcaps'] = 'Missing capabilities: {$a}';
a44460b5 186$string['usernotallowed'] = 'The user is not allowed for this service. First you need to allow this user on the {$a}\'s allowed users administration page.';
86dcc6f0 187$string['usersettingssaved'] = 'User settings saved';
30c8dd34 188$string['validuntil'] = 'Valid until';
86dcc6f0 189$string['validuntil_help'] = 'If set, the service will be inactivated after this date for this user.';
4c148856 190$string['webservice'] = 'Web service';
cc93c7da 191$string['webservices'] = 'Web services';
3e6161fb 192$string['webservicesoverview'] = 'Overview';
5ae9f539 193$string['webservicetokens'] = 'Web service tokens';
b0a9a0cd 194$string['wrongusernamepassword'] = 'Wrong username or password';
195$string['wsauthmissing'] = 'The web service authentication plugin is missing.';
196$string['wsauthnotenabled'] = 'The web service authentication plugin is disabled.';
390cc887 197$string['wsclientdoc'] = 'Moodle web service client documentation';
cde291ed 198$string['wsdocapi'] = 'API Documentation';
d4c6ef70 199$string['wsdocumentation'] = 'Web service documentation';
7886efc4 200$string['wsdocumentationdisable'] = 'Web service documentation is disabled.';
9ef728d6 201$string['wsdocumentationintro'] = 'To create a client we advise you to read the {$a->doclink}';
85b4c447 202$string['wsdocumentationlogin'] = 'or enter your web service username and password:';
d4c6ef70 203$string['wspassword'] = 'Web service password';
204$string['wsusername'] = 'Web service username';