SUSCOPTS PORTAL ICON LOGO SUSCOPTS API DOCUMENTATION

INDEX

General
Diocese Churches, States, and Clergy
Church Schedule
Church Schedule
Logins
Get Token
Groups
Groups: email lists, groups, and newsletter
Congregation
Congregation: User information, and Church List
Sunday School
Sunday School by order, and Sunday School by Church and class
* Get Basic Authorization information from your Clergy.
* Starter templates for mobile frameworks are available at https://github.com/suscoptsportal/.
-

General

https://api.suscopts.org/general/

  • Security: None
  • Description: Churches, States, and Mix (churches by the state)

https://api.suscopts.org/general/states/

  • Security: None
  • Description: All States

https://api.suscopts.org/general/state/[id]/

  • Security: None
  • Description: Replace [id] by state id get all that state churches, and state information.

https://api.suscopts.org/general/churches/

  • Security: None
  • Description: List all Churches

https://api.suscopts.org/general/church/[id]/

  • Security: None
  • Description: Replace [id] with the church's id and get Church information with Clergy List.

Church Schedule

https://api.suscopts.org/schedule/[church id]/

  • Security: None
  • Description: Generated JSON object of the church schedule
IFRAME EXAMPLE or You can pull html to your website. https://api.suscopts.org/schedule?id=[Church ID]

Logins

https://api.suscopts.org/login/

  • Security: Basic authorization
  • Description: Get Token, with Full Name. Must POST (Content-Type: application/json) with email and password. Token expire in one hour.

https://api.suscopts.org/login/[all | main]/[churches_id]/

  • Security: Basic authorization
  • Description: Get Token with in church's scope. Replace [ all | main ] with all to get all possible students or main to get just main students. Replace [churches_id] with church's id. Must POST (Content-Type: application/json) with email and password. Token expire in one hour.

https://api.suscopts.org/login/group/[group_id]/

  • Security: Basic authorization
  • Description: Get Token with groups scope. Replace [group_id] with groups id. Must POST (Content-Type: application/json) with email and password. Token expire in one hour.

Groups

https://api.suscopts.org/groups/

  • Security: Token retrieved from login must be send as bearer authorization.
  • Description: Get current Groups. In the data the attribute level `church` `is tied to a church group and can be deleted. Level `diocese` is managed by the diocese and can't be deleted.

https://api.suscopts.org/groups/[church_id]/

  • Security: Token retrieved from login must be send as bearer authorization.
  • Description: Replace [church_id] by the church's id. Get back all the groups for the that church.

https://api.suscopts.org/groups/user/[add|delete]/[group_id]/

  • Security: Token retrieved from login must be send as bearer authorization.
  • Description: Add or Delete token user from group. Replace [group_id] with a group id and replace [add|delete] with desired action.

https://api.suscopts.org/groups/church/[church_id]/congregationIds/

  • Security: Token retrieved from login must be send as bearer authorization. Requires Clergy Level token.
  • Description: Fetches an array of congregation's id subscribed to the groups.

Congregation

https://api.suscopts.org/congregation/

  • Security: Token retrieved from login must be send as bearer authorization.
  • Description: Gets general information.

https://api.suscopts.org/congregation/basic/email_check/

  • Security: Basic authorization.
  • Description: POST (Content-Type: application/json) with a email param.

https://api.suscopts.org/congregation/list/report/

  • Security: Bearer authorization.
  • Description: Requires a high status token. POST (Content-Type: application/json) an object with key as "list" and value should be number array of congregation ID's. This will return list congregation of corresponding. Useful for reports.

https://api.suscopts.org/congregation/update/extras/[all|remove|get]/

  • Security: Bearer authorization.
  • Description: Requires a high status token. POST (Content-Type: application/json) send with a JSON object that contains a 20 character `key` that describe value adding and `value` to represents value attributes

Sunday School

https://api.suscopts.org/schools/

  • Security: None
  • Description: Get Sunday school grades with order number (Order Number is the order of grades), and id.

https://api.suscopts.org/schools/[all | main]/[order]/[church_id]/

  • Security: Token retrieved from login must be send as bearer authorization and token owner must have special permission.
  • Description: * Token users needs to be Sunday School Teacher Groups. Replace [ all | main ] with all to get all possible students or main to get just main students. Replace [order] with order number and [church_id] with church id.

SMS Blocklist

https://api.suscopts.org/sms/blocklist/[add|remove]/?account={phone sid}&phone={phone}

  • Security: Basic Authorization
  • Description: Add or remove a phone number from SMS Block list. You need to give a valid phone sid number as an account param and the phone number to add to the blocklist should be a phone params