iMIS SDK

iMIS SDK Developer Guide

The iMIS software development kit (SDK) provides a secure set of web services for accessing the iMIS platform, across the organization, across different physical locations, and even across organizational boundaries.

This documentation contains the following sections and supports iMIS versions 20.2.26 (iMIS 20-300), 100.1.65 (iMIS 20-100 and iMIS 20-200), and later versions, unless a specific environment is specified.

Get Started    Discussions
Suggest Edits

Event, Function, Registrations

 

Event creation consists of functions (program items) and registration options.

To run Try It examples from this site, a valid Bearer access_token is required.

Create Token

Suggest Edits

Returns a list of Event

Returns a list containing a collection of Event

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Creates an Event

Creates an instance of Event

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

$type
string

The DataType must be "Asi.Soa.Events.DataContracts.EventData, Asi.Contracts"

AddGuests
boolean

Gets or sets a value indicating whether you can [add guests] to an event or not.

AdditionalDescription
string

Gets or sets additional description details formatted as HTML.

AddOnFees
array of objects

A collection of event add on fees.

$type
AddOnFeeId
AddOnFeeType
AddOnItem 
Description
Name
AllowRegistrantConflicts
boolean

Gets or sets a value indicating whether registrants for this event should be allowed to complete registration with event functions that conflict.

AllowRegistrationEdit
boolean

Gets or sets a value indicating whether this event allows registrants to edit previously-saved registrations.

AutomaticallyReleaseFromWaitlist
boolean

Gets or sets an indicator of whether or not wait list registrations are automatically released.

Capacity
int32

Gets or sets the capacity (maximum attendees).

Category
object

Event category.

 
Category.$type
string

The DataType must be "Asi.Soa.Events.DataContracts.EventCategoryData, Asi.Contracts"

Category.Description
string

Gets or sets the description.

Category.EventCategoryId
string

Gets or sets the event category Id.

Category.Name
string

Gets or sets the name or title of the category.

DefaultProgramItemDisplayMode
string

Default program item display enumeration. An enumeration of default program item display.

Description
string

Gets or sets the description.

DisplayLayouts
array of objects

Displaylayoutdata collection

$type
LayoutDirectory
LayoutDocument 
LayoutType
EarlyCutoffDate
date-time

Gets or sets the early cutoff date.

EnableTimeConflicts
boolean

Gets or sets a value indicating whether this event should use time conflict rules by default.

EndDateTime
date-time

Gets or sets the end date and time.

EventCode
string

Gets or sets the event code.

EventFormId
string

Gets or sets the associated form definition id for event questions.

EventFormSectionId
string

Gets or sets the associated form definition section id for event questions.

EventId
string

Gets or sets the event Id.

FinancialEntityId
string

Gets or sets the event financial entity.

Functions
array of objects

A collection of event functions.

$type
AdditionalDescription
Capacity
Category 
ConflictCodes
ContinuingEducationCreditInformation
Description
EnableTimeConflicts
EndDateTime
EventFormSectionId
EventFunctionCode
EventFunctionId
FinancialEntityId
Group 
Image 
ImageDescription
ImageUrl
IsCharitable
IsEventRegistrationOption
IsNewEventFunction
IsTicketed
Item 
Location 
MaximumQuantityPerRegistrant
Name
ProgramGroups 
RegistrationType
SortOrder
StartDateTime
Status
TagInformation 
UpdateInformation 
Group
object

Membership group summary. (membership) groups are used to represent almost any list of parties (persons or organizations). Typical groups include committees, community members, membership and subscription groups.

 
Group.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.GroupSummaryData, Asi.Contracts"

Group.Description
string

Gets or sets the description.

Group.GroupClass
object

Group class summary. Grouptyperef table

 
Group.GroupClass.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.GroupClassSummaryData, Asi.Contracts"

Group.GroupClass.Description
string

Gets or sets the description.

Group.GroupClass.GroupClassId
string

Gets or sets the group class id.

Group.GroupClass.IsDateLimited
boolean

Gets or sets a value indicating whether this class of groups has roles that are date limited (have a begin and/or expiration date)

Group.GroupClass.IsReadOnly
boolean

Gets or sets the read only indicator.

Group.GroupClass.IsRelationshipGroup
boolean

Gets or sets a value indicating whether this instance groups supports two-way relationships.

Group.GroupClass.IsSimpleGroup
boolean

Gets or sets a value indicating whether this class of groups is a simple group. Simple groups have no MembershipDetails.

