HomeGuidesAPI ReferenceChangelogDiscussions
GuidesiMIS ProfessionaliMIS EnterpriseClient SupportLog In
API Reference
These docs are for v20.3.44. Click to read the latest docs for v20.3.189.

Executes an EventRegistration operation

Executes an operation of EventRegistration

With the EventRegistration service, you can perform the following operations on the execute endpoint:

  • RegisterEvent
  • FindEventRegistrationIds
  • CancelEventRegistration

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

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."
			}
		]
	}
}

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.

Example without Cancellation Fee

 {
      "$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

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.

{
    "$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"
                            }
                        }
                    ]
                }
            }
        ]
    }
}
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!