Open311

Wiki

Collaboration for an Open311 Standard
Personal tools

SF open311 API

Collaboration for an Open311 Standard

Revision as of 16:51, 23 October 2009 by JayNath (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Select Service Method name: service_list Purpose: provide a list of acceptable 311 services and associated service code URL: Formats: xml, json, rss, atom HTTP Method: GET Requires Authentication: false Arguments: none Response: list of 311 services

Select Location Purpose: Return closest address id from internal GIS system Method name: address_id URL: Formats: xml, json, rss, atom HTTP Method: GET Requires Authentication: false Arguments: • lat (WGS84) • long (WGS84) Response: • address_id • error codes Customer Information Purpose: Return customer id from internal CRM system. Will create customer record if one doesn’t exist. Method name: customer URL: Formats: xml, json, rss, atom HTTP Method: GET Requires Authentication: false Arguments: • email • first_name (optional) • last_name (optional) • phone_number (optional) Response: • customer_id • error codes

Create Request Purpose: Create services Method name: services URL: Formats: xml, json, rss, atom HTTP Method: GET Requires Authentication: true Arguments: • service_code (obtained from method service_list) • address_id (obtained from method location) • customer_id • description (free form limited to #### characters) • photo_url (location of photo(s)) Response: • service_request_id • error codes