Group.GroupClass.IsSystem
boolean

Gets or sets a value indicating whether this class of groups is system defined group.

Group.GroupClass.Name
string

Gets or sets the name.

Group.GroupId
string

Gets or sets the group Id.

Group.IsMemberGroup
boolean

Gets or sets a value indicating whether this instance is member group.

Group.IsPrimaryGroup
boolean

Gets or sets a value indicating whether this instance is a primary group.

Group.IsRelationshipGroup
boolean

Gets or sets a value indicating whether this instance supports relationships.

Group.IsSimpleGroup
boolean

Gets or sets a value indicating whether this instance is simple group. Simple groups have no MembershipDetails.

Group.IsSystem
boolean

Gets or sets a value indicating whether this instance is system defined.

Group.Name
string

Gets or sets the name of the group. Group names do not have to be unique.

Group.ParentIdentity
object

Datacontract represents the unique identifier of an entity.

 
Group.ParentIdentity.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts"

Group.ParentIdentity.EntityTypeName
string

Gets or sets the name of the entity type.

Group.ParentIdentity.Id
object

To the identifier.

 
Group.ParentIdentity.IdentityElements
array of strings

Gets or sets the identity elements.

Group.ParentIdentity.Key
string

Gets the key.

Group.StatusCode
string

Gets or sets a value indicating whether this instance is active/Inactive.

Image
object

Class virtualfiledata.

 
Image.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.VirtualFileData, Asi.Contracts"

Image.AlternateText
string

Gets or sets the alternate text.

Image.Description
string

Gets or sets the description.

Image.IsDefault
boolean

Gets or sets a value indicating whether this the specification for the defailt file/image.

Image.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

Image.VirtualPath
string

Gets or sets the image virtual path.

ImageDescription
string

Gets or sets the image alt text/description.

ImageUrl
string

Gets or sets the image URL.

Item
object

An item is used mainly for the purposes of ordering and pricing, and represents a product or service.

 
Item.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.ItemSummaryData, Asi.Contracts"

Item.Description
string

Gets or sets the description.

Item.ItemClass
object

An item class describes the default financial and processing attributes of an item.

 
Item.ItemClass.$type
string

The DataType must be "Asi.Soa.Commerce.DataContracts.ItemClassSummaryData, Asi.Contracts"

Item.ItemClass.ItemClassId
string

Gets or sets the item class id.

Item.ItemClass.Name
string

Gets or sets the name of the item class.

Item.ItemCode
string

Gets or sets the item code.

Item.ItemId
string

Gets or sets the item Id.

Item.ItemStatus
string

List of item status

Item.Name
string

Gets or sets the name or title of the item.

Location
object

Party address location

 
Location.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.LocationPartyAddressData, Asi.Contracts"

Location.Address
object

Full address datacontract. A full address contains a (optional) basic postal/physical address, as well as associated phone, fax, email, and other information.

 
Location.Address.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.FullAddressData, Asi.Contracts"

Location.Address.AdditionalLines
array of strings

A collection of address lines.

Location.Address.Address
object

Physical / postal address data contract.

 
Location.Address.Address.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.AddressData, Asi.Contracts"

Location.Address.Address.AddressId
string

Gets or sets the address Id.

Location.Address.Address.AddressLines
array of strings

A collection of address lines.

Location.Address.Address.AddressTokenId
string

Gets or sets a unique identifier for the purpose of retrieving a full valid address from .

Location.Address.Address.Barcode
string

Gets or sets the barcode.

Location.Address.Address.BarcodeSortPlanNumber
string

Gets or sets the Barcode Sort Plan Number.

Location.Address.Address.CarrierRoute
string

Gets or sets the carrier route.

Location.Address.Address.CityName
string

Gets or sets the name of the city.

Location.Address.Address.CountryCode
string

Gets or sets the country code.

Location.Address.Address.CountryName
string

Gets or sets the name of the country.

Location.Address.Address.CountrySubEntityCode
string

Gets or sets the country sub entity code.

Location.Address.Address.CountrySubEntityName
string

Gets or sets the name of the country sub entity. Example of a sub entity would be a state or province.

Location.Address.Address.CountyCode
string

Gets or sets the county code.

Location.Address.Address.CountyName
string

Gets or sets the name of the county.

Location.Address.Address.DeliveryPointCode
string

Gets or sets the delivery point code.

Location.Address.Address.FullAddress
string

Gets or sets the full, formatted address.

Location.Address.Address.IsMarkedForDelete
boolean

