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.

Data models list the properties available and their datatype, and will explain the purpose of each property. Swagger files describe the API and can be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools.

For more information, see iMIS REST API Data models and swagger json files.

Get Started    Discussions

Membership primary entities

  • PartySummary – Top level summary of a Party, which provides a set of basic data to identify a Party. A Party represents any sort of business organization or person. Most contact browser applications should query and display PartySummary information (after the operator makes a selection) and then query for the full Party record.

  • Party – Extension of PartySummary, which provides more detailed properties of a Party. You generally query for Party (not its subclasses) and check the object type if you want detailed Person or Organization information. Party entities cannot be created directly: instead, create Person or Organization entities.

  • Person – A subclass of Party, which provides additional properties for a person. The enumeration of PersonData provides a list of possible genders (male or female).

  • Organization – Contains information specific to a company or other organization.

  • ComboParty – Properties of a ComboParty, which can represent either a person or an organization.

  • NamePrefix – Prefix component of PersonName.

  • NameSuffix – Suffix component of PersonName.

  • PartyImage – Properties of an image for a Party (such as a profile picture).

  • PartyNote – Properties of a note for a Party.

  • PartySalutationMethodSummary – Properties of a Party salutation method.

  • PartyStatus – Properties of a Party’s status. The enumeration of PartyStatus provides a list of possible party status types.

  • User – Properties of a user, such as effective and expiration dates.

  • AddressPurpose – Properties of an address purpose.

  • Country – Properties of a country.

  • GroupSummary – Top-level summary of a group, with a subset of all the group properties. Membership groups are used to represent almost any list of parties (persons or organizations). Typical groups include committees, community members, membership and subscription groups. The current implementation supports the following group types:

    • The product/subscription groups for dues, subscriptions, sections, chapters, miscellaneous, committees:
      • DUES
      • SUBS
      • SEC
      • CHAPT
      • VOL
      • MISC
      • COMMITTEE
    • Event registrants: EVENT-xx
      where xx is the meeting code.
    • Groups of Parties for each member type: MT-xx
      where xx is the legacy member type.
    • Organizational (company) roster groups: ORGRELATIONSHIP
    • Relationships: RELATIONSHIP
  • Group – Extension of GroupSummary which defines additional properties of a Membership group, including available roles.

  • GroupClassSummary – Properties of a class of groups. Includes properties for determining whether the group class is a simple group (with no MembershipDetails), or a relationship group (supports two-way relationships).

  • GroupMemberSummary – Properties for a party that is a member of a group. Includes properties for both the party and the group they are a member of, as well as details about the membership.

  • GroupMember – Extension of GroupMemberSummary, which contains MembershipDetails for a party that is a member of a group.

  • MembershipSettings – Properties for membership settings, represented in a GenericData entity.

Updated about a year ago


Membership primary entities


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.