SLT Groups APIs

Shining Light Tech RESTful APIs return data in JSON format.

/groups/list

Returns list of groups in array, with GroupID and GroupName for each group.  Login is required to use this API.

Example: https://shininglighttech.com/groups/list/?ExcludeCollection=Families&ListLeaders=1&PersonID=3

  • Collection (optional) – string indicating name of collection to return, if not provided, default value is null (all collections included)
  • ExcludeCollection (optional) – string indicating name of collection to exclude from results, if not provided, default value is null (no collections excluded)
  • ListLeaders (optional) – set to 1 to list leader name and email for each group, if not provided, default value is 0 (do not list leaders)
  • PersonID (optional) – list only the groups that include the specified person

/groups/details

Returns details for a particular group.  Login is required to use this API.

Example: https://shininglighttech.com/groups/details/?GroupID=3

  • GroupID (required) – ID of group for which to return details

/groups/add

Add group.  Login is required to use this API.

Example: https://shininglighttech.com/groups/add/?GroupName=Junior High Bible Study

  • GroupName (required) – group to add
  • ReturnPage (optional) – return page to which redirect will occur after group is added

/groups/modify

Modify group.  Login is required to use this API.

Example: https://shininglighttech.com/groups/collections/modify/?GroupID=48&IncludesChildren=1

  • GroupID (required) – specify ID of group to modify
  • GroupName (optional) – new name for group
  • CollectionID (optional) – change group to different collection
  • Abbreviation (optional) – abbreviation for group
  • NextGroupID (optional) – group to which members of this group will be promoted
  • ScheduleReminders (optional) – set to 1 to generate schedule reminders for group
  • IncludesChildren (optional) – set to 1 to indicate that group includes children so that child protection will be enforced for group
  • ScheduleAllMembers (optional) – all members of group can be scheduled for service
  • ServiceGroup (optional) – everyone in the group is serving (not just leaders/helpers), used for ministry utilization report
  • EmailNotification (optional) – auto, yes, or no
  • MailChimpListID – ID of Mailchimp list for broadcast email
  • ReturnPage (optional) – return page to which redirect will occur after group is modified

/groups/remove/

Remove group.  Removes attendance and roster for group as well.  Login is required to use this API.

Example: https://shininglighttech.com/groups/remove/?GroupID=48

  • GroupID (required) – specify ID of group to remove
  • ReturnPage (optional) – return page to which redirect will occur after group is removed

/groups/collections/list

List collections of groups.  Login is required to use this API.

Example: https://shininglighttech.com/groups/collections/list/

  • CollectionID (optional) – Specify ID of collection.  Default is to list all collections.

/groups/collections/add

Add collection.  Login is required to use this API.

Example: https://shininglighttech.com/groups/collections/add/?Collection=Leadership Groups

  • Collection (required) – collection to add
  • ColorCode (optional) – hexadecimal color value to use for display
  • ReturnPage (optional) – return page to which redirect will occur after collection is added

/groups/collections/modify

Modify collection.  Login is required to use this API.

Example: https://shininglighttech.com/groups/collections/modify/?CollectionID=20&Collection=Leadership Teams

  • CollectionID (required) – specify ID of collection to modify
  • Collection (required) – new name for collection
  • ColorCode (optional) – hexadecimal color value to use for display
  • ReturnPage (optional) – return page to which redirect will occur after collection is modified

/groups/collections/remove

Remove collection.  Any groups associated with this collection will be moved to the default collection “None”.  Login is required to use this API.

Example: https://shininglighttech.com/groups/collections/remove/?CollectionID=14

  • CollectionID (required) – specify ID of collection to remove
  • ReturnPage (optional) – return page to which redirect will occur after collection is removed

/groups/rosters/list

Returns list of people in a group roster.  Login is required to use this API.

Example: https://shininglighttech.com/groups/rosters/list?GroupID=16

  • GroupID (optional) – indicates group for which to list roster
  • CollectionID (optional) – indicates collection for which to list roster
  • IncludeRoleID (optional) – only list members with specified role (e.g. leaders or helpers)
  • ExcludeRoleID (optional) – exclude one role (e.g. list leaders/helpers but not members for scheduling)
  • AttendOnDate (optional) – only include if scheduled in group or collection on indicated date (for scheduling)
  • Sort (optional) – sort roster entries by Rank, default sort is by name

/groups/rosters/add

Add person to roster.  Login is required to use this API.  Prevents duplicate roster entry.  Enforces child protection if person to be added is leader or helper and group includes children.  Sends email to group leaders/helpers when member added if configured to do so.  Adds to Mailchimp mailing list if configured to do so.

Example: https://shininglighttech.com/groups/rosters/add/?GroupID=90&PersonID=3&RoleID=3&RoleDetails=substitute teacher

  • GroupID (required) – group for which to add to roster
  • PersonID (required) – person to add to roster
  • RoleID (optional) – 1 for member, 2 for leader, 3 for helper
  • RoleDetails (optional) – string representing role details
  • AddAll (optional) – set to true to add all people of a particular type from directory to roster
  • Type (optional) – used in conjunction with AddAll to add all people of a particular type from directory to roster – Members, Attenders, Prospects, Converts, Visitors, Male, Female
  • CopyGroupID (optional) – copy everyone from one group’s roster to another group’s roster
  • ReturnPage (optional) – return page to which redirect will occur after person is added to roster