Gets or sets the marked for delete indicator.

Location.Address.Address.LocalGovernmentDistrict1
string

Gets or sets the local government district1.

Location.Address.Address.LocalGovernmentDistrict2
string

Gets or sets the local government district2.

Location.Address.Address.LocationCoordinate
object

Address location coordinate datacontract.

 
Location.Address.Address.NationalGovernmentDistrict
string

Gets or sets the national government district. In the US, this may be a US congressional district.

Location.Address.Address.PostalCode
string

Gets or sets the postal code or zip.

Location.Address.Address.RegionName
string

Gets or sets the name of the region.

Location.Address.Address.VerificationMessage
string

Gets or sets the verification message.

Location.Address.Address.VerificationStatus
string

Enumeration of last address verification status.

Location.Address.Address.VerifiedOn
date-time

Gets or sets the date the address was last verified.

Location.Address.AddresseeText
string

Gets or sets the composite full addressee text.

Location.Address.AddressPurpose
string

Gets or sets the address purpose.

Location.Address.BadAddress
string

Gets or sets the bad address code of this full address.

Location.Address.CommunicationPreferences
array of objects

A collection of communication preferences.

$type
CannotOptOut
CommunicationTypeDisplay
CommunicationTypeId
DefaultOptOut
Formula
IsDefaultType
IsMarkedForDelete
IsSolicitation
IsSystem
OverrideFullAddressText
Reason
Status
Location.Address.DisplayName
string

Gets or sets the party display name to use for this full address.

Location.Address.DisplayOrganizationName
string

Gets or sets the party organization name to use for this full address.

Location.Address.DisplayOrganizationTitle
string

Gets or sets the party organization title to use for this full address.

Location.Address.Email
string

Gets or sets the email address.

Location.Address.Fax
string

Gets or sets the fax.

Location.Address.FullAddressId
string

Gets or sets the full address Id.

Location.Address.IsAddresseeOverridden
boolean

Gets or sets the addressee overridden indicator.

Location.Address.IsMarkedForDelete
boolean

Gets or sets the marked for delete indicator.

Location.Address.Note
string

Gets or sets the note or instructions.

Location.Address.Phone
string

Gets or sets the address-specific phone.

Location.Address.Salutation
object

A salutation that is specific to a party.

 
Location.Address.Salutation.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartySalutationData, Asi.Contracts"

Location.Address.Salutation.IsMarkedForDelete
boolean

Gets or sets the marked for delete indicator.

Location.Address.Salutation.IsOverridden
boolean

Gets or sets a value indicating whether this instance contains an overridden salutation text.

Location.Address.Salutation.SalutationId
string

Gets or sets the salutation Id.

Location.Address.Salutation.SalutationMethod
object

Party salutation method summary.

 
Location.Address.Salutation.Text
string

Gets or sets the formatted text of the salutation.

Location.Address.Status
object

Full address status.

 
Location.Address.Status.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.FullAddressStatusData, Asi.Contracts"

Location.Address.Status.AddressStatus
string

Full address status enumeration.

Location.Address.Status.StatusReason
string

Gets or sets the status reason.

Location.FullAddressId
string

Gets or sets the full address id.

Location.Name
string

Gets or sets the name or title of the location.

Location.PartyAddressId
string

Gets or sets the party address id.

Location.PartyId
string

Gets or sets the party id.

Name
string

Gets or sets the name of the event.

NotificationPartyId
string

Gets or sets the id of the party to be notified about registrations for this event.

ParentIdentity
object

Datacontract represents the unique identifier of an entity.

 
ParentIdentity.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts"

ParentIdentity.EntityTypeName
string

Gets or sets the name of the entity type.

ParentIdentity.Id
object

To the identifier.

 
ParentIdentity.IdentityElements
array of strings

Gets or sets the identity elements.

ParentIdentity.Key
string

Gets the key.

ProgramGroupInfo
array of objects

Program group information collection this contains a collection of specific approaches for grouping program items within an event.

$type
AllowDisplaySelection
AllowFreeFormValues
Name
ProgramGroupInfoId
ProgramGroups
PublishingInformation
object

Publishing information. Defines a standardized set of properties that describe the information that is relevant to publishing for an object.

 
PublishingInformation.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.PublishingInformationData, Asi.Contracts"

PublishingInformation.ExpirationDate
date-time

Gets or sets the expiration date after which the published object will be unavailable to public users.

PublishingInformation.IsClosed
boolean

Gets or sets the is closed flag.

