Implements features which are common between different type of event registrations API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

PublicEventsSharedFeatures

GET /api/public/events/{eventid}/findcontactbyemail

eventid: integer
in path

(no description)

email: string
in query

(no description)

hash: string
in query

(no description)

200 OK
PublicApiResponseObject<ExpandoObject>

OK

Response Example (200 OK) 
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}
PublicEventsSharedFeatures

GET /api/public/events/{eventid}/getrelatedcontacts/{contactid}

eventid: integer
in path

(no description)

contactid: integer
in path

(no description)

hash: string
in query

(no description)

200 OK
ContactInfo

OK

type
ContactInfo
Response Example (200 OK) 
[
  {
    "ContactId": "string",
    "Prefix": "string",
    "FirstName": "string",
    "CommonName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "OrganizationContactId": "string",
    "OrganizationName": "string",
    "Title": "string",
    "IsTaxExempt": "boolean",
    "EmailAddress": "string",
    "Address": "string",
    "Phone": "string",
    "ContactRoles": "string",
    "Vouchers": "string",
    "MembershipIds": "string",
    "IsMember": "boolean",
    "TaxSet": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/checkpromocode

eventdetailid: integer
in query

(no description)

code: string
in query

(no description)

attendeescount: integer
in query

(no description)

200 OK
PublicApiResponseObject<dynamic>

OK

Response Example (200 OK) 
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}
PublicEventsSharedFeatures

POST /api/public/events/checkpromocodesv2

PromoCodesValidationModel

undefined

Request Example
{
  "Id": "integer",
  "EventDetailId": "integer",
  "AttendeesCount": "integer",
  "NewCode": "string",
  "CurrentCodes": "string"
}
200 OK
PublicApiResponseObject<List>

OK

Response Example (200 OK) 
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}
PublicEventsSharedFeatures

GET /api/public/events/findattendee

search: string
in query

(no description)

ignore: string
in query

(no description)

ms: string
in query

(no description)

includeorgs: string
in query

(no description)

200 OK
PersonTypeAheadItem

OK