/groups/rosters/modify

Modify roster entry.  Login is required to use this API.

Example: https://shininglighttech.com/groups/rosters/modify/?RosterID=217&RoleID=3&RoleDetails=makes coffee

  • RosterID (required) – roster entry to modify
  • RoleID (required) – 1 for member, 2 for leader, 3 for helper
  • RoleDetails (optional) – string representing role details
  • Rank (optional) – change Rank for this roster entry (ordering within the roster)
  • ReturnPage (optional) – return page to which redirect will occur after person is added to roster

/groups/rosters/remove

Remove person from roster.  Login is required to use this API.

Example: https://shininglighttech.com/groups/rosters/remove/?GroupID=16&PersonID=3

  • GroupID (required) – group for which to remove from roster
  • PersonID (required) – person to remove from roster
  • ReturnPage (optional) – return page to which redirect will occur after person is removed from roster

/groups/attendance/list

Returns list of attendance records.  Login is required to use this API.

Example: https://shininglighttech.com/groups/attendance/list/?GroupID=16&Date=7/13/2014

  • GroupID (optional) – group for which to add to list schedule occurrences
  • PersonID (optional) – person for which to list schedule occurrences
  • StartDate (optional) – start of date range for which to list schedule occurrences
  • EndDate (optional) – end of date range for which to list schedule occurrences
  • Date (optional) – return schedule occurrence for specified date only
  • ReturnPage (optional) – return page to which redirect will occur after attendance is added

/groups/attendance/add

Add attendance data.  Login is required to use this API.

Example: https://shininglighttech.com/groups/attendance/add/?GroupID=90&PersonID=3&Date=4/29/15

  • GroupID (required) – group for which to add to roster
  • Date (required) – date for which to add attendance data
  • PersonID (optional) – person for which to record attendance
  • Total (optional) – total value to enter for group on specified date
  • ReturnPage (optional) – return page to which redirect will occur after attendance is added

/groups/attendance/modify

Modify total count for group.  Login is required to use this API.

Example: https://shininglighttech.com/groups/attendance/modify/?GroupID=90&Total=35&Date=4/29/15

  • GroupID (required) – group for which to add to roster
  • Date (required) – date for which to add attendance data
  • Total (required) – total value to enter for group on specified date
  • ReturnPage (optional) – return page to which redirect will occur after attendance is modified

/groups/attendance/remove

Remove attendance data.  Login is required to use this API.

Example: https://shininglighttech.com/groups/attendance/remove/?AttendanceID=3

  • AttendanceID (required) – group for which to remove from roster
  • PersonID (optional) – person for which to remove attendance data.  Must be provided if GroupID is provided.
  • GroupID (optional) – group for which to remove attendance data.  Must be provided if PersonID is provided.
  • ReturnPage (optional) – return page to which redirect will occur after person is removed from roster

/groups/schedule/list

Lists people scheduled to serve in a group on future dates.  Login is required to use this API.

Example: https://shininglighttech.com/groups/schedule/list/?GroupID=90&PersonID=3

  • GroupID (optional) – group for which to add to list schedule occurrences
  • PersonID (optional) – person for which to list schedule occurrences
  • StartDate (optional) – start of date range for which to list schedule occurrences
  • EndDate (optional) – end of date range for which to list schedule occurrences
  • Date (optional) – return schedule occurrence for specified date only
  • ReturnPage (optional) – return page to which redirect will occur after attendance is added

/groups/schedule/add

Adds person to group schedule.  Login is required to use this API.

Example: https://shininglighttech.com/groups/schedule/add/?GroupID=90&PersonID=3&Date=4/29/15&Repeat=4

  • GroupID (required) – group for which to add to roster
  • PersonID (required) – person to add to roster
  • Date (required) – date for which to add attendance data
  • Repeat (optional) – repeat every 1, 2, 4, 6, or 8 weeks for the next 6 months
  • ReturnPage (optional) – return page to which redirect will occur after attendance is added

/groups/schedule/remove

Removes person from group schedule.  Login is required to use this API.

Example: https://shininglighttech.com/groups/schedule/remove/?AttendanceID=527

  • AttendanceID (optional) – specific schedule item (attendance record) to remove
    If AttendanceID is not provided, GroupID and PersonID must be provided
  • PersonID (optional) – person for which to remove schedule
  • Date (optional) – date for which to remove schedule
  • GroupID (optional) – group for which to remove schedule
  • ReturnPage (optional) – return page to which redirect will occur after attendance is added

/groups/message

Send broadcast email or text message to group.  Login is required to use this API.

Example: https://shininglighttech.com/groups/message/?GroupID=16&MessageType=2&Subject=Test&Message=This%20is%20a%20test

  • GroupID or CollectionID (required) – group or collection to which message will be sent
  • Subject (required) – subject of message
  • Message (required) – contents of message
  • MessageType (optional) – specify 1 for email or 2 for text message, default is 1 (email) if not provided
Share

About admin

President of Shining Light Technologies.
This entry was posted in Groups. Bookmark the permalink.

Comments are closed.