PublishingInformation.IsMarkedForDelete
boolean

Gets or sets the marked for delete indicator.

PublishingInformation.Keywords
array of strings

Gets or sets the keywords.

PublishingInformation.PublishingState
string

Publishing status. This class summarizes an item's publishing state in terms of availability and visibility on the web site.

PublishingInformation.StartDate
date-time

Gets or sets the start date on which the published object will be available to public users.

PublishingInformation.TagInformation
object

Tag information.

 
PublishingInformation.TagInformation.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.TagInformationData, Asi.Contracts"

PublishingInformation.TagInformation.Tags
array of objects

A collection of tags.

$type
ChildTags
Description
Name
TagId
RegisterOthers
boolean

Gets or sets a value indicating whether you can [register others] to an event or not.

RegistrationClosedMessage
string

Gets or sets the message that should be displayed upon attempted registration when the has passed.

RegistrationEditCutoffDate
date-time

Gets or sets the registration edit cutoff date.

RegistrationEndDate
date-time

Gets or sets the date time upon which registration is no longer allowed.

RegistrationOptions
array of objects

A collection of option event functions.

$type
AdditionalDescription
AvailableTo 
Capacity
Category 
ConflictCodes
ContinuingEducationCreditInformation
Description
EnableTimeConflicts
EndDateTime
EventFormSectionId
EventFunctionCode
EventFunctionId
FinancialEntityId
Group 
Image 
ImageDescription
ImageUrl
IsCharitable
IsEventRegistrationOption
IsNewEventFunction
IsTicketed
Item 
Location 
MaximumQuantityPerRegistrant
Name
ProgramGroups 
RegistrationType
RelatedFunctions
SortOrder
StartDateTime
Status
TagInformation 
UpdateInformation 
RegistrationStartDate
date-time

Gets or sets the date time upon which registration may commence.

RegistrationType
string

Registration type enumeration.

RegularCutoffDate
date-time

Gets or sets the regular cutoff date.

StartDateTime
date-time

Gets or sets the start date and time.

Status
string

Gets or sets the status.

TemplateState
string

Template state enumeration

UpdateInformation
object

Entity update information datacontract. Describe standard set of updated information.

 
UpdateInformation.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts"

UpdateInformation.CreatedBy
string

Gets or sets the created by.

UpdateInformation.CreatedOn
date-time

Gets or sets the created on.

UpdateInformation.UpdatedBy
string

Gets or sets the updated by.

UpdateInformation.UpdatedOn
date-time

Gets or sets the updated on.

WaitlistPermissions
string

Waitlist permissions enumeration. An enumeration of waitlist permission.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes an Event by id

Removes an instance of Event by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event/EventId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event/EventId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event/EventId");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

EventId
string
required

Id of Event to be Removed

Response

The request was successful.

Suggest Edits

Returns an Event by id

Returns an instance of Event by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event/EventId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event/EventId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Event/EventId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

EventId
string
required

Id of Event to be Returned

Response

The request was successful.

EventId Examples

  • CHAPAUG
  • CHAPDEC
  • ANNCONF
Suggest Edits

EventRegistration

 
Suggest Edits

Returns an EventRegistration

Returns a single record of an EventRegistration

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration?EventId=CHAPFEB&PartyId=21699");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration?EventId=CHAPFEB&PartyId=21699");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

EventId
string
required

The EventId for the EventRegistration

PartyId
string
required

The Party Id for the EventRegistration

Response

The request was successful.

Suggest Edits

Returns an EventRegistration by id

Returns an instance of EventRegistration by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration/EventRegistrationId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration/EventRegistrationId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration/EventRegistrationId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

EventRegistrationId
string
required

Id of EventRegistration to be Returned

Response

The request was successful.

EventRegistrationId Format

[EventId]-[PartyId]

EventRegistrationId Examples

  • SPR07-190
  • EDU2013-23095
  • ANNCONF-20641
Suggest Edits

Updates an EventRegistration by id

Updates an instance of EventRegistration by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration/EventRegistrationId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration/EventRegistrationId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistration/EventRegistrationId");
var request = new RestRequest(Method.PUT);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

EventRegistrationId
string
required

Id of EventRegistration to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Events.DataContracts.EventRegistrationData, Asi.Contracts"

Event
object

Top level summary of event.

 
Event.$type
string

The DataType must be "Asi.Soa.Events.DataContracts.EventSummaryData, Asi.Contracts"

Event.Category
object

