[[TOC]]
= S3 RESTful API =

The S3 framework provides a generic RESTful API for many of the Eden data resources.

  * [wiki:S3XRC]

== URL Syntax ==

   * see [wiki:S3XRC/RESTfulAPI/URLFormat URL Format]

== Standard Methods ==

  - interactive create, read, update and delete (CRUD) including list views
  - non-interactive data export/import

  * see [wiki:S3XRC/RESTfulAPI/Methods RESTful Methods]

== Main Resources ==

  ||'''Application'''||'''Prefix'''||'''Resource'''||'''Resource Name'''||'''URL'''||'''Formats'''||
  ||Person Registry||pr||Persons||person||/pr/person||XML, JSON, PFIF, RSS, XLS, PDF||
  ||Person Registry||pr||Groups||group||/pr/group||XML, JSON, RSS, XLS, PDF||
  ||Map||gis||Locations||location||/gis/location||XML, JSON, GeoRSS, KML, GPX, RSS, XLS, PDF||
  ||Organization Registry||org||Organisations||organisation||/org/organisation||XML, JSON, RSS, XLS, PDF||
  ||Organization Registry||org||Offices||office||/org/office||XML, JSON, KML, GeoRSS, RSS, XLS, PDF||
  ||Organization Registry||org||Projects||project||/org_project||XML, JSON, RSS, XLS, PDF||
  ||Hospital Management System||hms||Hospitals||hospital||/hms/hospital||XML, JSON, KML, GeoRSS, RSS, XLS, PDF, HAVE||
  ||Shelter Registry||cr||Shelters||shelter||/cr/shelter||XML, JSON, KML, GeoRSS, RSS, XLS, PDF||
  ||DVI||dvi||Dead Body Recovery Requests||recreq||/dvi/recreq||XML, JSON, KML, GeoRSS, RSS, XLS, PDF||
  ||DVI||dvi||Dead Body Files||body||/dvi/body||XML, JSON, RSS, XLS, PDF||
  ||Incident Report System||irs||Incident Messages||incident||/irs/incident||XML, JSON, KML, GeoRSS, RSS, XLS, PDF||
  ||Incident Report System||irs||Incident Reports||ireport||/irs/ireport||XML, JSON, KML, GeoRSS, RSS, XLS, PDF||
  ||Incident Report System||irs||Impact Assessments||iassessment||/irs/iassessment||XML, JSON, RSS, XLS, PDF||
  ||Rapid Assessment Tool||rat||Assessments||assessment||/rat/assessment||XML, JSON, KML, GeoRSS, RSS, XLS, PDF||
  ||Request Management System||rms||Requests||req||/rms/req||XML, JSON, KML, GeoRSS, RSS, XLS, PDF||

== XML/JSON Format ==

  * see [wiki:S3XML]

== REST Controller ==

  - see [wiki:S3XRC/RESTfulAPI/s3_rest_controller s3_rest_controller()]

----

DeveloperGuidelines