Lawi API

Lawi API for Developers

Introduction

The Lawi Project is a service and platform to remember, organize, share and explore legal information from the Lawi Project (including the Encyclopedia of Law) in the web or your mobile phone, we apply social bookmarking to places in real life.

The Lawi Project Application Programming Interface (API) has been created to allow users and partners to interact programatically with the Lawi Project. The Lawi Project API returns data in Formats that you can easily integrate into your application or web site. After a user authorized your application or web site you get full write access to all data, including the capability to create new Placemarks. As a developer you can program a large variety of applications on top of the Tagcrumbs API. There are no thematic limitations, be creative and start developing for your favorite device or platform by using your favorite programming language.

The Lawi Project API is subject to acceptance of our API License Agreement. For noncommercial use it is free of charge, otherwise please contact us at team@tagcrumbs.com and provide further details about your plans.

Lawi Project API Summary

The Lawi Project API is designed in a RESTful fashion and is easy to use. It relies on OAuth for access authorization and for the authentication of your application. All Resources support the XML and JSON Formats and for some Resources there are RSS, KML and RDF Representations available. Some Open Source Libraries are available and make it even easier to develop on top of the Tagcrumbs platform.

Almost all of Lawi Project’ functionality can be used by your application. Some of the most important features are:

• Creating a new Legal Information Item anywhere in the world. Suggestions help the User to quickly submit content.
• Add Legal Information Item of another User to your own collection by adding it as a Favorite.
• Filter and search Legal Information Item and Favorites by manifold filter criteria (e.g. coordinates and distance, tags, time, city, country).
• Get detailed information about a Legal Information Item and add Comments.
• Add other Users as a friend to follow their Lawi Project’ activities.
• Recommend a Legal Information Item to your colleagues or friends.
• Watch what is happening on a Legal Information Item with a Subscription.
• Create new User accounts directly within your application.

Table of Contents

The documentation was written to be read from top to bottom. Of course you can skip the description of individual Resources you are not interested in, but the top parts build upon each other and provide a good understanding of the API essentials.

• API License Agreement: The rules to program your application
• Architecture: Explains the general architecture of the API and how the RESTful web service is modeled
• Authentication: How to authenticate your application and how to access Resources on behalf of a User
• Error Handling and Error Codes: HTTP Response Codes and error messages
• Formats: Description of the various formats (XML, JSON, RSS, KML, RDF)
• Resources: A reference for all the available Resources
• Finding Resources: How to find the Lawi Project news, Users, …
• Endpoints: List of exposed Endpoints
• Libraries: Open Source Lawi Project libraries
• API Changelog: How did the Lawi Project API change over time
• FAQ: Frequently asked questions
• Support: What to do when you encounter problems

Getting Help

We tried our best to make the usage of our API as simple as possible. But if the Lawi Project API doesn’t behave like you think it should, if documentation is missing or incorrect or if you have any questions, comments or suggestions, please get in contact with us, and take a look at the Support page.