Merge branch 'MDL-45257-master-2nd' of git://
[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';
27$string['actwebserviceshhdr'] = 'Active web service protocols';
28$string['addaservice'] = 'Add service';
3e6161fb 29$string['addcapabilitytousers'] = 'Check users capability';
a203cb67 30$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 31$string['addfunction'] = 'Add function';
30c8dd34 32$string['addfunctionhelp'] = 'Select the function to add to the service.';
8399c714 33$string['addfunctions'] = 'Add functions';
a203cb67 34$string['addfunctionsdescription'] = 'Select required functions for the newly created service.';
f085c3ec 35$string['addrequiredcapability'] = 'Assign/unassign the required capability';
30c8dd34 36$string['addservice'] = 'Add a new service: {$a->name} (id: {$a->id})';
1d2a1936 37$string['addservicefunction'] = 'Add functions to the service "{$a}"';
1bd06507 38$string['allusers'] = 'All users';
47ee1c35 39$string['amftestclient'] = 'AMF test client';
d4c6ef70 40$string['apiexplorer'] = 'API explorer';
41$string['apiexplorernotavalaible'] = 'API explorer not available yet.';
42$string['arguments'] = 'Arguments';
3785c9e2 43$string['authmethod'] = 'Authentication method';
5b9735b9 44$string['cannotcreatetoken'] = 'No permission to create web service token for the service {$a}.';
ec0d6ea2 45$string['cannotgetcoursecontents'] = 'Cannot get course contents';
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';
a203cb67 52$string['createtokenforuserdescription'] = 'Create a token for the web services user.';
3e6161fb 53$string['createuser'] = 'Create a specific user';
a203cb67 54$string['createuserdescription'] = 'A web services user is required to represent the system controlling Moodle.';
480fca77 55$string['criteriaerror'] = 'Missing permissions to search on a criterion.';
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';
65$string['downloadfiles'] = 'Can download files';
66$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 67$string['editaservice'] = 'Edit service';
30c8dd34 68$string['editservice'] = 'Edit the service: {$a->name} (id: {$a->id})';
86c252b4 69$string['enabled'] = 'Enabled';
abd9a3d1 70$string['enabledocumentation'] = 'Enable developer documentation';
a203cb67 71$string['enabledocumentationdescription'] = 'Detailed web services documentation is available for enabled protocols.';
fa698a15 72$string['enablemobilewsoverview'] = 'Go to {$a->manageservicelink} administration page, check the "{$a->enablemobileservice}" setting and Save. Everything will be setup for you and all site\'s users will be able to use the offical Moodle app. Current status: {$a->wsmobilestatus}';
3e6161fb 73$string['enableprotocols'] = 'Enable protocols';
a203cb67 74$string['enableprotocolsdescription'] = 'At least one protocol should be enabled. For security reasons, only protocols that are to be used should be enabled.';
75$string['enablews'] = 'Enable web services';
76$string['enablewsdescription'] = 'Web services must be enabled in Advanced features.';
85b4c447 77$string['entertoken'] = 'Enter a security key/token:';
30c8dd34 78$string['error'] = 'Error: {$a}';
6bb31e40 79$string['errorcatcontextnotvalid'] = 'You cannot execute functions in the category context (category id:{$a->catid}). The context error message was: {$a->message}';
abf7dc44 80$string['errorcodes'] = 'Error message';
e21c56bd 81$string['errorcoursecontextnotvalid'] = 'You cannot execute functions in the course context (course id:{$a->courseid}). The context error message was: {$a->message}';
6bb31e40 82$string['errorinvalidparam'] = 'The param "{$a}" is invalid.';
774b1b0f 83$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 84$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.';
85$string['event_webservice_function_called'] = 'Web service function called';
86$string['event_webservice_login_failed'] = 'Web service login failed';
87$string['event_webservice_service_created'] = 'Web service service created';
7ed25f48 88$string['event_webservice_service_deleted'] = 'Web service service deleted';
89$string['event_webservice_service_updated'] = 'Web service service updated';
90$string['event_webservice_service_user_added'] = 'Web service service user added';
91$string['event_webservice_service_user_removed'] = 'Web service service user removed';
92$string['event_webservice_token_created'] = 'Web service token created';
93$string['event_webservice_token_sent'] = 'Web service token sent';
f5072177 94$string['execute'] = 'Execute';
a203cb67 95$string['executewarnign'] = 'WARNING: If you press execute your database will be modified and changes can not be reverted automatically!';
cc93c7da 96$string['externalservice'] = 'External service';
97$string['externalservicefunctions'] = 'External service functions';
30c8dd34 98$string['externalservices'] = 'External services';
cc93c7da 99$string['externalserviceusers'] = 'External service users';
1e29fe3f 100$string['failedtolog'] = 'Failed to log';
f25aee32 101$string['filenameexist'] = 'File name already exists: {$a}';
47c3dfd5 102$string['forbiddenwsuser'] = 'Can not create token for an unconfirmed, deleted, suspended or guest user.';
cc93c7da 103$string['function'] = 'Function';
104$string['functions'] = 'Functions';
abf7dc44 105$string['generalstructure'] = 'General structure';
30c8dd34 106$string['checkusercapability'] = 'Check user capability';
a203cb67 107$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 108$string['information'] = 'Information';
109$string['installserviceshortnameerror'] = 'Coding error: the service shortname "{$a}" should have contains numbers, letters and _-.. only.';
110$string['installexistingserviceshortnameerror'] = 'A web service with the shortname "{$a}" already exists. Can not install/update a different web service with this shortname.';
111$string['invalidextparam'] = 'Invalid external api parameter: {$a}';
112$string['invalidextresponse'] = 'Invalid external api response: {$a}';
3785c9e2 113$string['invalidiptoken'] = 'Invalid token - your IP is not supported';
114$string['invalidtimedtoken'] = 'Invalid token - token expired';
115$string['invalidtoken'] = 'Invalid token - token not found';
bb1dff21 116$string['iprestriction'] = 'IP restriction';
86dcc6f0 117$string['iprestriction_help'] = 'The user will need to call web service from the listed IPs.';
94e90ab7 118$string['key'] = 'Key';
30c8dd34 119$string['keyshelp'] = 'The keys are used to access your Moodle account from external applications.';
cc93c7da 120$string['manageprotocols'] = 'Manage protocols';
5ae9f539 121$string['managetokens'] = 'Manage tokens';
122$string['missingcaps'] = 'Missing capabilities';
123$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 124$string['missingpassword'] = 'Missing password';
5b9735b9 125$string['missingrequiredcapability'] = 'The capability {$a} is required.';
b0a9a0cd 126$string['missingusername'] = 'Missing username';
0bf486a6 127$string['missingversionfile'] = 'Coding error: version.php file is missing for the component {$a}';
128$string['mobilewsdisabled'] = 'Disabled';
129$string['mobilewsenabled'] = 'Enabled';
86477112 130$string['nocapabilitytouseparameter'] = 'The user does not have the required capability to use the parameter {$a}';
1d2a1936 131$string['nofunctions'] = 'This service has no functions.';
09179b78 132$string['norequiredcapability'] = 'No required capability';
94e90ab7 133$string['notoken'] = 'The token list is empty.';
134$string['onesystemcontrolling'] = 'Allow an external system to control Moodle';
135$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.';
5ae9f539 136$string['operation'] = 'Operation';
d4c6ef70 137$string['optional'] = 'Optional';
13ea96c4 138$string['passwordisexpired'] = 'Password is expired.';
360e9415 139$string['phpparam'] = 'XML-RPC (PHP structure)';
140$string['phpresponse'] = 'XML-RPC (PHP structure)';
141$string['postrestparam'] = 'PHP code for REST (POST request)';
86c252b4 142$string['potusers'] = 'Not authorised users';
143$string['potusersmatching'] = 'Not authorised users matching';
f085c3ec 144$string['print'] = 'Print all';
cc93c7da 145$string['protocol'] = 'Protocol';
146$string['removefunction'] = 'Remove';
30c8dd34 147$string['removefunctionconfirm'] = 'Do you really want to remove function "{$a->function}" from service "{$a->service}"?';
d4c6ef70 148$string['requireauthentication'] = 'This method requires authentication with xxx permission.';
149$string['required'] = 'Required';
cc93c7da 150$string['requiredcapability'] = 'Required capability';
fbbaa58e 151$string['requiredcapability_help'] = 'If set, only users with the required capability can access the service.';
72f68b51 152$string['requiredcaps'] = 'Required capabilities';
30c8dd34 153$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 154$string['resettokenconfirmsimple'] = 'Do you really want to reset this key? Any saved links containing the old key will not work anymore.';
d4c6ef70 155$string['response'] = 'Response';
360e9415 156$string['restcode'] = 'REST';
abf7dc44 157$string['restexception'] = 'REST';
886e3bfb 158$string['restparam'] = 'REST (POST parameters)';
86c252b4 159$string['restrictedusers'] = 'Authorised users only';
a203cb67 160$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 161$string['restoredaccountresetpassword'] = 'Restored account need to reset password before getting a token.';
30c8dd34 162$string['securitykey'] = 'Security key (token)';
94e90ab7 163$string['securitykeys'] = 'Security keys';
86dcc6f0 164$string['selectauthorisedusers'] = 'Select authorised users';
09179b78 165$string['selectedcapability'] = 'Selected';
30c8dd34 166$string['selectedcapabilitydoesntexit'] = 'The currently set required capability ({$a}) doesn\'t exist any more. Please change it and save the changes.';
f05d2193 167$string['selectservice'] = 'Select a service';
3e6161fb 168$string['selectspecificuser'] = 'Select a specific user';
a203cb67 169$string['selectspecificuserdescription'] = 'Add the web services user as an authorised user.';
5ae9f539 170$string['service'] = 'Service';
a203cb67 171$string['servicehelpexplanation'] = 'A service is a set of functions. A service can be accessed by all users or just specified users.';
b5c6b61d 172$string['servicename'] = 'Service name';
675e402a 173$string['servicenotavailable'] = 'Web service is not available (it doesn\'t exist or might be disabled)';
cc93c7da 174$string['servicesbuiltin'] = 'Built-in services';
175$string['servicescustom'] = 'Custom services';
86c252b4 176$string['serviceusers'] = 'Authorised users';
86dcc6f0 177$string['serviceusersettings'] = 'User settings';
86c252b4 178$string['serviceusersmatching'] = 'Authorised users matching';
179$string['serviceuserssettings'] = 'Change settings for the authorised users';
0a8ab747 180$string['shortnametaken'] = 'Short name is already used for another service ({$a})';
181$string['simpleauthlog'] = 'Simple authentication login';
182$string['step'] = 'Step';
5e963820 183$string['supplyinfo'] = 'More details';
a203cb67 184$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 185$string['testclient'] = 'Web service test client';
47ee1c35 186$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 187$string['testwithtestclient'] = 'Test the service';
a203cb67 188$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 189$string['token'] = 'Token';
1e29fe3f 190$string['tokenauthlog'] = 'Token authentication';
1bd06507 191$string['tokencreatedbyadmin'] = 'Can only be reset by administrator (*)';
b721742a 192$string['tokencreator'] = 'Creator';
ec0d6ea2 193$string['unknownoptionkey'] = 'Unknown option key ({$a})';
fd6ab92b 194$string['unnamedstringparam'] = 'A string parameter is unnamed.';
86dcc6f0 195$string['updateusersettings'] = 'Update';
196$string['uploadfiles'] = 'Can upload files';
197$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 198$string['userasclients'] = 'Users as clients with token';
199$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.';
200$string['usermissingcaps'] = 'Missing capabilities: {$a}';
201$string['usernameorid'] = 'Username / User id';
202$string['usernameorid_help'] = 'Enter a username or a user id.';
203$string['usernameoridnousererror'] = 'No users were found with this username/user id.';
204$string['usernameoridoccurenceerror'] = 'More than one user was found with this username. Please enter the user id.';
a44460b5 205$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 206$string['usersettingssaved'] = 'User settings saved';
30c8dd34 207$string['validuntil'] = 'Valid until';
86dcc6f0 208$string['validuntil_help'] = 'If set, the service will be inactivated after this date for this user.';
4c148856 209$string['webservice'] = 'Web service';
cc93c7da 210$string['webservices'] = 'Web services';
3e6161fb 211$string['webservicesoverview'] = 'Overview';
5ae9f539 212$string['webservicetokens'] = 'Web service tokens';
b0a9a0cd 213$string['wrongusernamepassword'] = 'Wrong username or password';
214$string['wsaccessuserdeleted'] = 'Refused web service access for deleted username: {$a}';
215$string['wsaccessuserexpired'] = 'Refused web service access for password expired username: {$a}';
216$string['wsaccessusernologin'] = 'Refused web service access for nologin authentication username: {$a}';
217$string['wsaccessusersuspended'] = 'Refused web service access for suspended username: {$a}';
218$string['wsaccessuserunconfirmed'] = 'Refused web service access for unconfirmed username: {$a}';
390cc887 219$string['wsclientdoc'] = 'Moodle web service client documentation';
cde291ed 220$string['wsdocapi'] = 'API Documentation';
d4c6ef70 221$string['wsdocumentation'] = 'Web service documentation';
7886efc4 222$string['wsdocumentationdisable'] = 'Web service documentation is disabled.';
9ef728d6 223$string['wsdocumentationintro'] = 'To create a client we advise you to read the {$a->doclink}';
85b4c447 224$string['wsdocumentationlogin'] = 'or enter your web service username and password:';
d4c6ef70 225$string['wspassword'] = 'Web service password';
226$string['wsusername'] = 'Web service username';