type
PersonTypeAheadItem
Response Example (200 OK) 
[
  {
    "ContactId": "integer",
    "DisplayName": "string",
    "Prefix": "string",
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "NotUniqueInSet": "boolean",
    "ContactAuditId": "integer",
    "Name": "string",
    "AdditionalData": "string",
    "Title": "string",
    "IsStaff": "boolean",
    "IsTaxExempt": "boolean",
    "DestinationContactId": "integer",
    "TaxSet": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/findattendee/{eventid}

eventid: integer
in path

(no description)

search: string
in query

(no description)

ignore: string
in query

(no description)

200 OK
AttendeeTypeAheadItem

OK

type
AttendeeTypeAheadItem
Response Example (200 OK) 
[
  {
    "ContactId": "integer",
    "DisplayName": "string",
    "Prefix": "string",
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "NotUniqueInSet": "boolean",
    "ContactAuditId": "integer",
    "Name": "string",
    "AdditionalData": "string",
    "Title": "string",
    "IsStaff": "boolean",
    "IsTaxExempt": "boolean",
    "DestinationContactId": "integer",
    "TaxSet": "string",
    "EventAttendeeId": "integer"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/findattendeev2

searchterm: string
in query

(no description)

includenoncrm: boolean
in query

(no description)

200 OK
V2ContactTypeAheadItem

OK

type
V2ContactTypeAheadItem
Response Example (200 OK) 
[
  {
    "ContactId": "string",
    "Prefix": "string",
    "FirstName": "string",
    "CommonName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "OrganizationContactId": "string",
    "OrganizationName": "string",
    "Title": "string",
    "IsTaxExempt": "boolean",
    "EmailAddress": "string",
    "Address": "string",
    "Phone": "string",
    "ContactRoles": "string",
    "Vouchers": "string",
    "MembershipIds": "string",
    "IsMember": "boolean",
    "TaxSet": "string",
    "IsContact": "boolean",
    "BriefInfo": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/findcontactbyemail

email: string
in query

(no description)

200 OK
PublicApiResponseObject<dynamic>

OK

Response Example (200 OK) 
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}
PublicEventsSharedFeatures

GET /api/public/events/findcontactbyemailv2

email: string
in query

(no description)

200 OK
PublicApiResponseObject<ExpandoObject>

OK

Response Example (200 OK) 
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}
PublicEventsSharedFeatures

GET /api/public/events/findorg

search: string
in query

(no description)

200 OK
OrgTypeAheadItem

OK

type
OrgTypeAheadItem
Response Example (200 OK) 
[
  {
    "Name": "string",
    "AccountNumber": "string",
    "OrganizationContactId": "integer",
    "AuditId": "integer",
    "AdditionalData": "string",
    "DestinationContactId": "integer",
    "Id": "integer",
    "Title": "string",
    "StateProvince": "string",
    "City": "string",
    "Address1": "string",
    "Address2": "string",
    "Website": "string",
    "TypeAheadData": "string",
    "TypeAheadItemDisplay": "string",
    "TypeAheadItemTitle": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/findorgv2

search: string
in query

(no description)

relatedtocontactid: string
in query

(no description)

200 OK
V2OrgTypeAheadItem

OK

type
V2OrgTypeAheadItem
Response Example (200 OK) 
[
  {
    "ContactId": "string",
    "Prefix": "string",
    "FirstName": "string",
    "CommonName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "OrganizationContactId": "string",
    "OrganizationName": "string",
    "Title": "string",
    "IsTaxExempt": "boolean",
    "EmailAddress": "string",
    "Address": "string",
    "Phone": "string",
    "ContactRoles": "string",
    "Vouchers": "string",
    "MembershipIds": "string",
    "IsMember": "boolean",
    "TaxSet": "string",
    "BriefInfo": "string",
    "StateProvince": "string",
    "City": "string",
    "TypeAheadData": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/findperson

search: string
in query

(no description)

ignore: string
in query

(no description)

ms: string
in query

(no description)

includeorgs: string
in query

(no description)

200 OK
PersonTypeAheadItem

OK

type
PersonTypeAheadItem
Response Example (200 OK) 
[
  {
    "ContactId": "integer",
    "DisplayName": "string",
    "Prefix": "string",
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "NotUniqueInSet": "boolean",
    "ContactAuditId": "integer",
    "Name": "string",
    "AdditionalData": "string",
    "Title": "string",
    "IsStaff": "boolean",
    "IsTaxExempt": "boolean",
    "DestinationContactId": "integer",
    "TaxSet": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/findsponsorv0

search: string
in query

(no description)

200 OK
V0SponsorTypeAheadItem

OK

type
V0SponsorTypeAheadItem
Response Example (200 OK) 
[
  {
    "ContactId": "string",
    "Prefix": "string",
    "FirstName": "string",
    "CommonName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "OrganizationContactId": "string",
    "OrganizationName": "string",
    "Title": "string",
    "IsTaxExempt": "boolean",
    "EmailAddress": "string",
    "Address": "string",
    "Phone": "string",
    "ContactRoles": "string",
    "Vouchers": "string",
    "MembershipIds": "string",
    "IsMember": "boolean",
    "TaxSet": "string",
    "BriefInfo": "string",
    "StateProvince": "string",
    "City": "string",
    "TypeAheadData": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/getattendeecustomfieldsv2/{eventid}/{contactid}

eventid: integer
in path

(no description)

contactid: integer
in path

(no description)

200 OK
Dictionary<Int32, CustomFieldTabModel>

OK

type
Dictionary<Int32, CustomFieldTabModel>
Response Example (200 OK) 
[
  {
    "Comparer": "string",
    "Count": "integer",
    "Keys": "string",
    "System.Collections.Generic.IDictionary<TKey,TValue>.Keys": "string",
    "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys": "string",
    "Values": "string",
    "System.Collections.Generic.IDictionary<TKey,TValue>.Values": "string",
    "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values": "string",
    "this[]": "string",
    "System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly": "boolean",
    "System.Collections.ICollection.IsSynchronized": "boolean",
    "System.Collections.ICollection.SyncRoot": "string",
    "System.Collections.IDictionary.IsFixedSize": "boolean",
    "System.Collections.IDictionary.IsReadOnly": "boolean",
    "System.Collections.IDictionary.Keys": "string",
    "System.Collections.IDictionary.Values": "string",
    "System.Collections.IDictionary.Item": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/getrelatedcontactsv2/{contactid}

contactid: integer
in path

(no description)

200 OK
ContactInfo

OK

type
ContactInfo
Response Example (200 OK) 
[
  {
    "ContactId": "string",
    "Prefix": "string",
    "FirstName": "string",
    "CommonName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Suffix": "string",
    "OrganizationContactId": "string",
    "OrganizationName": "string",
    "Title": "string",
    "IsTaxExempt": "boolean",
    "EmailAddress": "string",
    "Address": "string",
    "Phone": "string",
    "ContactRoles": "string",
    "Vouchers": "string",
    "MembershipIds": "string",
    "IsMember": "boolean",
    "TaxSet": "string"
  }
]
PublicEventsSharedFeatures

GET /api/public/events/getuserdata

200 OK
PublicApiResponseObject<dynamic>

OK

Response Example (200 OK) 
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}
PublicEventsSharedFeatures

GET /api/public/events/nowshowfee/{contactid}

contactid: integer
in path

(no description)

200 OK
NoShowFee

OK

type
NoShowFee
Response Example (200 OK) 
[
  {
    "EventName": "string",
    "EventStartLocalTimeString": "string",
    "AdditionalItem": "string"
  }
]

Schema Definitions

PublicApiResponseObject<dynamic>: object

Status: integer
StatusMessage: string
Data: string
Example
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}

PublicApiResponseObject<ExpandoObject>: object

Status: integer
StatusMessage: string
Data: string
Example
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}

ContactInfo: object

ContactId: string
Prefix: string
FirstName: string
CommonName: string
MiddleName: string
LastName: string
Suffix: string
OrganizationContactId: string
OrganizationName: string
Title: string
IsTaxExempt: boolean
EmailAddress: string
Address: string
Phone: string
ContactRoles: string
Vouchers: string
MembershipIds: string
IsMember: boolean
TaxSet: string
Example
{
  "ContactId": "string",
  "Prefix": "string",
  "FirstName": "string",
  "CommonName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "OrganizationContactId": "string",
  "OrganizationName": "string",
  "Title": "string",
  "IsTaxExempt": "boolean",
  "EmailAddress": "string",
  "Address": "string",
  "Phone": "string",
  "ContactRoles": "string",
  "Vouchers": "string",
  "MembershipIds": "string",
  "IsMember": "boolean",
  "TaxSet": "string"
}

OrgTypeAheadItem: object

Name: string
AccountNumber: string
OrganizationContactId: integer
AuditId: integer
AdditionalData: string

For email line below name

DestinationContactId: integer

For contact merging

Id: integer

For duplicate detection

Title: string
StateProvince: string
City: string
Address1: string
Address2: string
Website: string
TypeAheadData: string
TypeAheadItemDisplay: string
TypeAheadItemTitle: string
Example
{
  "Name": "string",
  "AccountNumber": "string",
  "OrganizationContactId": "integer",
  "AuditId": "integer",
  "AdditionalData": "string",
  "DestinationContactId": "integer",
  "Id": "integer",
  "Title": "string",
  "StateProvince": "string",
  "City": "string",
  "Address1": "string",
  "Address2": "string",
  "Website": "string",
  "TypeAheadData": "string",
  "TypeAheadItemDisplay": "string",
  "TypeAheadItemTitle": "string"
}

V2OrgTypeAheadItem: object

ContactId: string
Prefix: string
FirstName: string
CommonName: string
MiddleName: string
LastName: string
Suffix: string
OrganizationContactId: string
OrganizationName: string
Title: string
IsTaxExempt: boolean
EmailAddress: string
Address: string
Phone: string
ContactRoles: string
Vouchers: string
MembershipIds: string
IsMember: boolean
TaxSet: string
BriefInfo: string
StateProvince: string
City: string
TypeAheadData: string
Example
{
  "ContactId": "string",
  "Prefix": "string",
  "FirstName": "string",
  "CommonName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "OrganizationContactId": "string",
  "OrganizationName": "string",
  "Title": "string",
  "IsTaxExempt": "boolean",
  "EmailAddress": "string",
  "Address": "string",
  "Phone": "string",
  "ContactRoles": "string",
  "Vouchers": "string",
  "MembershipIds": "string",
  "IsMember": "boolean",
  "TaxSet": "string",
  "BriefInfo": "string",
  "StateProvince": "string",
  "City": "string",
  "TypeAheadData": "string"
}

V0SponsorTypeAheadItem: object

ContactId: string
Prefix: string
FirstName: string
CommonName: string
MiddleName: string
LastName: string
Suffix: string
OrganizationContactId: string
OrganizationName: string
Title: string
IsTaxExempt: boolean
EmailAddress: string
Address: string
Phone: string
ContactRoles: string
Vouchers: string
MembershipIds: string
IsMember: boolean
TaxSet: string
BriefInfo: string
StateProvince: string
City: string
TypeAheadData: string
Example
{
  "ContactId": "string",
  "Prefix": "string",
  "FirstName": "string",
  "CommonName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "OrganizationContactId": "string",
  "OrganizationName": "string",
  "Title": "string",
  "IsTaxExempt": "boolean",
  "EmailAddress": "string",
  "Address": "string",
  "Phone": "string",
  "ContactRoles": "string",
  "Vouchers": "string",
  "MembershipIds": "string",
  "IsMember": "boolean",
  "TaxSet": "string",
  "BriefInfo": "string",
  "StateProvince": "string",
  "City": "string",
  "TypeAheadData": "string"
}

V2ContactTypeAheadItem: object

ContactId: string
Prefix: string
FirstName: string
CommonName: string
MiddleName: string
LastName: string
Suffix: string
OrganizationContactId: string
OrganizationName: string
Title: string
IsTaxExempt: boolean
EmailAddress: string
Address: string
Phone: string
ContactRoles: string
Vouchers: string
MembershipIds: string
IsMember: boolean
TaxSet: string
IsContact: boolean
BriefInfo: string
Example
{
  "ContactId": "string",
  "Prefix": "string",
  "FirstName": "string",
  "CommonName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "OrganizationContactId": "string",
  "OrganizationName": "string",
  "Title": "string",
  "IsTaxExempt": "boolean",
  "EmailAddress": "string",
  "Address": "string",
  "Phone": "string",
  "ContactRoles": "string",
  "Vouchers": "string",
  "MembershipIds": "string",
  "IsMember": "boolean",
  "TaxSet": "string",
  "IsContact": "boolean",
  "BriefInfo": "string"
}

NoShowFee: object

EventName: string
EventStartLocalTimeString: string
AdditionalItem: string
Example
{
  "EventName": "string",
  "EventStartLocalTimeString": "string",
  "AdditionalItem": "string"
}

Dictionary<Int32, CustomFieldTabModel>: object

Comparer: string
Count: integer
Keys: string
System.Collections.Generic.IDictionary<TKey,TValue>.Keys: string
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys: string
Values: string
System.Collections.Generic.IDictionary<TKey,TValue>.Values: string
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values: string
this[]: string
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly: boolean
System.Collections.ICollection.IsSynchronized: boolean
System.Collections.ICollection.SyncRoot: string
System.Collections.IDictionary.IsFixedSize: boolean
System.Collections.IDictionary.IsReadOnly: boolean
System.Collections.IDictionary.Keys: string
System.Collections.IDictionary.Values: string
System.Collections.IDictionary.Item: string
Example
{
  "Comparer": "string",
  "Count": "integer",
  "Keys": "string",
  "System.Collections.Generic.IDictionary<TKey,TValue>.Keys": "string",
  "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys": "string",
  "Values": "string",
  "System.Collections.Generic.IDictionary<TKey,TValue>.Values": "string",
  "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values": "string",
  "this[]": "string",
  "System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly": "boolean",
  "System.Collections.ICollection.IsSynchronized": "boolean",
  "System.Collections.ICollection.SyncRoot": "string",
  "System.Collections.IDictionary.IsFixedSize": "boolean",
  "System.Collections.IDictionary.IsReadOnly": "boolean",
  "System.Collections.IDictionary.Keys": "string",
  "System.Collections.IDictionary.Values": "string",
  "System.Collections.IDictionary.Item": "string"
}

PersonTypeAheadItem: object

ContactId: integer
DisplayName: string
Prefix: string
FirstName: string
MiddleName: string
LastName: string
Suffix: string
NotUniqueInSet: boolean
ContactAuditId: integer
Name: string
AdditionalData: string
Title: string

brought it here in order for TypeAhead to populate the title as well

IsStaff: boolean
IsTaxExempt: boolean
DestinationContactId: integer

For contact merging

TaxSet: string
Example
{
  "ContactId": "integer",
  "DisplayName": "string",
  "Prefix": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "NotUniqueInSet": "boolean",
  "ContactAuditId": "integer",
  "Name": "string",
  "AdditionalData": "string",
  "Title": "string",
  "IsStaff": "boolean",
  "IsTaxExempt": "boolean",
  "DestinationContactId": "integer",
  "TaxSet": "string"
}

AttendeeTypeAheadItem: object

ContactId: integer
DisplayName: string
Prefix: string
FirstName: string
MiddleName: string
LastName: string
Suffix: string
NotUniqueInSet: boolean
ContactAuditId: integer
Name: string
AdditionalData: string
Title: string

brought it here in order for TypeAhead to populate the title as well

IsStaff: boolean
IsTaxExempt: boolean
DestinationContactId: integer

For contact merging

TaxSet: string
EventAttendeeId: integer
Example
{
  "ContactId": "integer",
  "DisplayName": "string",
  "Prefix": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "NotUniqueInSet": "boolean",
  "ContactAuditId": "integer",
  "Name": "string",
  "AdditionalData": "string",
  "Title": "string",
  "IsStaff": "boolean",
  "IsTaxExempt": "boolean",
  "DestinationContactId": "integer",
  "TaxSet": "string",
  "EventAttendeeId": "integer"
}

PublicApiResponseObject<List>: object

Status: integer
StatusMessage: string
Data: string
Example
{
  "Status": "integer",
  "StatusMessage": "string",
  "Data": "string"
}

PromoCodesValidationModel: object

Id: integer
EventDetailId: integer
AttendeesCount: integer
NewCode: string
CurrentCodes: string
Example
{
  "Id": "integer",
  "EventDetailId": "integer",
  "AttendeesCount": "integer",
  "NewCode": "string",
  "CurrentCodes": "string"
}
Documentation by Spectacle