Event category.

 
Event.Category.$type
string

The DataType must be "Asi.Soa.Events.DataContracts.EventCategoryData, Asi.Contracts"

Event.Category.Description
string

Gets or sets the description.

Event.Category.EventCategoryId
string

Gets or sets the event category Id.

Event.Category.Name
string

Gets or sets the name or title of the category.

Event.Description
string

Gets or sets the description.

Event.DisplayLayouts
array of objects

Displaylayoutdata collection

$type
LayoutDirectory
LayoutDocument 
LayoutType
Event.EventCode
string

Gets or sets the event code.

Event.EventId
string

Gets or sets the event Id.

Event.Group
object

Membership group summary. (membership) groups are used to represent almost any list of parties (persons or organizations). Typical groups include committees, community members, membership and subscription groups.

 
Event.Group.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.GroupSummaryData, Asi.Contracts"

Event.Group.Description
string

Gets or sets the description.

Event.Group.GroupClass
object

Group class summary. Grouptyperef table

 
Event.Group.GroupClass.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.GroupClassSummaryData, Asi.Contracts"

Event.Group.GroupClass.Description
string

Gets or sets the description.

Event.Group.GroupClass.GroupClassId
string

Gets or sets the group class id.

Event.Group.GroupClass.IsDateLimited
boolean

Gets or sets a value indicating whether this class of groups has roles that are date limited (have a begin and/or expiration date)

Event.Group.GroupClass.IsReadOnly
boolean

Gets or sets the read only indicator.

Event.Group.GroupClass.IsRelationshipGroup
boolean

Gets or sets a value indicating whether this instance groups supports two-way relationships.

Event.Group.GroupClass.IsSimpleGroup
boolean

Gets or sets a value indicating whether this class of groups is a simple group. Simple groups have no MembershipDetails.

Event.Group.GroupClass.IsSystem
boolean

Gets or sets a value indicating whether this class of groups is system defined group.

Event.Group.GroupClass.Name
string

Gets or sets the name.

Event.Group.GroupId
string

Gets or sets the group Id.

Event.Group.IsMemberGroup
boolean

Gets or sets a value indicating whether this instance is member group.

Event.Group.IsPrimaryGroup
boolean

Gets or sets a value indicating whether this instance is a primary group.

Event.Group.IsRelationshipGroup
boolean

Gets or sets a value indicating whether this instance supports relationships.

Event.Group.IsSimpleGroup
boolean

Gets or sets a value indicating whether this instance is simple group. Simple groups have no MembershipDetails.

Event.Group.IsSystem
boolean

Gets or sets a value indicating whether this instance is system defined.

Event.Group.Name
string

Gets or sets the name of the group. Group names do not have to be unique.

Event.Group.ParentIdentity
object

Datacontract represents the unique identifier of an entity.

 
Event.Group.ParentIdentity.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts"

Event.Group.ParentIdentity.EntityTypeName
string

Gets or sets the name of the entity type.

Event.Group.ParentIdentity.Id
object

To the identifier.

 
Event.Group.ParentIdentity.IdentityElements
array of strings

Gets or sets the identity elements.

Event.Group.ParentIdentity.Key
string

Gets the key.

Event.Group.StatusCode
string

Gets or sets a value indicating whether this instance is active/Inactive.

Event.Name
string

Gets or sets the name of the event.

Event.ParentIdentity
object

Datacontract represents the unique identifier of an entity.

 
Event.ParentIdentity.$type
string

The DataType must be "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts"

Event.ParentIdentity.EntityTypeName
string

Gets or sets the name of the entity type.

Event.ParentIdentity.Id
object

To the identifier.

 
Event.ParentIdentity.IdentityElements
array of strings

Gets or sets the identity elements.

Event.ParentIdentity.Key
string

Gets the key.

Event.RegistrationType
string

Registration type enumeration.

Event.Status
string

Gets or sets the status.

Event.TemplateState
string

Template state enumeration

EventRegistrationId
string

Gets or sets the registration id.

Functions
array of objects

A collection of event function registrations.

$type
EventFunction 
Quantity 
QuantityWaitlisted 
UnitPrice 
GuestOfRegistrationId
string

Gets or sets the Id of the EventRegistration object for which this registation represents a guest.

RegisteredByPartyId
string

Gets or sets the Id of the Party which performed this registration

Registrant
object

Party summary data contract. A set of basic data to identify a party.

 
Registrant.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts"

Registrant.CityName
string

Gets or sets the name of the city for the primary address.

