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

• S3Resource
• S3ResourceFilter

• Extensible Resource Controller (out of date)

RESTful API

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

Standard Methods

• S3CRUD
• S3Report Pivot Table Reports

Frameworks

Data Model Extensions and Helpers

• Data Model Extensions
• Components and Link-tables
• S3ReusableField

Search and Filters

• S3 FilterForms
• S3Search (to be deprecated)

Forms and Views

• Custom Forms for S3CRUD
• Data Views
  • S3DataTable - represents the records as table
  • S3DataList - represents the records as list (=nested DIVs)
  • S3PivotTable - represents the records in a pivot table

Location Tracking

• S3Tracking Generic Location Tracking System

Import and Export

• Importing Data from the web2py CLI

Form Widgets

• S3GroupedOptionsWidget

XML and JSON

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

GIS/Mapping

Overview

• DeveloperGuidelines GIS

Related BluePrints

• Record Merger
• Search Methods

---

DeveloperGuidelines