ParticipantService

Manage participant records.

Symitar eDocs References: Coming soon.

Operations

getParticipant

post

Retrieves participant information.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringRequired
Responses
post
/getParticipant
200

Successful operation.

getParticipantSelectFields

post

Retrieves participant information with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantSelectFields
200

Successful operation.

getParticipantSelectFieldsFilterChildren

post

Retrieves participant information with selected fields and filters children.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantSelectFieldsFilterChildren
200

Successful operation.

getParticipantFmHistoryPagedList

post

Retrieves a paged list of participant FM history.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantFmHistoryPagedList
200

Successful operation.

getParticipantFmHistoryListSelectFields

post

Retrieves a list of participant FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantFmHistoryListSelectFields
200

Successful operation.

searchParticipantFmHistorySelectFields

post

Searches participant FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/searchParticipantFmHistorySelectFields
200

Successful operation.

getParticipantFmHistoryPagedListSelectFields

post

Retrieves a paged list of participant FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantFmHistoryPagedListSelectFields
200

Successful operation.

searchParticipantFmHistoryPagedSelectFields

post

Searches participant FM history with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
QuerystringOptional
Responses
post
/searchParticipantFmHistoryPagedSelectFields
200

Successful operation.

getParticipantNote

post

Retrieves participant notes.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
ParticipantNoteLocatorintegerOptional
Responses
post
/getParticipantNote
200

Successful operation.

getParticipantNoteSelectFields

post

Retrieves participant notes with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
ParticipantNoteLocatorintegerOptional
Responses
post
/getParticipantNoteSelectFields
200

Successful operation.

getParticipantNotePagedList

post

Retrieves a paged list of participant notes.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantNotePagedList
200

Successful operation.

getParticipantNoteListSelectFields

post

Retrieves a list of participant notes with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantNoteListSelectFields
200

Successful operation.

searchParticipantNoteSelectFields

post

Searches participant notes with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/searchParticipantNoteSelectFields
200

Successful operation.

getParticipantNotePagedListSelectFields

post

Retrieves a paged list of participant notes with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantNotePagedListSelectFields
200

Successful operation.

searchParticipantNotePagedSelectFields

post

Searches participant notes with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
QuerystringOptional
Responses
post
/searchParticipantNotePagedSelectFields
200

Successful operation.

getParticipantTransactionPagedList

post

Retrieves a paged list of participant transactions.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantTransactionPagedList
200

Successful operation.

getParticipantTransactionListSelectFields

post

Retrieves a list of participant transactions with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantTransactionListSelectFields
200

Successful operation.

searchParticipantTransactionSelectFields

post

Searches participant transactions with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/searchParticipantTransactionSelectFields
200

Successful operation.

getParticipantTransactionPagedListSelectFields

post

Retrieves a paged list of participant transactions with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
Responses
post
/getParticipantTransactionPagedListSelectFields
200

Successful operation.

searchParticipantTransactionPagedSelectFields

post

Searches participant transactions with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParticipantNumberstringOptional
QuerystringOptional
Responses
post
/searchParticipantTransactionPagedSelectFields
200

Successful operation.

Last updated

Was this helpful?