post https://yourorgsite.com/api/EventRegistration/_execute
Executes an operation of EventRegistration
With the EventRegistration service, you can perform the following operations on the execute endpoint:
- EventRegistrationRequest
- RegisterEvent
- FindEventRegistrationIds
- CancelEventRegistration
EventRegistrationRequest
BODY PARAMS:
{
"$type": "Asi.Soa.Events.DataContracts.EventRegistrationRequest, Asi.Contracts",
"EntityTypeName": "EventRegistration",
"OperationName": "RegisterEvent",
"RegistrationType": {
"$type": "Asi.Soa.Events.DataContracts.EventRegistrationType, Asi.Contracts"
},
"EventId": "string value",
"RegistrationOptionFunctionId": "string value",
"FunctionId": "string value",
"RegistrantId": "string value",
"RegisteredBy": "string value",
"BillTo": "string value",
"Waitlist": false,
"RequestCulture": "string value"
}
RegisterEvent
Summary:
The current supported RegistrationType is EventRegistrationType.RegisterWithoutPayment (Enum value 3). This RegistrationType processes an Event Registration without the need for payment and is used by batch registration, which registers one registrant per request.
BODY PARAMS:
{
"$type": "Asi.Soa.Events.DataContracts.EventRegistrationRequest, Asi.Contracts",
"EntityTypeName": "EventRegistration",
"OperationName": "RegisterEvent",
"RegistrationType": {
"$type": "Asi.Soa.Events.DataContracts.EventRegistrationType, Asi.Contracts"
},
"EventId": "string value",
"RegistrationOptionFunctionId": "string value",
"FunctionId": "string value",
"RegistrantId": "string value",
"RegisteredBy": "string value",
"BillTo": "string value",
"Waitlist": false
}
FindEventRegistrationIds
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindEventRegistrationIds",
"EntityTypeName": "EventRegistration",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "eventRegistrationId Value"
}
]
}
}
CancelEventRegistration
Summary:
Providing a cancellation fee is optional, it depends on how the Event was set up. The endpoint will still expect the request to have the parameter provider.
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CancelEventRegistration",
"EntityTypeName": "EventRegistration",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection\`1\[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "eventRegistrationId Value"
},
{
"$type": "Asi.Soa.Commerce.DataContracts.OrderLineData, Asi.Contracts",
"$value": "OrderLine containing a cancelation fee."
}
]
}
}
Example without Cancellation Fee
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CancelEventRegistration",
"EntityTypeName": "EventRegistration",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "EventRegistrationId value"
},
{
"$type": "Asi.Soa.Commerce.DataContracts.OrderLineData, Asi.Contracts",
"ChildOrderLines": {
"$type": "Asi.Soa.Commerce.DataContracts.OrderLineDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.OrderLineData, Asi.Contracts"
}
]
}
}
]
}
}
Example with Cancellation Fee
Summary:
The ItemData will need the ItemCode and ItemId to contain the correct EventId for this Event. You can also obtain the full ItemData object by submiting a GET request to api/Item?ItemId={EventId}/_CANCEL where you sill need to replace the EventId.
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CancelEventRegistration",
"EntityTypeName": "EventRegistration",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "EventRegistrationId value"
},
{
"$type": "Asi.Soa.Commerce.DataContracts.OrderLineData, Asi.Contracts",
"ChildOrderLines":{
"$type": "Asi.Soa.Commerce.DataContracts.OrderLineDataCollection, Asi.Contracts",
"$values": [
{
"$type":"Asi.Soa.Commerce.DataContracts.OrderLineData, Asi.Contracts",
"QuantityOrdered":1,
"Item": {
"$type": "Asi.Soa.Commerce.DataContracts.ItemData, Asi.Contracts",
"ItemCode": "EventId/_CANCEL",
"ItemId": "EventId/_CANCEL"
}
}
]
}
}
]
}
}