SLT Directory APIs

Shining Light Tech RESTful APIs return data in JSON format.

/directory/list

Returns list of people, or details for one person.  Login is required to use this API.

Example: https://shininglighttech.com/directory/list/?MentorID=3&Sort=People.PostalCode

  • IncludeAddress (optional) – set to 1 to return address for each person, if not provided, default value is 0 (do not include address)
  • MentorID (optional) – list only the people who are mentored by the specified person
  • MenteeID (optional) – list only the people who are mentoring the specified person
  • Quantity (optional) – specify number of records to return, if not provided, default value is 100
  • StartRecord (optional) – specify starting record number to return, if not provided, default is 1.  Note that if Tag is provided, StartRecord and EndRecord are ignored.
  • EndRecord (optional) – specify ending record number to return, if not provided, default is StartRecord + Quantity. Note that if Tag is provided, StartRecord and EndRecord are ignored.
  • PersonID (optional) – if provided, returns all available data for person
  • Sort (optional) – if provided, sorts results by indicated field; must provide as Table.Field (e.g. People.PostalCode)
  • Search (optional) – if provided, searches text fields (first name, last name, street address, city, state, postal code, email, phone, employer) for provided text string (e.g. Search=Jones)
  • Tag (optional) – if provided, searches for directory entries with tag matches provided text string (e.g. Tag=singer)

/directory/add

Add directory entry.  Login is required to use this API.

Example: https://shininglighttech.com/directory/add/?FirstName=Robert&LastName=Henderson

  • FirstName (mandatory) – first name of person to add
  • LastName (mandatory) – last name of person to add
  • StreetAddress (optional)
  • City (optional)
  • State (optional)
  • PostalCode (optional)
  • Apartment (optional)
  • HomePhone (optional)
  • BusinessPhone (optional)
  • AlternatePhone (optional)
  • Email (optional)

/directory/modify

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

Example: https://shininglighttech.com/directory/modify/?PersonID=444&StreetAddress=123 Elm Street

  • PersonID (mandatory) – ID of person to modify
  • FirstName (optional)
  • LastName (optional)
  • Suffix (optional)
  • StreetAddress (optional)
  • City (optional)
  • State (optional)
  • PostalCode (optional)
  • Apartment (optional)
  • Section (optional)
  • Occupation (optional)
  • Employer (optional)
  • Title (optional)
  • MailingTitle (optional)
  • MailingSalutation (optional)
  • Employer (optional)
  • Gender (optional)
  • Latitude (optional)
  • Longitude (optional)
  • HomePhone (optional)
  • BusinessPhone (optional)
  • AlternatePhone (optional)
  • Email (optional)
  • SecondaryEmail (optional)
  • Fax (optional)
  • CurrentChurch (optional)
  • FormerChurch (optional)
  • OtherInfo (optional)
  • AdminComment (optional)
  • PictureURL (optional)
  • Password (optional)
  • EnvelopeNumber (optional)
  • DateOfBirth (optional)
  • DateJoined (optional)
  • DateSaved (optional)
  • DateAdded (optional)
  • DateOfAnniversary (optional)
  • DateBaptized (optional)
  • boolIsMarried (optional)
  • boolPublishListing (optional)
  • boolOrganization (optional)
  • ContactSourceID (optional)
  • MethodJoinedID (optional)
  • StatusID (optional)
  • RightsLevelID (optional)
  • AffiliationID (optional)
  • MobileCarrierID (optional)

/directory/remove

Remove person from directory.  Login is required to use this API.  User must have platinum rights level to use this API.

Example: https://shininglighttech.com/directory/remove/?PersonID=444

  • PersonID (mandatory) – ID of person to remove

/directory/disciples/list

List disciples.  Login is required to use this API.

Example: https://shininglighttech.com/directory/disciples/list/?MentorID=3

  • MentorID (optional) – only list disciples with this person as mentor

/directory/disciples/add

Add disciple (mentor/mentee) relationship.  Login is required to use this API.

Example: https://shininglighttech.com/directory/disciples/add/?MentorID=3&MenteeID=340

  • MentorID (required) – specify ID of person to add as mentor
  • MenteeID (required) – specify ID of person to add as mentee
  • ReturnPage (optional) – return page to which redirect will occur after mentor/mentee relationship is added

/directory/disciples/remove

Remove disciple (mentor/mentee) relationship.  Login is required to use this API.

Example: https://shininglighttech.com/directory/disciples/remove/?MentorID=3&MenteeID=340

  • MentorID (required) – specify ID of person to remove as mentor
  • MenteeID (required) – specify ID of person to remove as mentee
  • ReturnPage (optional) – return page to which redirect will occur after mentor/mentee relationship is removed

/directory/comments/list

List comments attached to directory profile(s).  Login is required to use this API.

Example: https://shininglighttech.com/directory/comments/list/?PersonID=3

  • PersonID (optional) – Specify ID of person for which to list comments.  Default is to list comments for all directory profiles.

/directory/comments/add

Add comment to directory profile.  Login is required to use this API.

Example: https://shininglighttech.com/directory/comments/add/?PersonID=3&Comment=coaches soccer

  • PersonID (required) – specify ID of person for which to add comment
  • Comment (required) – comment to attach to person’s directory profile
  • ReturnPage (optional) – return page to which redirect will occur after comment is added

/directory/comments/remove

Remove comment from directory profile.  Login is required to use this API.

Example: https://shininglighttech.com/directory/comments/remove/?CommentID=527

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

/directory/tags/list

List all available tags or just tags attached to a particular person.  Login is required to use this API.

Example: https://shininglighttech.com/directory/tags/list/?PersonID=3

  • PersonID (optional) – Specify ID of person for which to list tags.  Default is to list all available tags.

/directory/tags/add

Add tag to available set.  Login is required to use this API.

Example: https://shininglighttech.com/directory/comments/add/?Tag=singer

  • Tag (required) – tag to attach to person’s directory profile
  • ReturnPage (optional) – return page to which redirect will occur after tag is added

/directory/tags/remove

Remove tag from available set.  Login is required to use this API.

Example: https://shininglighttech.com/directory/tags/remove/?TagID=5

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

/directory/tags/attach

Attach tag to directory profile.  Login is required to use this API.

Example: https://shininglighttech.com/directory/comments/add/?TagID=2&PersonID=3

  • TagID (required) – Tag to attach to person’s directory profile
  • PersonID (required) – Attach tag to indicated person
  • ReturnPage (optional) – return page to which redirect will occur after tag is added

/directory/tags/detach

Detach tag from directory profile.  Login is required to use this API.

Example: https://shininglighttech.com/directory/tags/detach/?TagID=5

  • TagID (required) – specify ID of tag to detach from directory profile
  • ReturnPage (optional) – return page to which redirect will occur after tag is removed
Share

About admin

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

Comments are closed.