clsTrainingCourseHandshakeResult Properties |
The clsTrainingCourseHandshakeResult type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CompanyID |
Based on the training course, the course is linked to a company (SBO database). This number can be used to individualize the landing page look and feel.
|
| DemoNewsletterToken | This is used only for demo and test databases. On live databases (by license key), this property is always empty. It will have the newsletter token used for the email regonizing process. This token is normally used in the email send out to the entered email. There the user will click on the hyperlink with the token. To simulate the hyperlink this property will show this token. The demo token is already URL encoded. |
| ErrorCode | 0=no error |
| ErrorText |
Error text from the internal routine
|
| LanguageCode |
Language code de-DE, en-US to modify the landing page. Only set, when the input via TOKEN gives an indication about a user and the default language.
|
| ListOfParticipants |
list of Participants registered by the applicant. clsTrainingcoursHandshakeRequestParticipant |
| NewsletterTopics | List of selected or selectable newsletter topics. Ordered by the local order in the settings. See clsNewsletterTopic for details. |
| ParticipantAddress | Output: Postal Address of the participant (main billing address of the company) |
| ParticipantBusinessPartnerEmail | Output: Linked Business Partner OCRD.Emaill |
| ParticipantBusinessPartnerName | Output: Linked Business Partner. OCRD.CardName |
| ParticipantCellular | Output: Mobile Number. Recipient/Participant. Cellular MPTrainingParticipant.Cellular / OCPR.Cellolar / MPPersonenstamm.Mobiltelefon |
| ParticipantCode | Output: Internal Code of the participant. ParticipantNumber MPTrainingParticipant.ParticipantNumber |
| ParticipantEMail | Output: participants email |
| ParticipantFax | Output: Recipient/Participant. Telefax MPTrainingParticipant.Notes2 / OCPR.Fax / MPPersonenstamm.Telefax |
| ParticipantFirstName | Output: Recipient/Participant first name. FirstName MPTrainingParticipant.FirstName / OCPR.FirstName / MPPersonenstamm.Vorname |
| ParticipantLastName | Output: Last Name. LastName MPTrainingParticipant.LastName / OCPR.LastName / MPPersonenstamm.Nachname |
| ParticipantMiddleName | Output: Recipient/Participant middle name. MiddleName MPTrainingParticipant.MiddleName / OCPR.MiddleName / MPPersonenstamm.Vorname2 |
| ParticipantName | Output: Name of the participant. Matchcode. MPTrainingParticipant.Matchcode / OCPR.Name / MPPersonenstamm.Matchcode |
| ParticipantPhone | Output: Recipient/Participant. Phone MPTrainingParticipant.Phone / OCPR.Tel1 / MPPersonenstamm.Telefon |
| ParticipantPhone2 | Output: Recipient/Participant. Notes1 MPTrainingParticipant.Notes1 / OCPR.Tel2 / MPPersonenstamm.TelefonPrivat |
| ParticipantPosition | Output: Recipient/Participant. Position MPTrainingParticipant.Position / OCPR.Position / MPPersonenstamm.Position |
| ParticipantProfession | Output: Recipient/Participant. Profession MPTrainingParticipant.Profession / OCPR.Profession / MPPersonenstamm.Beruf |
| ParticipantSalutation | Output: specific salutation or generic one.Salutation2 MPTrainingParticipant.Salutation2 / OCPR.[Field defined in company settings] / MPPersonenstamm.Ansprache |
| ParticipantTitle | Output: Recipient/Participant Title. A0Salutation MPTrainingParticipant.A0Anrede / OCPR.Title / MPPersonenstamm.Anrede |
| ParticipantType | Output: 1=ContactPerson, 33=Employee, 438=FreeParticipant. ParticipantType MPTrainingParticipant.ParticipantType |
| RegistrationArrivalComment | Input/Output: free text as additional information (100 Chars). Notes MPTrainingRegistration.Notes |
| RegistrationArrivalInformation | Input/Output: free text as additional information (100 Chars). ArrivalInformation. MPTrainingRegistration.ArrivalInformation |
| RegistrationArrivalTime | Input/Output: When will the participant arrive. Can be only time or date and time. ArrivalDate MPTrainingRegistration.ArrivalDate |
| RegistrationDate | Output: Date of the last registration update. RegistrationDate |
| RegistrationID | Output: internal registration ID. RegistrationID MPTrainingRegistration.RegistrationID |
| RegistrationSelectedBillingPositions |
List of selected billing positions (Quantity is the indicator) (only for TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfBillingPosition or TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfOptionsAndBillingPositions Contains a list of billing options. See clsTrainingCourseHandshakeBillingOptions for details. |
| RegistrationSelectedOptions |
List of selected options in the regsitration (only for TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfOptions or TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfOptionsAndBillingPositions)
Contains the clsKeyPair.sKeyInternal = Internal Option ID and the clsKeyPair.sMatchcode=Option Name |
| RegistrationStatus | Output: Status of the current registration, if already any. RegistrationStatus |
| RequestBusinessPartnerCode | Output: Linked Business Partner. OCRD.CardCode |
| TrainingCourseDocNum |
WorkItemDocNum INT (4) Visible ID based on Number Series. Will be created automatically by defined number series (not unique over all WorkItemTypes)
|
| TrainingCourseEndDateTime | Datetime (8) End of Task with hh:mm |
| TrainingCourseID |
Internal TaskID INT (4) Unique ID (via MPTAN). Not visible to the users.
|
| TrainingCourseMaxParticipants |
Definition of the maximum participant (may be shown in the registration screen)
|
| TrainingCourseMinParticipants |
Definition of the minimum participant (may be shown in the registration screen)
|
| TrainingCourseName |
NVARCHAR (50) Name of the trainings course
|
| TrainingCourseNumberOfParticipantsPerStatus |
Each registration status with the number of participants who have this status.
|
| TrainingCourseNumberRegistrations |
Number of already registered participants. may be used to show "Full"
Deprecated use TrainingCourseNumberOfParticipantsPerStatus instead.
|
| TrainingCourseOptionsBillingPosSelectionMode |
Setting in the training course to enable a selection of options and or selection of billing positions. (Use from version 5.6)
|
| TrainingCourseRegistrationProcess |
BackofficeRegistration = 1
ByInvitation = 2
ByUserSelfRegistration = 3
ByPublicViaUserCreation = 4
FreeRegistration = 5
|
| TrainingCourseSelectableBillingPositions |
List of selectable billing positions (booking options) (only for TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfBillingPosition or TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfOptionsAndBillingPositions Contains a list of billing options. See clsTrainingCourseHandshakeBillingOptions for details. |
| TrainingCourseSelectableOptions |
List of selectable options (only for TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfOptions or TrainingCourseOptionsBillingPosSelectionMode=eOptionsBillingPosSelectionMode.SelectionOfOptionsAndBillingPositions)
Contains the clsKeyPair.sKeyInternal = Internal Phase ID and the clsKeyPair.sMatchcode=Phase Name |
| TrainingCourseStartDateTime | Datetime (8) Start of task with hh:mm |
| TrainingCourseStatus |
Status ID. Running Events does have =
Request = 1
Active = 2
FinishedReadyToInvoice = 3
Finalized = 4
|
| TrainingCourseVisibilityMode |
Will this event be visible for public users
InternalUse = 1
UserByAuthorization = 2
UserByProperties = 3
PublicEvent = 4
|
See Also