├── LICENSE.md ├── REST_AccountService_V1.cls ├── REST_AccountService_V2.cls ├── REST_AccountService_V3.cls ├── REST_AccountService_V4.cls ├── REST_AccountService_V5.cls ├── REST_AccountService_V6.cls ├── REST_AccountService_V6_Test.cls └── REST_AccountService_V7.cls /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /REST_AccountService_V1.cls: -------------------------------------------------------------------------------- 1 | /**************************************************************************************************** 2 | * Description - Sample Apex REST service with GET method 3 | * Author - Matthew Lamb 4 | ****************************************************************************************************/ 5 | 6 | @RestResource(urlMapping='/v1/accounts/*') 7 | global with sharing class REST_AccountService_V1 { 8 | 9 | @HttpGet 10 | global static Account doGet() { 11 | RestRequest req = RestContext.request; 12 | RestResponse res = RestContext.response; 13 | 14 | String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1); 15 | 16 | Account result = [SELECT Id, Name, Phone, Website, BillingState FROM Account WHERE External_Id__c = :accountId]; 17 | return result; 18 | } 19 | } -------------------------------------------------------------------------------- /REST_AccountService_V2.cls: -------------------------------------------------------------------------------- 1 | /**************************************************************************************************** 2 | * Description - Sample Apex REST service with GET method 3 | * Author - Matthew Lamb 4 | ****************************************************************************************************/ 5 | 6 | @RestResource(urlMapping='/v2/accounts/*') 7 | global with sharing class REST_AccountService_V2 { 8 | 9 | @HttpGet 10 | global static AccountWrapper doGet() { 11 | RestRequest req = RestContext.request; 12 | RestResponse res = RestContext.response; 13 | AccountWrapper response = new AccountWrapper(); 14 | 15 | String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1); 16 | 17 | List result = [SELECT Id, Name, Phone, Website FROM Account WHERE External_Id__c = :accountId]; 18 | 19 | if(result != null && result.size() > 0) { 20 | response.acct = result[0]; 21 | response.status = 'Success'; 22 | } 23 | else { 24 | response.acct = null; 25 | response.status = 'Error'; 26 | response.message = 'This account could not be found, please try again.'; 27 | res.StatusCode = 404; 28 | } 29 | 30 | return response; 31 | } 32 | 33 | global class AccountWrapper { 34 | public Account acct; 35 | public String status; 36 | public String message; 37 | 38 | public AccountWrapper(){} 39 | } 40 | } -------------------------------------------------------------------------------- /REST_AccountService_V3.cls: -------------------------------------------------------------------------------- 1 | /**************************************************************************************************** 2 | * Description - Sample Apex REST service with GET method 3 | * Author - Matthew Lamb 4 | ****************************************************************************************************/ 5 | 6 | @RestResource(urlMapping='/v3/accounts/*') 7 | global with sharing class REST_AccountService_V3 { 8 | 9 | @HttpGet 10 | global static AccountWrapper doGet() { 11 | RestRequest req = RestContext.request; 12 | RestResponse res = RestContext.response; 13 | AccountWrapper response = new AccountWrapper(); 14 | 15 | String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1); 16 | 17 | if(doSearch(accountId)) { 18 | searchAccounts(req, res, response); 19 | } 20 | else { 21 | findAccount(res, response, accountId); 22 | } 23 | 24 | return response; 25 | } 26 | 27 | 28 | // If the item to the right of the last forward slash is "accounts", the request went to v3/accounts?Name=United 29 | // Else the request went to v3/accounts/, which is not a search, but a specific entity 30 | private static boolean doSearch(String accountId) { 31 | if(accountId == 'accounts') { 32 | return true; 33 | } 34 | return false; 35 | } 36 | 37 | //If the request came to /v3/accounts, then we want to execute a search 38 | private static void searchAccounts(RestRequest req, RestResponse res, AccountWrapper response) { 39 | 40 | //Use the RestRequest's params to fetch the Name parameter 41 | String searchTerm = req.params.get('Name'); 42 | 43 | if(searchTerm == null || searchTerm == '') { 44 | response.status = 'Error'; 45 | response.message = 'You must provide a Name for your search term.'; 46 | res.StatusCode = 400; 47 | } 48 | else { 49 | String searchText = '%'+searchTerm+'%'; 50 | List searchResults = [SELECT Id, Name, Phone, Website FROM Account WHERE Name LIKE : searchText]; 51 | 52 | if(searchResults != null && searchResults.size() > 0) { 53 | response.acctList = searchResults; 54 | response.status = 'Success'; 55 | response.message = searchResults.size() + ' Accounts were found that matched your search term.'; 56 | } 57 | else { 58 | response.status = 'Error'; 59 | response.message = 'No Accounts where found based on that Name, please search again.'; 60 | } 61 | } 62 | } 63 | 64 | //If the request came to v3/accounts/, then we want to find a specific account 65 | private static void findAccount(RestResponse res, AccountWrapper response, String accountId) { 66 | 67 | // Provided we recevied an External Id, perform the search and return the results 68 | if(accountId != null && accountId != '') { 69 | List result = [SELECT Id, Name, Phone, Website FROM Account WHERE External_Id__c =: accountId]; 70 | 71 | if(result != null && result.size() > 0) { 72 | response.acctList.add(result[0]); 73 | response.status = 'Success'; 74 | } 75 | else { 76 | response.status = 'Error'; 77 | response.message = 'This account could not be found, please try again.'; 78 | res.StatusCode = 404; 79 | } 80 | } 81 | // If the request came to /v3/accounts/ (without an Account Id), return an error 82 | else { 83 | response.status = 'Error'; 84 | response.message = 'You must specify an External Id.'; 85 | res.StatusCode = 400; 86 | } 87 | } 88 | 89 | global class AccountWrapper { 90 | public List acctList; 91 | public String status; 92 | public String message; 93 | 94 | public AccountWrapper(){ 95 | acctList = new List(); 96 | } 97 | } 98 | } -------------------------------------------------------------------------------- /REST_AccountService_V4.cls: -------------------------------------------------------------------------------- 1 | /**************************************************************************************************** 2 | * Description - Sample Apex REST service with GET and POST methods 3 | * Author - Matthew Lamb 4 | 5 | { 6 | "name" : "Appirio", 7 | "phone" : "8175281283", 8 | "website" : "www.appirio.com" 9 | } 10 | ****************************************************************************************************/ 11 | 12 | @RestResource(urlMapping='/v4/accounts/*') 13 | global with sharing class REST_AccountService_V4 { 14 | 15 | @HttpPost 16 | global static AccountWrapper doPost(String name, String phone, String website) { 17 | RestRequest req = RestContext.request; 18 | RestResponse res = RestContext.response; 19 | AccountWrapper response = new AccountWrapper(); 20 | 21 | Account acct = new Account(); 22 | acct.Name = name; 23 | acct.Phone = phone; 24 | acct.Website = website; 25 | insert acct; 26 | 27 | response.acctList.add(acct); 28 | response.status = 'Success'; 29 | response.message = 'Your Account was created successfully.'; 30 | return response; 31 | } 32 | 33 | @HttpGet 34 | global static AccountWrapper doGet() { 35 | RestRequest req = RestContext.request; 36 | RestResponse res = RestContext.response; 37 | AccountWrapper response = new AccountWrapper(); 38 | 39 | String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1); 40 | 41 | if(doSearch(accountId)) { 42 | searchAccounts(req, res, response); 43 | } 44 | else { 45 | findAccount(res, response, accountId); 46 | } 47 | 48 | return response; 49 | } 50 | 51 | 52 | // If the item to the right of the last forward slash is "accounts", the request went to v3/accounts?Name=United 53 | // Else the request went to v3/accounts/, which is not a search, but a specific entity 54 | private static boolean doSearch(String accountId) { 55 | if(accountId == 'accounts') { 56 | return true; 57 | } 58 | return false; 59 | } 60 | 61 | //If the request came to /v3/accounts, then we want to execute a search 62 | private static void searchAccounts(RestRequest req, RestResponse res, AccountWrapper response) { 63 | 64 | //Use the RestRequest's params to fetch the Name parameter 65 | String searchTerm = req.params.get('Name'); 66 | 67 | if(searchTerm == null || searchTerm == '') { 68 | response.status = 'Error'; 69 | response.message = 'You must provide a Name for your search term.'; 70 | res.StatusCode = 400; 71 | } 72 | else { 73 | String searchText = '%'+searchTerm+'%'; 74 | List searchResults = [SELECT Id, Name, Phone, Website FROM Account WHERE Name LIKE : searchText]; 75 | 76 | if(searchResults != null && searchResults.size() > 0) { 77 | response.acctList = searchResults; 78 | response.status = 'Success'; 79 | response.message = searchResults.size() + ' Accounts were found that matched your search term.'; 80 | } 81 | else { 82 | response.status = 'Error'; 83 | response.message = 'No Accounts where found based on that Name, please search again.'; 84 | } 85 | } 86 | } 87 | 88 | //If the request came to v3/accounts/, then we want to find a specific account 89 | private static void findAccount(RestResponse res, AccountWrapper response, String accountId) { 90 | 91 | // Provided we recevied an External Id, perform the search and return the results 92 | if(accountId != null && accountId != '') { 93 | List result = [SELECT Id, Name, Phone, Website FROM Account WHERE External_Id__c =: accountId]; 94 | 95 | if(result != null && result.size() > 0) { 96 | response.acctList.add(result[0]); 97 | response.status = 'Success'; 98 | } 99 | else { 100 | response.status = 'Error'; 101 | response.message = 'This account could not be found, please try again.'; 102 | res.StatusCode = 404; 103 | } 104 | } 105 | // If the request came to /v3/accounts/ (without an Account Id), return an error 106 | else { 107 | response.status = 'Error'; 108 | response.message = 'You must specify an External Id.'; 109 | res.StatusCode = 400; 110 | } 111 | } 112 | 113 | global class AccountWrapper { 114 | public List acctList; 115 | public String status; 116 | public String message; 117 | 118 | public AccountWrapper(){ 119 | acctList = new List(); 120 | } 121 | } 122 | } -------------------------------------------------------------------------------- /REST_AccountService_V5.cls: -------------------------------------------------------------------------------- 1 | /**************************************************************************************************** 2 | * Description - Sample Apex REST service with GET and POST methods 3 | * Author - Matthew Lamb 4 | * Example request: 5 | * 6 | { "acct" : 7 | { 8 | "Name" : "Test Company 1", 9 | "AccountNumber" : "123", 10 | "Website" : "www.salesforce.com" 11 | } 12 | } 13 | * 14 | ****************************************************************************************************/ 15 | 16 | @RestResource(urlMapping='/v5/accounts/*') 17 | global with sharing class REST_AccountService_V5 { 18 | 19 | @HttpPost 20 | global static AccountWrapper doPost(Account acct) { 21 | RestRequest req = RestContext.request; 22 | RestResponse res = RestContext.response; 23 | AccountWrapper response = new AccountWrapper(); 24 | 25 | try { 26 | insert acct; 27 | response.acctList.add(acct); 28 | response.status = 'Success'; 29 | response.message = 'Your Account was created successfully'; 30 | } 31 | catch(Exception exc) { 32 | res.StatusCode = 500; 33 | response.acctList = null; 34 | response.status = 'Error'; 35 | response.message = 'Your request failed with the following error: ' + exc.getMessage(); 36 | } 37 | 38 | return response; 39 | } 40 | 41 | @HttpGet 42 | global static AccountWrapper doGet() { 43 | RestRequest req = RestContext.request; 44 | RestResponse res = RestContext.response; 45 | AccountWrapper response = new AccountWrapper(); 46 | 47 | String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1); 48 | 49 | if(doSearch(accountId)) { 50 | searchAccounts(req, res, response); 51 | } 52 | else { 53 | findAccount(res, response, accountId); 54 | } 55 | 56 | return response; 57 | } 58 | 59 | 60 | // If the item to the right of the last forward slash is "accounts", the request went to v3/accounts?Name=United 61 | // Else the request went to v3/accounts/, which is not a search, but a specific entity 62 | private static boolean doSearch(String accountId) { 63 | if(accountId == 'accounts') { 64 | return true; 65 | } 66 | return false; 67 | } 68 | 69 | //If the request came to /v3/accounts, then we want to execute a search 70 | private static void searchAccounts(RestRequest req, RestResponse res, AccountWrapper response) { 71 | 72 | //Use the RestRequest's params to fetch the Name parameter 73 | String searchTerm = req.params.get('Name'); 74 | 75 | if(searchTerm == null || searchTerm == '') { 76 | response.status = 'Error'; 77 | response.message = 'You must provide a Name for your search term.'; 78 | res.StatusCode = 400; 79 | } 80 | else { 81 | String searchText = '%'+searchTerm+'%'; 82 | List searchResults = [SELECT Id, Name, Phone, Website FROM Account WHERE Name LIKE : searchText]; 83 | 84 | if(searchResults != null && searchResults.size() > 0) { 85 | response.acctList = searchResults; 86 | response.status = 'Success'; 87 | response.message = searchResults.size() + ' Accounts were found that matched your search term.'; 88 | } 89 | else { 90 | response.status = 'Error'; 91 | response.message = 'No Accounts where found based on that Name, please search again.'; 92 | } 93 | } 94 | } 95 | 96 | //If the request came to v3/accounts/, then we want to find a specific account 97 | private static void findAccount(RestResponse res, AccountWrapper response, String accountId) { 98 | 99 | // Provided we recevied an External Id, perform the search and return the results 100 | if(accountId != null && accountId != '') { 101 | List result = [SELECT Id, Name, Phone, Website FROM Account WHERE External_Id__c =: accountId]; 102 | 103 | if(result != null && result.size() > 0) { 104 | response.acctList.add(result[0]); 105 | response.status = 'Success'; 106 | } 107 | else { 108 | response.status = 'Error'; 109 | response.message = 'This account could not be found, please try again.'; 110 | res.StatusCode = 404; 111 | } 112 | } 113 | // If the request came to /v3/accounts/ (without an Account Id), return an error 114 | else { 115 | response.status = 'Error'; 116 | response.message = 'You must specify an External Id.'; 117 | res.StatusCode = 400; 118 | } 119 | } 120 | 121 | global class AccountWrapper { 122 | public List acctList; 123 | public String status; 124 | public String message; 125 | 126 | public AccountWrapper(){ 127 | acctList = new List(); 128 | } 129 | } 130 | } -------------------------------------------------------------------------------- /REST_AccountService_V6.cls: -------------------------------------------------------------------------------- 1 | /**************************************************************************************************** 2 | * Description - Sample Apex REST service with GET and POST methods 3 | * Author - Matthew Lamb 4 | * Example request: 5 | * 6 | { "acctList" : 7 | [{ 8 | "Name" : "Test Account 2", 9 | "AccountNumber" : "888", 10 | "Website" : "www.site1.com", 11 | "BillingCity" : "San Francisco" 12 | }, 13 | { 14 | "Name" : "Test Account 3", 15 | "AccountNumber" : "999", 16 | "BillingState" : "CA", 17 | "Active__c" : "true" 18 | }] 19 | } 20 | * 21 | ****************************************************************************************************/ 22 | 23 | @RestResource(urlMapping='/v6/accounts/*') 24 | global with sharing class REST_AccountService_V6 { 25 | 26 | @HttpPost 27 | global static AccountWrapper doPost(List acctList) { 28 | RestRequest req = RestContext.request; 29 | RestResponse res = RestContext.response; 30 | AccountWrapper response = new AccountWrapper(); 31 | 32 | try { 33 | insert acctList; 34 | response.acctList = acctList; 35 | response.status = 'Success'; 36 | response.message = 'Your Accounts have been created successfully'; 37 | } 38 | catch(Exception exc) { 39 | res.StatusCode = 500; 40 | response.acctList = null; 41 | response.status = 'Error'; 42 | response.message = 'Your request failed with the following error: ' + exc.getMessage(); 43 | } 44 | 45 | return response; 46 | } 47 | 48 | @HttpGet 49 | global static AccountWrapper doGet() { 50 | RestRequest req = RestContext.request; 51 | RestResponse res = RestContext.response; 52 | AccountWrapper response = new AccountWrapper(); 53 | 54 | String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1); 55 | 56 | if(doSearch(accountId)) { 57 | searchAccounts(req, res, response); 58 | } 59 | else { 60 | findAccount(res, response, accountId); 61 | } 62 | 63 | return response; 64 | } 65 | 66 | 67 | // If the item to the right of the last forward slash is "accounts", the request went to v3/accounts?Name=United 68 | // Else the request went to v3/accounts/, which is not a search, but a specific entity 69 | private static boolean doSearch(String accountId) { 70 | if(accountId == 'accounts') { 71 | return true; 72 | } 73 | return false; 74 | } 75 | 76 | //If the request came to /v3/accounts, then we want to execute a search 77 | private static void searchAccounts(RestRequest req, RestResponse res, AccountWrapper response) { 78 | 79 | //Use the RestRequest's params to fetch the Name parameter 80 | String searchTerm = req.params.get('Name'); 81 | 82 | if(searchTerm == null || searchTerm == '') { 83 | response.status = 'Error'; 84 | response.message = 'You must provide a Name for your search term.'; 85 | res.StatusCode = 400; 86 | } 87 | else { 88 | String searchText = '%'+searchTerm+'%'; 89 | List searchResults = [SELECT Id, Name, Phone, Website FROM Account WHERE Name LIKE : searchText]; 90 | 91 | if(searchResults != null && searchResults.size() > 0) { 92 | response.acctList = searchResults; 93 | response.status = 'Success'; 94 | response.message = searchResults.size() + ' Accounts were found that matched your search term.'; 95 | } 96 | else { 97 | response.status = 'Error'; 98 | response.message = 'No Accounts where found based on that Name, please search again.'; 99 | } 100 | } 101 | } 102 | 103 | //If the request came to v3/accounts/, then we want to find a specific account 104 | private static void findAccount(RestResponse res, AccountWrapper response, String accountId) { 105 | 106 | // Provided we recevied an External Id, perform the search and return the results 107 | if(accountId != null && accountId != '') { 108 | List result = [SELECT Id, Name, Phone, Website FROM Account WHERE External_Id__c =: accountId]; 109 | 110 | if(result != null && result.size() > 0) { 111 | response.acctList.add(result[0]); 112 | response.status = 'Success'; 113 | } 114 | else { 115 | response.status = 'Error'; 116 | response.message = 'This account could not be found, please try again.'; 117 | res.StatusCode = 404; 118 | } 119 | } 120 | // If the request came to /v3/accounts/ (without an Account Id), return an error 121 | else { 122 | response.status = 'Error'; 123 | response.message = 'You must specify an External Id.'; 124 | res.StatusCode = 400; 125 | } 126 | } 127 | 128 | global class AccountWrapper { 129 | public List acctList; 130 | public String status; 131 | public String message; 132 | 133 | public AccountWrapper(){ 134 | acctList = new List(); 135 | } 136 | } 137 | } -------------------------------------------------------------------------------- /REST_AccountService_V6_Test.cls: -------------------------------------------------------------------------------- 1 | @isTest 2 | private class REST_AccountService_V6_Test { 3 | 4 | static testMethod void testDoGet_WithoutId() { 5 | setupTestData(); 6 | 7 | Test.startTest(); 8 | // Set up the RestContext object 9 | System.RestContext.request = new RestRequest(); 10 | System.RestContext.response = new RestResponse(); 11 | RestContext.request.requestURI = 'https://na15.salesforce.com/services/apexrest/v6/accounts/'; 12 | RestContext.request.httpMethod = 'GET'; 13 | 14 | REST_AccountService_V6.AccountWrapper results = new REST_AccountService_V6.AccountWrapper(); 15 | results = REST_AccountService_V6.doGet(); 16 | Test.stopTest(); 17 | 18 | system.assertEquals(results.status, 'Error'); 19 | system.assertEquals(results.message,'You must specify an External Id.'); 20 | system.assertEquals(System.RestContext.response.StatusCode, 400); 21 | } 22 | 23 | static testMethod void testDoGet_WithGoodId() { 24 | setupTestData(); 25 | 26 | Test.startTest(); 27 | // Set up the RestContext object 28 | System.RestContext.request = new RestRequest(); 29 | System.RestContext.response = new RestResponse(); 30 | RestContext.request.requestURI = 'https://na15.salesforce.com/services/apexrest/v6/accounts/1002'; 31 | RestContext.request.httpMethod = 'GET'; 32 | 33 | REST_AccountService_V6.AccountWrapper results = new REST_AccountService_V6.AccountWrapper(); 34 | results = REST_AccountService_V6.doGet(); 35 | Test.stopTest(); 36 | 37 | system.assertEquals(results.status, 'Success'); 38 | } 39 | 40 | static testMethod void testDoGet_WithBadId() { 41 | setupTestData(); 42 | 43 | Test.startTest(); 44 | // Set up the RestContext object 45 | System.RestContext.request = new RestRequest(); 46 | System.RestContext.response = new RestResponse(); 47 | RestContext.request.requestURI = 'https://na15.salesforce.com/services/apexrest/v6/accounts/6550'; 48 | RestContext.request.httpMethod = 'GET'; 49 | 50 | REST_AccountService_V6.AccountWrapper results = new REST_AccountService_V6.AccountWrapper(); 51 | results = REST_AccountService_V6.doGet(); 52 | Test.stopTest(); 53 | 54 | system.assertEquals(results.status, 'Error'); 55 | system.assertEquals(results.message,'This account could not be found, please try again.'); 56 | system.assertEquals(System.RestContext.response.StatusCode, 404); 57 | } 58 | 59 | private static void setupTestData() { 60 | List accounts = new List(); 61 | accounts.add(new Account(Name='Account 1', Phone='(111) 222-3344', Website='www.account1.com', External_Id__c='1000')); 62 | accounts.add(new Account(Name='Account 2', Phone='(222) 333-4455', Website='www.account1.com', External_Id__c='1001')); 63 | accounts.add(new Account(Name='Account 3', Phone='(333) 444-5566', Website='www.account1.com', External_Id__c='1002')); 64 | accounts.add(new Account(Name='Account 4', Phone='(444) 555-6677', Website='www.account1.com', External_Id__c='1003')); 65 | accounts.add(new Account(Name='Account 5', Phone='(555) 666-7788', Website='www.account1.com', External_Id__c='1004')); 66 | insert accounts; 67 | } 68 | } -------------------------------------------------------------------------------- /REST_AccountService_V7.cls: -------------------------------------------------------------------------------- 1 | /**************************************************************************************************** 2 | * Description - Sample Apex REST service with GET and POST methods 3 | * Author - Matthew Lamb 4 | * Inspiration taken from Mohit Srivastav @ cloudyworlds.blogspot.in 5 | * Original source blog post: http://cloudyworlds.blogspot.in/2012/11/native-parsing-of-json-input-into-user.html 6 | * Example request: 7 | * 8 | { 9 | "rqst" : 10 | { 11 | "acct" : 12 | { 13 | "Name" : "Salesforce.com", 14 | "AccountNumber" : "1001", 15 | "Website" : "www.salesforce.com" 16 | }, 17 | "contList" : 18 | [ 19 | {"FirstName" : "Test", "LastName" : "O'Riley", "Email" : "testcontact1@salesforce.com"}, 20 | {"FirstName" : "Test", "LastName" : "Contact2", "Email" : "testcontact2@salesforce.com"}, 21 | {"FirstName" : "Test", "LastName" : "Contact3", "Email" : "testcontact3@salesforce.com"} 22 | ] 23 | } 24 | } 25 | * 26 | ****************************************************************************************************/ 27 | 28 | @RestResource(urlMapping='/v7/accounts/*') 29 | global with sharing class REST_AccountService_V7 { 30 | 31 | @HttpPost 32 | global static PostResponseWrapper doPost(RequestWrapper rqst) { 33 | RestRequest req = RestContext.request; 34 | RestResponse res = RestContext.response; 35 | PostResponseWrapper response = new PostResponseWrapper(); 36 | 37 | try { 38 | insert rqst.acct; 39 | response.acct = rqst.acct; 40 | 41 | for(Contact con : rqst.contList) { 42 | con.AccountId = rqst.acct.Id; 43 | } 44 | 45 | insert rqst.contList; 46 | response.contList = rqst.contList; 47 | 48 | response.status = 'Success'; 49 | response.message = 'Your Accounts have been created successfully'; 50 | } 51 | catch(Exception exc) { 52 | res.StatusCode = 500; 53 | response.acct = null; 54 | response.contList = null; 55 | response.status = 'Error'; 56 | response.message = 'Your request failed with the following error: ' + exc.getMessage(); 57 | } 58 | 59 | return response; 60 | } 61 | 62 | @HttpGet 63 | global static GetResponseWrapper doGet() { 64 | RestRequest req = RestContext.request; 65 | RestResponse res = RestContext.response; 66 | GetResponseWrapper response = new GetResponseWrapper(); 67 | 68 | String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1); 69 | 70 | if(doSearch(accountId)) { 71 | searchAccounts(req, res, response); 72 | } 73 | else { 74 | findAccount(res, response, accountId); 75 | } 76 | 77 | return response; 78 | } 79 | 80 | 81 | // If the item to the right of the last forward slash is "accounts", the request went to v3/accounts?Name=United 82 | // Else the request went to v3/accounts/, which is not a search, but a specific entity 83 | private static boolean doSearch(String accountId) { 84 | if(accountId == 'accounts') { 85 | return true; 86 | } 87 | return false; 88 | } 89 | 90 | //If the request came to /v3/accounts, then we want to execute a search 91 | private static void searchAccounts(RestRequest req, RestResponse res, GetResponseWrapper response) { 92 | 93 | //Use the RestRequest's params to fetch the Name parameter 94 | String searchTerm = req.params.get('Name'); 95 | 96 | if(searchTerm == null || searchTerm == '') { 97 | response.status = 'Error'; 98 | response.message = 'You must provide a Name for your search term.'; 99 | res.StatusCode = 400; 100 | } 101 | else { 102 | String searchText = '%'+searchTerm+'%'; 103 | List searchResults = [SELECT Id, Name, Phone, Website FROM Account WHERE Name LIKE : searchText]; 104 | 105 | if(searchResults != null && searchResults.size() > 0) { 106 | response.acctList = searchResults; 107 | response.status = 'Success'; 108 | response.message = searchResults.size() + ' Accounts were found that matched your search term.'; 109 | } 110 | else { 111 | response.status = 'Error'; 112 | response.message = 'No Accounts where found based on that Name, please search again.'; 113 | } 114 | } 115 | } 116 | 117 | //If the request came to v3/accounts/, then we want to find a specific account 118 | private static void findAccount(RestResponse res, GetResponseWrapper response, String accountId) { 119 | 120 | // Provided we recevied an External Id, perform the search and return the results 121 | if(accountId != null && accountId != '') { 122 | List result = [SELECT Id, Name, Phone, Website FROM Account WHERE External_Id__c =: accountId]; 123 | 124 | if(result != null && result.size() > 0) { 125 | response.acctList.add(result[0]); 126 | response.status = 'Success'; 127 | } 128 | else { 129 | response.status = 'Error'; 130 | response.message = 'This account could not be found, please try again.'; 131 | res.StatusCode = 404; 132 | } 133 | } 134 | // If the request came to /v3/accounts/ (without an Account Id), return an error 135 | else { 136 | response.status = 'Error'; 137 | response.message = 'You must specify an External Id.'; 138 | res.StatusCode = 400; 139 | } 140 | } 141 | 142 | global class RequestWrapper { 143 | Account acct; 144 | List contList; 145 | } 146 | 147 | global class PostResponseWrapper { 148 | Account acct; 149 | List contList; 150 | String status; 151 | String message; 152 | 153 | public PostResponseWrapper(){ 154 | 155 | } 156 | } 157 | 158 | global class GetResponseWrapper { 159 | public List acctList; 160 | public String status; 161 | public String message; 162 | 163 | public GetResponseWrapper(){ 164 | acctList = new List(); 165 | } 166 | } 167 | } --------------------------------------------------------------------------------