{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This guide walks a ","type":"text"},{"text":"module","type":"text","marks":[{"type":"em"}]},{"text":" developer through adding a new set of web service methods for a core object. There is a separate guide for ","type":"text"},{"text":"core developers","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/docs/pages/25462915"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Conventions","type":"text"}]},{"type":"paragraph","content":[{"text":"The first thing to do is to read through the conventions section on the ","type":"text"},{"text":"REST Web Services API For Clients","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/docs/pages/25469830"}}]},{"text":" page. Your module should follow similar conventions.","type":"text"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Note:","type":"text","marks":[{"type":"strong"}]},{"text":" When creating a REST resource and sub-resource URI and name respectively, the absolute and relative path names should be written in all-lowercase ASCII letters. Avoid capital letters, camel caps to mention a few. The norm is to use lower case letters.","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/ws/rest/","type":"text"},{"text":"*","type":"text","marks":[{"type":"strong"}]},{"text":"*","type":"text","marks":[{"type":"strong"}]},{"text":"/conceptclass","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/ws/rest/**/yourmoduleid/yourresourcename","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Getting the REST Web Services Jar into your project","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"Requiring another module in your module","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25466689"}}]}]},{"type":"paragraph","content":[{"text":"You will need to check out the webservices.rest project and mvn clean install it to make it available to your module project. You will also need to add a few dependencies in your module's pom.xml files:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"main pom.xml file additions","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"\n\norg.openmrs.module\nwebservices.rest-api\n1.0\nprovided\n\n\n\norg.openmrs.module\nwebservices.rest-omod\n1.0\nprovided\n\n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"omod project pom.xml file additions","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"\n\n org.openmrs.module\n webservices.rest-api\n\n\n\n org.openmrs.module\n webservices.rest-omod\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that some of the controller dependencies (e.g. BaseCrudController) are now part of package org.openmrs.module.webservices.rest.web.v1_0.controller.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Adding new Web Service URLs","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Our best-practices may change over the course of the sprint as we learn new things, but see the ","type":"text"},{"text":"reportingrest module","type":"text","marks":[{"type":"link","attrs":{"href":"http://source.openmrs.org/browse/Modules/reportingrest"}}]},{"text":" for an example module exposing web services.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The documentation on how to create methods is the same as ","type":"text"},{"text":"for the core developers","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/docs/pages/25462915"}}]},{"text":". See that page for more information.","type":"text"}]},{"type":"paragraph","content":[{"text":"The only difference is that on your controller you will use","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n@RequestMapping(value = \"/rest/yourmoduleid/yourobjectid\")\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text"}]},{"type":"paragraph","content":[{"text":"The idgenws module was built as an example maven module that uses the restws code. It is a rudimentary example and does not use a lot of the helper parent classes. See ","type":"text"},{"text":"http://svn.openmrs.org/openmrs-modules/idgenws/trunk","type":"text","marks":[{"type":"link","attrs":{"href":"http://svn.openmrs.org/openmrs-modules/idgenws/trunk"}}]}]},{"type":"paragraph","content":[{"text":"The reportingrest module was also built as a PoC. It is based on ant/build.xml and so the library setup, etc is slightly different than the maven example on this page. See the code for that here: ","type":"text"},{"text":"http://svn.openmrs.org/openmrs-modules/reportingrest","type":"text","marks":[{"type":"link","attrs":{"href":"http://svn.openmrs.org/openmrs-modules/reportingrest"}}]}]}],"version":1}