SLT Outreach APIs

Shining Light Tech RESTful APIs return data in JSON format.

/outreach/postals/list

Returns list of postal codes, with descriptive information and population data.  Login is required to use this API.

Example: https://shininglighttech.com/outreach/postals/list/?PostalCode=19030&Radius=5

  • PostalCode (optional) – PostalCode to list surrounding postal codes
  • Radius (optional) – Radius in miles to list postal codes
  • County (optional) – List postal codes in county
  • State (optional) – List postal codes in state

/outreach/visits/list

Returns list of visits.  Login is required to use this API.

Example: https://shininglighttech.com/outreach/visits/list/?Sort=Date

  • Search (optional) – string to search (name, result, reason)
  • Sort (optional) – Sort by Name, Date, Reason, Result.  Default is sort by ID
  • FilterPersonMakingVisitID (optional)
  • FilterVIPList (optional)
  • FilterVisitReasonID (optional)
  • FilterVisitResultID (optional)
  • DateCreated (optional)
  • DateVisited (optional)
  • VisitStartDate (optional) – start of date range
  • VisitEndDate (optional) – end of date range
  • VisitStatusID (optional) – status ID of person visited
  • VisitID (optional) – return only specified visit

/outreach/visits/add

Add contact (visit, call, or mail).  Login is required to use this API.

Example: https://shininglighttech.com/outreach/visits/add/?PersonID=404&ContactTypeID=1&VisitReasonID=5

  • PersonID (required) – Person to visit
  • ContactTypeID (required) – 1=Visit, 2=Call, 3=Mail
  • VisitReasonID (required) – see VisitReasons
  • AssignedTo (optional) – ID of person to whom visit will be assigned

/outreach/visits/modify

Modify contact (visit, call, or mail).  Login is required to use this API.

Example: https://shininglighttech.com/outreach/visits/modify/?VisitID=27&AssignedTo=30

  • VisitID (required) – Visit to modify
  • ContactTypeID (optional) – 1=Visit, 2=Call, 3=Mail
  • VisitReasonID (optional) – see VisitReasons
  • Notes (optional)
  • AssignedTo (optional) – ID of person to assign visit
  • DateOfVisit (optional)
  • VisitResultID (optional)
  • DaysUntilFollowup (optional) – generate followup visit after specified number of days

/outreach/visits/assign

Assign a visit.  Login is required to use this API.

Example: https://shininglighttech.com/outreach/visits/assign/?VisitID=27&AssignedTo=30

  • VisitID (required) – Visit to modify
  • AssignedTo (required) – ID of person to assign visit

/outreach/decisions/list

Returns list of decisions.  Login is required to use this API.

Example: https://shininglighttech.com/outreach/visits/list/?Sort=Date

  • Search (optional) – string to search (name, result, reason)
  • Sort (optional) – Sort by Name, Date, Type.  Default is sort by ID
  • FilterCounselorID (optional)
  • FilterVIPList (optional)
  • FilterDecisionTypeID (optional)
  • FilterGroupID (optional)
  • DateOfDecision (optional)
  • DecisionStartDate (optional) – start of date range
  • DecisionEndDate (optional) – end of date range
  • DecisionStatusID (optional) – status ID of person making decision
  • DecisionID (optional) – return only specified decision

/outreach/decisions/add

Add decision.  Login is required to use this API.

Example: https://shininglighttech.com/outreach/decisions/add/?PersonID=404&DecisionTypeID=1&Date=10/11/2015

  • PersonID (required) – Person to visit
  • DecisionTypeID (required) – 1=Salvation, 2=Baptism, 3=Church Membership, 4=Visit Church, 5=Other
  • Date (optional) – date of decision
  • Notes (optional) – comments regarding decision
  • CounselorID (optional) – person who counseled person making decision
  • GroupID (optional) – group in which decision occurred

/outreach/decisions/modify

Modify decision.  Login is required to use this API.

Example: https://shininglighttech.com/outreach/decisions/modify/?DecisionID=312&CounselorID=12

  • DecisionID (required) – Decision to modify
  • DecisionTypeID (required) – 1=Salvation, 2=Baptism, 3=Church Membership, 4=Visit Church, 5=Other
  • Date (optional) – date of decision
  • Notes (optional) – comments regarding decision
  • CounselorID (optional) – person who counseled person making decision
  • GroupID (optional) – group in which decision occurred
Share

About admin

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

Comments are closed.