MDL-28650 add a page in the administration to the full web service API (API documenta...
[moodle.git] / lang / en / webservice.php
1 <?php
3 // This file is part of Moodle -
4 //
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.
9 //
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.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <>.
18 /**
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  */
26 $string['accessexception'] = 'Access control exception';
27 $string['accessnotallowed'] = 'Access to web service not allowed';
28 $string['actwebserviceshhdr'] = 'Active web service protocols';
29 $string['addaservice'] = 'Add service';
30 $string['addcapabilitytousers'] = 'Check users capability';
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.';
32 $string['addfunction'] = 'Add function';
33 $string['addfunctionhelp'] = 'Select the function to add to the service.';
34 $string['addfunctions'] = 'Add functions';
35 $string['addfunctionsdescription'] = 'Select required functions for the newly created service.';
36 $string['addrequiredcapability'] = 'Assign/unassign the required capability';
37 $string['addservice'] = 'Add a new service: {$a->name} (id: {$a->id})';
38 $string['addservicefunction'] = 'Add functions to the service "{$a}"';
39 $string['allusers'] = 'All users';
40 $string['amftestclient'] = 'AMF test client';
41 $string['apiexplorer'] = 'API explorer';
42 $string['apiexplorernotavalaible'] = 'API explorer not available yet.';
43 $string['arguments'] = 'Arguments';
44 $string['authmethod'] = 'Authentication method';
45 $string['cannotcreatemobiletoken'] = 'No permission to create web service token for mobile access.';
46 $string['configwebserviceplugins'] = 'For security reasons, only protocols that are in use should be enabled.';
47 $string['context'] = 'Context';
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\'.';
50 $string['createtoken'] = 'Create token';
51 $string['createtokenforuser'] = 'Create a token for a user';
52 $string['createtokenforuserauto'] = 'Create a token for a user automatically';
53 $string['createtokenforuserdescription'] = 'Create a token for the web services user.';
54 $string['createuser'] = 'Create a specific user';
55 $string['createuserdescription'] = 'A web services user is required to represent the system controlling Moodle.';
56 $string['default'] = 'Default to "{$a}"';
57 $string['deleteaservice'] = 'Delete service';
58 $string['deleteservice'] = 'Delete the service: {$a->name} (id: {$a->id})';
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.';
62 $string['doc'] = 'Documentation';
63 $string['docaccessrefused'] = 'You are not allowed to see the documentation for this token';
64 $string['documentation'] = 'web service documentation';
65 $string['editaservice'] = 'Edit service';
66 $string['editservice'] = 'Edit the service: {$a->name} (id: {$a->id})';
67 $string['enabled'] = 'Enabled';
68 $string['enabledocumentation'] = 'Enable developer documentation';
69 $string['enabledocumentationdescription'] = 'Detailed web services documentation is available for enabled protocols.';
70 $string['enableprotocols'] = 'Enable protocols';
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.';
74 $string['entertoken'] = 'Enter a security key/token:';
75 $string['error'] = 'Error: {$a}';
76 $string['errorcatcontextnotvalid'] = 'You cannot execute functions in the category context (category id:{$a->catid}). The context error message was: {$a->message}';
77 $string['errorcodes'] = 'Error message';
78 $string['errorcoursecontextnotvalid'] = 'You cannot execute functions in the course context (course id:{$a->courseid}). The context error message was: {$a->message}';
79 $string['errorinvalidparam'] = 'The param "{$a}" is invalid.';
80 $string['errorinvalidparamsapi'] = 'Invalid external api parameter';
81 $string['errorinvalidparamsdesc'] = 'Invalid external api description';
82 $string['errorinvalidresponseapi'] = 'Invalid external api response';
83 $string['errorinvalidresponsedesc'] = 'Invalid external api response description';
84 $string['errormissingkey'] = 'Missing required key in single structure: {$a}';
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.';
86 $string['erroronlyarray'] = 'Only arrays accepted.';
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.';
88 $string['errorresponsemissingkey'] = 'Error in response - Missing following required key in a single structure: {$a}';
89 $string['errorscalartype'] = 'Scalar type expected, array or object received.';
90 $string['errorunexpectedkey'] = 'Unexpected keys ({$a}) detected in parameter array.';
91 $string['execute'] = 'Execute';
92 $string['executewarnign'] = 'WARNING: If you press execute your database will be modified and changes can not be reverted automatically!';
93 $string['externalservice'] = 'External service';
94 $string['externalservicefunctions'] = 'External service functions';
95 $string['externalservices'] = 'External services';
96 $string['externalserviceusers'] = 'External service users';
97 $string['failedtolog'] = 'Failed to log';
98 $string['function'] = 'Function';
99 $string['functions'] = 'Functions';
100 $string['generalstructure'] = 'General structure';
101 $string['checkusercapability'] = 'Check user capability';
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.';
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}';
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';
111 $string['invalidtokensession'] = 'Invalid session based token - session not found or expired';
112 $string['iprestriction'] = 'IP restriction';
113 $string['iprestriction_help'] = 'The user will need to call web service from the listed IPs.';
114 $string['key'] = 'Key';
115 $string['keyshelp'] = 'The keys are used to access your Moodle account from external applications.';
116 $string['manageprotocols'] = 'Manage protocols';
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.';
120 $string['missingpassword'] = 'Missing password';
121 $string['missingusername'] = 'Missing username';
122 $string['missingversionfile'] = 'Coding error: version.php file is missing for the component {$a}';
123 $string['nofunctions'] = 'This service has no functions.';
124 $string['norequiredcapability'] = 'No required capability';
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.';
128 $string['operation'] = 'Operation';
129 $string['optional'] = 'Optional';
130 $string['passwordisexpired'] = 'Password is expired.';
131 $string['phpparam'] = 'XML-RPC (PHP structure)';
132 $string['phpresponse'] = 'XML-RPC (PHP structure)';
133 $string['postrestparam'] = 'PHP code for REST (POST request)';
134 $string['potusers'] = 'Not authorised users';
135 $string['potusersmatching'] = 'Not authorised users matching';
136 $string['print'] = 'Print all';
137 $string['protocol'] = 'Protocol';
138 $string['removefunction'] = 'Remove';
139 $string['removefunctionconfirm'] = 'Do you really want to remove function "{$a->function}" from service "{$a->service}"?';
140 $string['requireauthentication'] = 'This method requires authentication with xxx permission.';
141 $string['required'] = 'Required';
142 $string['requiredcapability'] = 'Required capability';
143 $string['requiredcapability_help'] = 'If set, only users with the required capability can access the service.';
144 $string['requiredcaps'] = 'Required capabilities';
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>?';
146 $string['resettokenconfirmsimple'] = 'Do you really want to reset this key? Any saved links containing the old key will not work anymore.';
147 $string['response'] = 'Response';
148 $string['restcode'] = 'REST';
149 $string['restexception'] = 'REST';
150 $string['restparam'] = 'REST (POST parameters)';
151 $string['restrictedusers'] = 'Authorised users only';
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.';
153 $string['restoredaccountresetpassword'] = 'Restored account need to reset password before getting a token.';
154 $string['securitykey'] = 'Security key (token)';
155 $string['securitykeys'] = 'Security keys';
156 $string['selectauthorisedusers'] = 'Select authorised users';
157 $string['selectedcapability'] = 'Selected';
158 $string['selectedcapabilitydoesntexit'] = 'The currently set required capability ({$a}) doesn\'t exist any more. Please change it and save the changes.';
159 $string['selectservice'] = 'Select a service';
160 $string['selectspecificuser'] = 'Select a specific user';
161 $string['selectspecificuserdescription'] = 'Add the web services user as an authorised user.';
162 $string['service'] = 'Service';
163 $string['servicehelpexplanation'] = 'A service is a set of functions. A service can be accessed by all users or just specified users.';
164 $string['servicename'] = 'Service name';
165 $string['servicesbuiltin'] = 'Built-in services';
166 $string['servicescustom'] = 'Custom services';
167 $string['serviceusers'] = 'Authorised users';
168 $string['serviceusersettings'] = 'User settings';
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';
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>';
174 $string['testclient'] = 'Web service test client';
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}.';
176 $string['testwithtestclient'] = 'Test the service';
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>';
178 $string['token'] = 'Token';
179 $string['tokenauthlog'] = 'Token authentication';
180 $string['tokencreatedbyadmin'] = 'Can only be reset by administrator (*)';
181 $string['tokencreator'] = 'Creator';
182 $string['updateusersettings'] = 'Update';
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}';
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.';
187 $string['usersettingssaved'] = 'User settings saved';
188 $string['validuntil'] = 'Valid until';
189 $string['validuntil_help'] = 'If set, the service will be inactivated after this date for this user.';
190 $string['webservice'] = 'Web service';
191 $string['webservices'] = 'Web services';
192 $string['webservicesoverview'] = 'Overview';
193 $string['webservicetokens'] = 'Web service tokens';
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.';
197 $string['wsclientdoc'] = 'Moodle web service client documentation';
198 $string['wsdocapi'] = 'API Documentation';
199 $string['wsdocumentation'] = 'Web service documentation';
200 $string['wsdocumentationdisable'] = 'Web service documentation is disabled.';
201 $string['wsdocumentationintro'] = 'To create a client we advise you to read the {$a->doclink}';
202 $string['wsdocumentationlogin'] = 'or enter your web service username and password:';
203 $string['wspassword'] = 'Web service password';
204 $string['wsusername'] = 'Web service username';