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

RESTful API

API

• Supported Methods
• URL Format

• Generating XML Forms (XForms)

Framework

• Implementing RESTful Controllers (s3_rest_controller)
• Extending the RESTful API by implementing S3Method

Core Classes

• S3Request
• S3Resource
• S3ResourceFilter

Database

Models

• Data Model Extensions
  • Components and Link-tables
  • Super-Entities

• S3ReusableField

Export/Import

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

• Importing Data from the web2py CLI

Subscriptions and Notifications

• S3 Notifications

GUI

Menus and Navigation

• S3Navigation

CRUD Forms and Views

• Custom Forms for S3CRUD

• Data Views - Representation of multiple records
  • S3DataTable
  • S3DataList
  • S3PivotTable

Filter Forms

• S3 FilterForms

Reports

• S3Report Pivot Table Reports

Form Widgets

• S3GroupedOptionsWidget

GIS/Mapping

Overview

• DeveloperGuidelines GIS

Location Tracking

• S3Tracking Generic Location Tracking System

Related BluePrints

• Record Merger
• Search Methods

---

DeveloperGuidelines