S3 API Guide

This page links to all wiki pages describing how to make use of the S3 framework when developing Eden modules or other applications connecting to Eden via web services.

External links:

• ​S3 API Documentation (Epydocs)

• ​Sahana Eden Essential Guide (book):
  • ​Web Services
  • ​S3XML
  • ​Mapping & GIS

Authentication, Authorization, Accounting

• Authentication, Authorization, Accounting
• OrgAuth
• Record Approval

Resource Framework

Overview

• Extensible Resource Controller

RESTful API

• Implementing RESTful Controllers
• Supported Methods
• Extending the RESTful API by implementing S3Method
• URL Format
• Generating XML Forms (XForms)

Developer Resources

• Data Model Extensions
• Components and Link-tables

• S3CRUD
• S3 FilterForms
• S3Search

• Custom Forms for S3CRUD
• S3ReusableField

• S3Report Pivot Table Reports
• S3Tracking Generic Location Tracking System

• Importing Data from the web2py CLI

Form Widgets

• S3GroupedOptionsWidget

XML and JSON

• S3XML and S3JSON Formats
• Using XSLT Transformation for Data Export/Import

Backend Details

• S3Resource
• S3ResourceFilter

• S3Request

Related BluePrints

• Record Merger
• Search Methods

GIS/Mapping

Overview

• DeveloperGuidelines GIS

---

DeveloperGuidelines