|
Siebel Events Management Guide > Registration Business Service Methods > Descriptions of Business Services Methods >
EventRegistrationService Business Service Methods
This topic describes the EventRegistrationService business services methods. EnrollAdmin Method
This method is used to register one or more individuals. Input Property set is a nested property set where each row is an input contact or prospect. This method is invoked from RegisterAll button, where all dummy records in the current context are registered. See Table 12 for a description of EnrollAdmin Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 12. EnrollAdmin Method Properties
|
|
EventId* |
Input Property - Row Id of the Event. |
Prospect ID |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Type ('EVENT') |
Input Property - Always set to "EVENT" |
List Id |
Input Property - List Id that contains the contact, if applicable. |
List Owner Id |
Input Property - The list creator Id that contains the contact, if applicable. |
Dummy Id (Dummy regn Id) |
Input Property - Dummy registration record Id. |
Contact Id |
Input Property - The row Id of the contact being registered. |
User Type* |
Input Property - type of individual being registered. "Contact" or "Prospect." |
Return Val* |
Output Property - "Success" or "Failure." |
Output Type* |
Output Property - Further information on the result. |
Shopping Flag |
Output Property - Determines whether the Shopping Cart process is required. "YES" or Null. |
Error Regn |
Output Property - Cumulative error message with additional information. |
EnrollUser Method
This method is used to register a single contact or prospect. See Table 13 for a description of EnrollUser Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 13. EnrollUser Method Properties
|
|
Event Id* |
Input Property - Row Id of the Event. |
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Type ('EVENT') |
Input Property - Always set to "EVENT." |
List Id |
Input Property - List Id that contains the contact, if applicable. |
List Owner Id |
Input Property - List creator Id that contains the contact, if applicable. |
Registration Date |
Input Property - Date of registration. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Reg Id (Registration Id) |
Output Property - Attendee Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
Shopping Flag (YES or "") |
Output Property - Determines whether the event is fee based and needs to go through the Shopping Cart process. "YES" or Null. |
CheckPreviousRegn Method
This method determines if a previous registration or attendee record exists. See Table 14 for a description of CheckPreviousRegn Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 14. CheckPreviousRegn Method Properties
|
|
Event Id* |
Input Property - Row Id of the Event. |
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
Reg Id (Old regn if it exists) |
Output Property - Attendee Id. |
Regn Status (Status of the old regn) |
Output Property - Status of previous attendee record. |
CheckSpace Method
This method checks if there is capacity for registration. See Table 15 for a description of CheckSpace Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 15. CheckSpace Method Properties
|
|
Event Id* |
Input Property - Row Id of the Event. |
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
CleanSpace Method
This method removes any old pending registration or attendee records that do not belong to the current user, to free up capacity. The Business Component User Property "Reservation Time Out Hour" determines how long these records exist before being deleted. See Table 16 for a description of CleanSpace Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 16. CleanSpace Method Properties
|
|
Event Id* |
Input Property - Row Id of the Event. |
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure" |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
CreateRegistration Method
This method calls the UpdateSpace method to create a registration and seat counts. Then calls CheckQuote to determine if a quote needs to be created. See Table 17 for a description of CreateRegistration Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 17. CreateRegistration Method Properties
|
|
Event Id* |
Input Property - Row Id of the Event. |
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
List Id |
|
ListOwnerId |
|
DummyId |
Input Property - Dummy registration record Id. |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
Quote Item Id |
Output Property - Quote Item Row Id. |
Reg Id |
Output Property - Attendee Id. |
Shopping Flag ("Y" or "") |
Output Property - Determines whether the Shopping Cart process is required. "YES" or Null. |
UpdateRegistration Method
This method is called when a pending registration or attendee already exists. Completes the registration by calling other methods as necessary. See Table 18 for a description of UpdateRegistration Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 18. UpdateRegistration Method Properties
|
|
Event Id* |
Input Property - Row Id of the Event. |
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
List Id |
Input Property - List Id that contains the contact, if applicable. |
List Owner Id |
Input Property - List creator Id that contains the contact, if applicable. |
Registration Date |
Input Property - Date of registration. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Reg Id* |
Output Property - Attendee Id. |
Status* |
Input Property - Status of the registration. |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
Quote Item Id |
Output Property - Quote Item Row Id. |
Reg Id |
Output Property - Attendee Id. |
Shopping Flag ("Y" or "") |
Output Property - Determines whether the Shopping Cart process is required. "YES" or Null. |
UpdateSpace Method
This method creates or updates a regn and updates event counts within a Lock to ensure transaction integrity. See Table 19 for a description of UpdateSpace Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 19. UpdateSpace Method Properties
|
|
Event Id* |
Input Property - Row Id of the Event. |
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Action* (Mode of Operation to be performed - create regn, update regn) |
Input Property - Operation can be performed. Increase count: Enroll an attendee Drop from enroll: Drop an attendee (no functionality present for this currently) Drop from waiting: Drop an WL attendee (no functionality present for this currently) Drop from invited: Drop an invitee (no functionality present for this currently) Waiting to enroll: Enroll an existing attendee (called from Update Regn) Invitee to enroll: Enroll an invitee (called from Update Regn) |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
Reg Id |
Output Property - Attendee Id. |
CheckQuote Method
This method determines whether the current user needs to be charged. See Table 20 for a description of CheckQuote Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 20. CheckQuote Method Properties
|
|
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Reg Id* |
Input Property - Registration or attendee row Id. |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
AddToShoppingCart Method
This method invokes the shopping service to create a quote item. See Table 21 for a description of AddToShoppingCart Method properties. NOTE: Input Properties marked by an asterisk(*) indicate a required field.
Table 21. AddToShoppingCart Method Properties
|
|
Prospect Id |
Input Property - Row Id of the prospect being registered. This property is used by the Siebel Marketing Server during campaign execution. |
Contact Id |
Input Property - Row Id of the contact being registered. |
User Type* (Contact or Prospect) |
Input Property - Type of individual being registered. "Contact" or "Prospect." |
Reg Id* |
Input Property - Registration or attendee row Id. |
Event Id* |
Input Property - Event row Id. |
Return Val* (Success or Failure) |
Output Property - "Success" or "Failure." |
Output Type* (Info on the return value) |
Output Property - Further information on the result. |
Error String (Contains Event Id) |
Output Property - Event Id. |
Error Message (Error encountered) |
Output Property - Description of any error encountered. |
Error Param (User Id) |
Output Property - Contact or Prospect Id. |
Error Code (Contains Error Identifier) |
Output Property - Siebel Error Id. |
Quote Id |
Output Property - Quote Row Id (Returns a quote id if a new quote is created). |
Quote Item Id |
Output Property - Quote Item Row Id (Returns a quote item Id if the quote item already exists in the same Web session). |
Shopping Flag ("Y" or "") |
Output Property - Determines whether the Shopping Cart process is required. "YES" or Null. |
| 