Registrant.CountryName
string

Gets or sets the name of the country for the primary address.

Registrant.CountrySubEntityName
string

Gets or sets the name of the country sub entity for the primary address. (State/province)

Registrant.Email
string

Gets or sets the primary email.

Registrant.Id
string

Gets or sets the id; The member number, account number.

Registrant.ImageVirtualPath
string

Gets or sets the image virtual path.

Registrant.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Registrant.Name
string

Gets or sets the name of the party.

Registrant.PartyId
string

Gets or sets the party Id.

Registrant.Phone
string

Gets or sets the primary phone.

Registrant.Sort
string

Gets or sets the sort string.

Registrant.Status
object

Party status.

 
Registrant.Status.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts"

Registrant.Status.ActiveStatus
string

Party active status enumeration.

Registrant.Status.Description
string

Gets or sets the description.

Registrant.Status.Name
string

Gets or sets the name.

Registrant.Status.PartyStatusId
string

Gets or sets the party status id.

Registrant.UniformId
string

Gets or sets the uniform identifier.

RegistrantAddress
object

Party address.

 
RegistrantAddress.$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PartyAddressData, Asi.Contracts"

RegistrantAddress.FullAddressId
string

Gets or sets the full address id.

RegistrantAddress.PartyAddressId
string

Gets or sets the party address id.

RegistrantAddress.PartyId
string

Gets or sets the party id.

RegistrationDate
date-time

Gets or sets the registration date.

RelatedRegistrations
array of objects

Event registration summary collection.

$type
Event 
EventRegistrationId
GuestOfRegistrationId
RegisteredByPartyId
Registrant 
RegistrantAddress 
RegistrationDate
Status
Status
string

Event registration status enumeration.

Response

The request was successful.

Suggest Edits

EventRegistrationSummary

 
Suggest Edits

Returns an EventRegistrationSummary

Returns a single record of an EventRegistrationSummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistrationSummary
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistrationSummary?EventId=CHAPFEB&PartyId=21699");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistrationSummary?EventId=CHAPFEB&PartyId=21699");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

EventId
string
required

The EventId for the EventRegistrationSummary

PartyId
string
required

The Party Id for the EventRegistrationSummary

Response

The request was successful.

Suggest Edits

Returns an EventRegistrationSummary by id

Returns an instance of EventRegistrationSummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistrationSummary/EventRegistrationSummaryId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistrationSummary/EventRegistrationSummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventRegistrationSummary/EventRegistrationSummaryId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

EventRegistrationSummaryId
string
required

Id of EventRegistrationSummary to be Returned

Response

The request was successful.

EventRegistrationSummaryId Format

[EventId]-[PartyId]

EventRegistrationSummaryId examples

  • CHAPFEB-21699
  • FR510K-19086
  • LDC11-19534
Suggest Edits

EventSummary

 
Suggest Edits

Returns a list of EventSummary

Returns a list containing a collection of EventSummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Removes an EventSummary by id

Removes an instance of EventSummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary/EventSummaryId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary/EventSummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary/EventSummaryId");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

EventSummaryId
string
required

Id of EventSummary to be Removed

Response

The request was successful.

Suggest Edits

Returns an EventSummary by id

Returns an instance of EventSummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary/EventSummaryId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary/EventSummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/EventSummary/EventSummaryId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

EventSummaryId
string
required

Id of EventSummary to be Returned

Response

The request was successful.

EventSummaryId (EventId) Examples

  • ANNCONFP
  • CELEBSTAFF
  • CHAPAPR
Suggest Edits

PartyEventAvailability

 
Suggest Edits

Returns a list of PartyEventAvailability

Returns a list containing a collection of PartyEventAvailability

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyEventAvailability
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyEventAvailability");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyEventAvailability");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

limit
integer

Provides a limit for the results returned.

Response

The request was successful.

Suggest Edits

Returns a PartyEventAvailability by id

Returns an instance of PartyEventAvailability by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyEventAvailability/PartyEventAvailabilityId
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyEventAvailability/PartyEventAvailabilityId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyEventAvailability/PartyEventAvailabilityId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

PartyEventAvailabilityId
string
required

Id of PartyEventAvailability to be Returned

Response

The request was successful.

PartyEventAvailabilityId Format

~[PartyId]|[EventId]

PartyEventAvailabilityId Examples

  • ~101|ANNCONF
  • ~21699|CHAPFEB
  • ~23095|EDU2013