RootsTech Connect Orchestration Service Rest API Documentation

A service to provide a backend services to the RootsTech Connect front end web and mobile applications.

More documentation of this microservice can be found in this Confluence page.

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
ChatAuthEndpoints
  • /chat/auth/check_password
  • /chat/auth/register
  • /chat/auth/user_exists
  • GET
  • POST
  • GET
ChatBookmarksEndpoints
  • /bookmarks
  • /bookmarks/details
  • /bookmarks/search
  • DELETE GET
  • POST
  • GET
ChatGroupsEndpoints
  • /chat/groups
  • /chat/groups/bulk
  • /chat/groups/search
  • /chat/groups/{jid}
  • /chat/groups/{jid}/children
  • GET POST
  • GET
  • GET
  • DELETE GET PUT
  • GET
ChatLoggingEndpoints
  • /chat/log/askUsAnything
  • /chat/log/error
  • /chat/log/login
  • /chat/log/metric
  • /chat/log/send
  • POST
  • POST
  • POST
  • POST
  • POST
GuestsBadgesEndpoints
  • /guests/{cisUserId}/badges
  • GET
GuestsBookmarksEndpoints
  • /guests/{cisUserId}/bookmarks
  • /guests/{cisUserId}/bookmarks/details
  • /guests/{cisUserId}/bookmarks/{jid}
  • /guests/{cisUserId}/bookmarks/{jid}/participants
  • /guests/{cisUserId}/bookmarks/{jid}/participants/details
  • GET POST
  • GET
  • DELETE
  • GET
  • GET
GuestsCompaniesEndpoints
  • /guests/companies
  • /guests/companies/{companyId}
  • GET
  • GET
GuestsEndpoints
  • /guests
  • /guests/bulk
  • /guests/search
  • /guests/searchable
  • /guests/{cisUserId}
  • GET
  • POST
  • GET
  • PUT
  • GET POST PUT
GuestsPlaylistsEndpoints
  • /guests/CURRENT/playlists
  • /guests/CURRENT/playlists/items/{cmsId}
  • DELETE GET PUT
  • DELETE PUT
GuestsRegistrationsEndpoints
  • /guests/{cisUserId}/registrations
  • DELETE GET POST PUT
GuestsSessionsEndpoint
  • /guests/CURRENT/sessions/ratings
  • /guests/CURRENT/sessions/{cmsSessionId}/ratings
  • GET
  • DELETE GET POST PUT
GuestsTagsEndpoints
  • /guests/tags/stats
  • /guests/{cisUserId}/tags
  • GET
  • DELETE GET PUT
PlatformMvcHeartbeatController
  • /healthcheck/heartbeat
  • GET HEAD
PlatformMvcVitalsHealthController
  • /healthcheck/vitals
  • GET HEAD
RegistrationsEndpoints
  • /registrations
  • GET
SessionsEndpoints
  • /sessions/ratings
  • /sessions/{cmsSessionId}/ratings
  • GET
  • GET
SpeakersAssignmentsEndpoints
  • /speakers/assignments
  • /speakers/assignments/{cmsCreatorId}
  • /speakers/{cisUserId}/assignments
  • /speakers/{cisUserId}/assignments/{cmsCreatorId}
  • GET
  • DELETE GET
  • DELETE GET
  • POST
SubscriptionsUpdatesEndpoints
  • /subscriptions/updates
  • /subscriptions/updates/{updateSubscriptionId}
  • POST
  • DELETE GET
SupportCategoriesEndpoints
  • /support/categories
  • /support/categories/search
  • /support/categories/{supportCategoryId}
  • GET POST
  • GET
  • DELETE GET PUT
Support categories are for the Ask Us Anything feature. Required steps in the workflow:
  1. Support Categories are pre-loaded into the system. POST SupportCategoriesEndpoints
  2. Support Experts volunteer in specific support categories and languages. POST SupportExpertsEndpoints
  3. Volunteers are trained. PUT SupportExpertsEndpoints
  4. Experts mark themselves as available (4 hour timeout). PUT SupportExpertsEndpoints
  5. Guests search for a support category. GET SupportCategoriesEndpoints
  6. List of support experts are shown. GET SupportExpertsEndpoints
  7. Guest selects an expert and a direct message is created.
SupportExpertsEndpoints
  • /support/experts
  • /support/experts/categories
  • /support/experts/search
  • /support/experts/{cisUserId}
  • /support/experts/search/languages
  • /support/experts/{cisUserId}/available
  • /support/experts/{cisUserId}/trained
  • GET
  • GET
  • GET
  • DELETE GET POST PUT
  • GET
  • DELETE PUT
  • DELETE PUT
UsersEndpoints
  • /users/CURRENT
  • /users/CURRENT/authorizations
  • GET
  • GET

Data Types

JSON

type description
ChatBookmarkDetailsDto
ChatBookmarkDto
ChatBookmarkParametersDto
ChatBookmarkParticipantsCountDto
ChatBookmarkSearchResultDto
ChatBookmarkSearchResultsDto
ChatBookmarksDetailsDto
ChatBookmarksDto
ChatGroupDto
ChatGroupParametersDto
ChatGroupSearchResultDto
ChatGroupSearchResultsDto
ChatGroupType
ChatGroupsDto
CompaniesWithGuestsDto
CrsResponseStatus
CrsStatus
GuestBadgeDto
GuestBulkEditError
GuestBulkEditResultDto
GuestCountryInfoDto
GuestDto
GuestPlaylistDto
GuestRegistrationDto
GuestRegistrationStatsDto
GuestSearchResultDto
GuestSearchResultsDto
GuestSessionRatingDto
GuestSessionRatingsDto
GuestSettingsDto
GuestTagDto
GuestTagReportDto
GuestTagStatistics
GuestTagsDto
GuestsDto
IdQueryParametersDto
LinkDto
PlaylistItemDto
PortraitLinksDto
RatingDto
RegisteredGuestDto
RtcAuthorizationDto
RtcUserDto
SessionRatingDto
SessionRatingsDto
SpeakerAssignmentDto
SpeakerAssignmentsDto
SupportCategoriesDto
SupportCategoryDto
SupportCategoryParametersDto
SupportCategorySearchResultDto
SupportCategorySearchResultsDto
SupportExpertCategoriesDto
SupportExpertCategoryStatsDto
SupportExpertDetailsDto
SupportExpertDto
SupportExpertParametersDto
SupportExpertSearchResultDto
SupportExpertSearchResultsDto
SupportExpertsDto
UpdateSubscriptionDto
UpdateSubscriptionParametersDto
Visibility

XML

Default Namespace (schema)
type description
chatBookmarkParametersDto
chatGroupDto
chatGroupParametersDto
chatGroupType
chatGroupsDto
guestCountryInfoDto
guestRegistrationDto
guestRegistrationStatsDto
guestSettingsDto
idQueryParametersDto
supportCategoryParametersDto
supportExpertParametersDto
updateSubscriptionParametersDto
visibility
guestPlaylistDto
playlistItemDto