MDL-54551 core: touch-up after review
[moodle.git] / lang / en / webservice.php
cc93c7da 1<?php
2// This file is part of Moodle -
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// GNU General Public License for more details.
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <>.
18 * Strings for component 'webservice', language 'en', branch 'MOODLE_20_STABLE'
19 *
bb554eb4 20 * @package core_webservice
21 * @copyright 1999 onwards Martin Dougiamas {@link}
22 * @license GNU GPL v3 or later
23 */
5593d2dc 25$string['accessexception'] = 'Access control exception';
26$string['actwebserviceshhdr'] = 'Active web service protocols';
27$string['addaservice'] = 'Add service';
3e6161fb 28$string['addcapabilitytousers'] = 'Check users capability';
a203cb67 29$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 30$string['addfunction'] = 'Add function';
30c8dd34 31$string['addfunctionhelp'] = 'Select the function to add to the service.';
8399c714 32$string['addfunctions'] = 'Add functions';
a203cb67 33$string['addfunctionsdescription'] = 'Select required functions for the newly created service.';
f085c3ec 34$string['addrequiredcapability'] = 'Assign/unassign the required capability';
30c8dd34 35$string['addservice'] = 'Add a new service: {$a->name} (id: {$a->id})';
1d2a1936 36$string['addservicefunction'] = 'Add functions to the service "{$a}"';
1bd06507 37$string['allusers'] = 'All users';
d4c6ef70 38$string['apiexplorer'] = 'API explorer';
39$string['apiexplorernotavalaible'] = 'API explorer not available yet.';
40$string['arguments'] = 'Arguments';
3785c9e2 41$string['authmethod'] = 'Authentication method';
72f8324e 42$string['callablefromajax'] = 'Callable from AJAX';
5b9735b9 43$string['cannotcreatetoken'] = 'No permission to create web service token for the service {$a}.';
ec0d6ea2 44$string['cannotgetcoursecontents'] = 'Cannot get course contents';
abd9a3d1 45$string['configwebserviceplugins'] = 'For security reasons, only protocols that are in use should be enabled.';
5ae9f539 46$string['context'] = 'Context';
3e6161fb 47$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\'.';
48$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 49$string['createtoken'] = 'Create token';
3e6161fb 50$string['createtokenforuser'] = 'Create a token for a user';
a203cb67 51$string['createtokenforuserdescription'] = 'Create a token for the web services user.';
3e6161fb 52$string['createuser'] = 'Create a specific user';
a203cb67 53$string['createuserdescription'] = 'A web services user is required to represent the system controlling Moodle.';
480fca77 54$string['criteriaerror'] = 'Missing permissions to search on a criterion.';
30c8dd34 55$string['default'] = 'Default to "{$a}"';
a3103a10 56$string['deleteaservice'] = 'Delete service';
30c8dd34 57$string['deleteservice'] = 'Delete the service: {$a->name} (id: {$a->id})';
c25662b0 58$string['deleteserviceconfirm'] = 'Deleting a service will also delete the tokens related to this service. Do you really want to delete external service "{$a}"?';
59$string['deletetokenconfirm'] = 'Do you really want to delete this web service token for <strong>{$a->user}</strong> on the service <strong>{$a->service}</strong>?';
60$string['disabledwarning'] = 'All web service protocols are disabled. The "Enable web services" setting can be found in Advanced features.';
9ef728d6 61$string['doc'] = 'Documentation';
62$string['docaccessrefused'] = 'You are not allowed to see the documentation for this token';
4b4b53a7 63$string['documentation'] = 'web service documentation';
64$string['downloadfiles'] = 'Can download files';
65$string['downloadfiles_help'] = 'If enabled, any user can download files with their security keys. Of course they are restricted to the files they are allowed to download in the site.';
a3103a10 66$string['editaservice'] = 'Edit service';
30c8dd34 67$string['editservice'] = 'Edit the service: {$a->name} (id: {$a->id})';
86c252b4 68$string['enabled'] = 'Enabled';
abd9a3d1 69$string['enabledocumentation'] = 'Enable developer documentation';
a203cb67 70$string['enabledocumentationdescription'] = 'Detailed web services documentation is available for enabled protocols.';
3e6161fb 71$string['enableprotocols'] = 'Enable protocols';
a203cb67 72$string['enableprotocolsdescription'] = 'At least one protocol should be enabled. For security reasons, only protocols that are to be used should be enabled.';
73$string['enablews'] = 'Enable web services';
74$string['enablewsdescription'] = 'Web services must be enabled in Advanced features.';
85b4c447 75$string['entertoken'] = 'Enter a security key/token:';
30c8dd34 76$string['error'] = 'Error: {$a}';
6bb31e40 77$string['errorcatcontextnotvalid'] = 'You cannot execute functions in the category context (category id:{$a->catid}). The context error message was: {$a->message}';
abf7dc44 78$string['errorcodes'] = 'Error message';
e21c56bd 79$string['errorcoursecontextnotvalid'] = 'You cannot execute functions in the course context (course id:{$a->courseid}). The context error message was: {$a->message}';
6bb31e40 80$string['errorinvalidparam'] = 'The param "{$a}" is invalid.';
774b1b0f 81$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.';
774b1b0f 82$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.';
6522afdf 83$string['eventwebservicefunctioncalled'] = 'Web service function called';
84$string['eventwebserviceloginfailed'] = 'Web service login failed';
85$string['eventwebserviceservicecreated'] = 'Web service service created';
86$string['eventwebserviceservicedeleted'] = 'Web service service deleted';
87$string['eventwebserviceserviceupdated'] = 'Web service service updated';
88$string['eventwebserviceserviceuseradded'] = 'Web service service user added';
89$string['eventwebserviceserviceuserremoved'] = 'Web service service user removed';
90$string['eventwebservicetokencreated'] = 'Web service token created';
91$string['eventwebservicetokensent'] = 'Web service token sent';
f5072177 92$string['execute'] = 'Execute';
a203cb67 93$string['executewarnign'] = 'WARNING: If you press execute your database will be modified and changes can not be reverted automatically!';
cc93c7da 94$string['externalservice'] = 'External service';
95$string['externalservicefunctions'] = 'External service functions';
30c8dd34 96$string['externalservices'] = 'External services';
cc93c7da 97$string['externalserviceusers'] = 'External service users';
1e29fe3f 98$string['failedtolog'] = 'Failed to log';
f25aee32 99$string['filenameexist'] = 'File name already exists: {$a}';
47c3dfd5 100$string['forbiddenwsuser'] = 'Can not create token for an unconfirmed, deleted, suspended or guest user.';
cc93c7da 101$string['function'] = 'Function';
102$string['functions'] = 'Functions';
abf7dc44 103$string['generalstructure'] = 'General structure';
30c8dd34 104$string['checkusercapability'] = 'Check user capability';
a203cb67 105$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 106$string['information'] = 'Information';
107$string['installserviceshortnameerror'] = 'Coding error: the service shortname "{$a}" should have contains numbers, letters and _-.. only.';
108$string['installexistingserviceshortnameerror'] = 'A web service with the shortname "{$a}" already exists. Can not install/update a different web service with this shortname.';
109$string['invalidextparam'] = 'Invalid external api parameter: {$a}';
110$string['invalidextresponse'] = 'Invalid external api response: {$a}';
3785c9e2 111$string['invalidiptoken'] = 'Invalid token - your IP is not supported';
112$string['invalidtimedtoken'] = 'Invalid token - token expired';
113$string['invalidtoken'] = 'Invalid token - token not found';
bb1dff21 114$string['iprestriction'] = 'IP restriction';
9447cdc2 115$string['iprestriction_help'] = 'The user will need to call the web service from the listed IPs (separated by commas).';
94e90ab7 116$string['key'] = 'Key';
30c8dd34 117$string['keyshelp'] = 'The keys are used to access your Moodle account from external applications.';
da6ecfd8 118$string['loginrequired'] = 'Restricted to logged-in users';
cc93c7da 119$string['manageprotocols'] = 'Manage protocols';
5ae9f539 120$string['managetokens'] = 'Manage tokens';
121$string['missingcaps'] = 'Missing capabilities';
122$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 123$string['missingpassword'] = 'Missing password';
5b9735b9 124$string['missingrequiredcapability'] = 'The capability {$a} is required.';
b0a9a0cd 125$string['missingusername'] = 'Missing username';
0bf486a6 126$string['missingversionfile'] = 'Coding error: version.php file is missing for the component {$a}';
f8045246 127$string['nameexists'] = 'This name is already in use by another service';
86477112 128$string['nocapabilitytouseparameter'] = 'The user does not have the required capability to use the parameter {$a}';
1d2a1936 129$string['nofunctions'] = 'This service has no functions.';
09179b78 130$string['norequiredcapability'] = 'No required capability';
94e90ab7 131$string['notoken'] = 'The token list is empty.';
132$string['onesystemcontrolling'] = 'Allow an external system to control Moodle';
133$string['onesystemcontrollingdescription'] = 'The following steps help you to set up the Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method.';
7698619b 134$string['onlyseecreatedtokens'] = 'Any token can be deleted, though you can only view tokens that you created.';
5ae9f539 135$string['operation'] = 'Operation';
d4c6ef70 136$string['optional'] = 'Optional';
13ea96c4 137$string['passwordisexpired'] = 'Password is expired.';
360e9415 138$string['phpparam'] = 'XML-RPC (PHP structure)';
139$string['phpresponse'] = 'XML-RPC (PHP structure)';
140$string['postrestparam'] = 'PHP code for REST (POST request)';
86c252b4 141$string['potusers'] = 'Not authorised users';
142$string['potusersmatching'] = 'Not authorised users matching';
f085c3ec 143$string['print'] = 'Print all';
144$string['privacy:metadata:serviceusers'] = 'A list of users who can use a certain external services';
145$string['privacy:metadata:serviceusers:iprestriction'] = 'IP restricted to use the service';
146$string['privacy:metadata:serviceusers:timecreated'] = 'The date at which the record was created';
147$string['privacy:metadata:serviceusers:userid'] = 'The ID of the user';
148$string['privacy:metadata:serviceusers:validuntil'] = 'The date at which the authorisation ends';
149$string['privacy:metadata:tokens'] = 'A record of tokens for interacting with Moodle through web services or Mobile applications.';
150$string['privacy:metadata:tokens:creatorid'] = 'The ID of the user who created the token';
151$string['privacy:metadata:tokens:iprestriction'] = 'IP restricted to use this token';
152$string['privacy:metadata:tokens:lastaccess'] = 'The date at which the token was last used';
9722f6a2 153$string['privacy:metadata:tokens:privatetoken'] = 'A more private token occasionally used to validate certain operations, such as SSO';
154$string['privacy:metadata:tokens:timecreated'] = 'The date at which the token was created';
155$string['privacy:metadata:tokens:token'] = 'The user\'s token';
156$string['privacy:metadata:tokens:tokentype'] = 'The type of token';
157$string['privacy:metadata:tokens:userid'] = 'The ID of the user whose token it is';
9722f6a2 158$string['privacy:metadata:tokens:validuntil'] = 'The date that the token is valid until';
d21c5e38 159$string['privacy:request:notexportedsecurity'] = 'Not exported for security reasons';
cc93c7da 160$string['protocol'] = 'Protocol';
161$string['removefunction'] = 'Remove';
30c8dd34 162$string['removefunctionconfirm'] = 'Do you really want to remove function "{$a->function}" from service "{$a->service}"?';
d4c6ef70 163$string['requireauthentication'] = 'This method requires authentication with xxx permission.';
164$string['required'] = 'Required';
cc93c7da 165$string['requiredcapability'] = 'Required capability';
fbbaa58e 166$string['requiredcapability_help'] = 'If set, only users with the required capability can access the service.';
72f68b51 167$string['requiredcaps'] = 'Required capabilities';
30c8dd34 168$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 169$string['resettokenconfirmsimple'] = 'Do you really want to reset this key? Any saved links containing the old key will not work anymore.';
d4c6ef70 170$string['response'] = 'Response';
360e9415 171$string['restcode'] = 'REST';
abf7dc44 172$string['restexception'] = 'REST';
886e3bfb 173$string['restparam'] = 'REST (POST parameters)';
86c252b4 174$string['restrictedusers'] = 'Authorised users only';
a203cb67 175$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 176$string['restoredaccountresetpassword'] = 'Restored account need to reset password before getting a token.';
30c8dd34 177$string['securitykey'] = 'Security key (token)';
94e90ab7 178$string['securitykeys'] = 'Security keys';
86dcc6f0 179$string['selectauthorisedusers'] = 'Select authorised users';
09179b78 180$string['selectedcapability'] = 'Selected';
30c8dd34 181$string['selectedcapabilitydoesntexit'] = 'The currently set required capability ({$a}) doesn\'t exist any more. Please change it and save the changes.';
f05d2193 182$string['selectservice'] = 'Select a service';
3e6161fb 183$string['selectspecificuser'] = 'Select a specific user';
a203cb67 184$string['selectspecificuserdescription'] = 'Add the web services user as an authorised user.';
5ae9f539 185$string['service'] = 'Service';
a203cb67 186$string['servicehelpexplanation'] = 'A service is a set of functions. A service can be accessed by all users or just specified users.';
b5c6b61d 187$string['servicename'] = 'Service name';
675e402a 188$string['servicenotavailable'] = 'Web service is not available (it doesn\'t exist or might be disabled)';
feb6a520 189$string['servicerequireslogin'] = 'Web service is not available (the session has been logged out or has expired)';
cc93c7da 190$string['servicesbuiltin'] = 'Built-in services';
191$string['servicescustom'] = 'Custom services';
86c252b4 192$string['serviceusers'] = 'Authorised users';
86dcc6f0 193$string['serviceusersettings'] = 'User settings';
86c252b4 194$string['serviceusersmatching'] = 'Authorised users matching';
195$string['serviceuserssettings'] = 'Change settings for the authorised users';
0a8ab747 196$string['shortnametaken'] = 'Short name is already used for another service ({$a})';
197$string['simpleauthlog'] = 'Simple authentication login';
198$string['step'] = 'Step';
5e963820 199$string['supplyinfo'] = 'More details';
4887d152 200$string['testauserwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Before doing so, log in as a user with the moodle/webservice:createtoken capability and obtain the security key (token) via the user\'s preferences page. 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 201$string['testclient'] = 'Web service test client';
13ae7db2 202$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 203$string['testwithtestclient'] = 'Test the service';
a203cb67 204$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 205$string['token'] = 'Token';
1e29fe3f 206$string['tokenauthlog'] = 'Token authentication';
1bd06507 207$string['tokencreatedbyadmin'] = 'Can only be reset by administrator (*)';
b721742a 208$string['tokencreator'] = 'Creator';
ec0d6ea2 209$string['unknownoptionkey'] = 'Unknown option key ({$a})';
fd6ab92b 210$string['unnamedstringparam'] = 'A string parameter is unnamed.';
86dcc6f0 211$string['updateusersettings'] = 'Update';
212$string['uploadfiles'] = 'Can upload files';
213$string['uploadfiles_help'] = 'If enabled, any user can upload files with their security keys to their own private files area or a draft file area. Any user file quotas apply.';
3e6161fb 214$string['userasclients'] = 'Users as clients with token';
4887d152 215$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 their token from the security keys page via their preferences page.';
a203cb67 216$string['usermissingcaps'] = 'Missing capabilities: {$a}';
217$string['usernameorid'] = 'Username / User id';
218$string['usernameorid_help'] = 'Enter a username or a user id.';
219$string['usernameoridnousererror'] = 'No users were found with this username/user id.';
220$string['usernameoridoccurenceerror'] = 'More than one user was found with this username. Please enter the user id.';
a44460b5 221$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.';
9d382a94 222$string['userservices'] = 'User services: {$a}';
86dcc6f0 223$string['usersettingssaved'] = 'User settings saved';
30c8dd34 224$string['validuntil'] = 'Valid until';
86dcc6f0 225$string['validuntil_help'] = 'If set, the service will be inactivated after this date for this user.';
4c148856 226$string['webservice'] = 'Web service';
cc93c7da 227$string['webservices'] = 'Web services';
3e6161fb 228$string['webservicesoverview'] = 'Overview';
5ae9f539 229$string['webservicetokens'] = 'Web service tokens';
b0a9a0cd 230$string['wrongusernamepassword'] = 'Wrong username or password';
231$string['wsaccessuserdeleted'] = 'Refused web service access for deleted username: {$a}';
232$string['wsaccessuserexpired'] = 'Refused web service access for password expired username: {$a}';
233$string['wsaccessusernologin'] = 'Refused web service access for nologin authentication username: {$a}';
234$string['wsaccessusersuspended'] = 'Refused web service access for suspended username: {$a}';
235$string['wsaccessuserunconfirmed'] = 'Refused web service access for unconfirmed username: {$a}';
390cc887 236$string['wsclientdoc'] = 'Moodle web service client documentation';
cde291ed 237$string['wsdocapi'] = 'API Documentation';
d4c6ef70 238$string['wsdocumentation'] = 'Web service documentation';
7886efc4 239$string['wsdocumentationdisable'] = 'Web service documentation is disabled.';
9ef728d6 240$string['wsdocumentationintro'] = 'To create a client we advise you to read the {$a->doclink}';
85b4c447 241$string['wsdocumentationlogin'] = 'or enter your web service username and password:';
d4c6ef70 242$string['wspassword'] = 'Web service password';
243$string['wsusername'] = 'Web service username';