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

Party, Person, Organization, ComboParty, and Groups

 

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

Create Token

Suggest Edits

Returns a list of Group

Returns a list containing a collection of Group

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Group
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/Group");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Group");
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 a Group

Creates an instance of Group

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Group
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/Group");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Group");
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.Membership.DataContracts.GroupData, Asi.Contracts"

AvailableStages
array of objects

Group stage collection.

$type
IsDefault
Stage 
DefaultRole
object

Group role.

 
DefaultRole.$type
string

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

DefaultRole.DefaultReciprocalDescription
string

Gets or sets the default reciprocal role description.

DefaultRole.DefaultReciprocalName
string

Gets or sets the default reciprocal role name.

DefaultRole.DefaultReciprocalRoleId
string

Gets or sets the reciprocal role Id.

DefaultRole.Description
string

Gets or sets the role description.

DefaultRole.Name
string

Gets or sets the name of the role.

DefaultRole.Priority
int32

Gets or sets the priority.

DefaultRole.RoleId
string

Gets or sets the role Id.

DefaultRole.UseDates
boolean

Gets or sets the flag indicating whether or not this role uses the EffectiveDate and ExperationDate properties.

DefaultRole.UseTitle
boolean

Gets or sets the flag indicating whether or not this role uses the Title property.

Description
string

Gets or sets the description.

GroupCategory
string

Gets or sets the group category for this group.

GroupClass
object

Group class summary. Grouptyperef table

 
GroupClass.$type
string

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

GroupClass.Description
string

Gets or sets the description.

GroupClass.GroupClassId
string

Gets or sets the group class id.

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)

GroupClass.IsReadOnly
boolean

Gets or sets the read only indicator.

GroupClass.IsRelationshipGroup
boolean

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

GroupClass.IsSimpleGroup
boolean

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

GroupClass.IsSystem
boolean

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

GroupClass.Name
string

Gets or sets the name.

GroupId
string

Gets or sets the group Id.

IsAnnualBilling
boolean

Gets or sets a value indicating whether this group is billed annually.

IsMarkedForDelete
boolean

Gets or sets the marked for delete indicator.

IsMemberGroup
boolean

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

IsPrimaryGroup
boolean

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

IsRelationshipGroup
boolean

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

IsSimpleGroup
boolean

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

IsSystem
boolean

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

Name
string

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

Note
string

Gets or sets an additional note.

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.

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
Roles
array of objects

A collection of grouprole.

$type
DefaultReciprocalDescription
DefaultReciprocalName
DefaultReciprocalRoleId
Description
Name
Priority
RoleId
UseDates
UseTitle
StatusCode
string

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

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Returns a Group by id

Returns an instance of Group by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Group/GroupId
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/Group/GroupId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Group/GroupId");
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

GroupId
string
required

Id of Group to be Returned

Response

The request was successful.

GroupId Examples

  • 3YEAR
  • 556FE5A0-86A3-4910-BB44-5957D73388E2
  • ACT
Suggest Edits

GroupMember

 

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

Create Token

Suggest Edits

Returns a list of GroupMember

Returns a list containing a collection of GroupMember

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember
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/GroupMember");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember");
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 a GroupMember

Creates an instance of GroupMember

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember
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/GroupMember");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember");
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.Membership.DataContracts.GroupMemberData, Asi.Contracts"

DropDate
date-time

Gets or sets the drop date.

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.

GroupMemberId
string

Gets or sets the group member Id.

IsActive
boolean

Gets or sets the is active indicator.

JoinDate
date-time

Gets or sets the join date.

MembershipDetails
array of objects

A collection of groupmemberdetaildata.

$type
EffectiveDate
ExpirationDate
GroupMemberDetailId
IsActive
IsMarkedForDelete
Note
NumberOfUnits 
ReciprocalRole 
Role 
Stage 
Title
Party
object

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

 
Party.$type
string

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

Party.CityName
string

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

Party.CountryName
string

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

Party.CountrySubEntityName
string

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

Party.Email
string

Gets or sets the primary email.

Party.Id
string

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

Party.ImageVirtualPath
string

Gets or sets the image virtual path.

Party.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Party.Name
string

Gets or sets the name of the party.

Party.PartyId
string

Gets or sets the party Id.

Party.Phone
string

Gets or sets the primary phone.

Party.Sort
string

Gets or sets the sort string.

Party.Status
object

Party status.

 
Party.Status.$type
string

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

Party.Status.ActiveStatus
string

Party active status enumeration.

Party.Status.Description
string

Gets or sets the description.

Party.Status.Name
string

Gets or sets the name.

Party.Status.PartyStatusId
string

Gets or sets the party status id.

Party.UniformId
string

Gets or sets the uniform identifier.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Returns a GroupMember by id

Returns an instance of GroupMember by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember/GroupMemberId
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/GroupMember/GroupMemberId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember/GroupMemberId");
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

GroupMemberId
string
required

Id of GroupMember to be Returned

Response

The request was successful.

GroupMemberId Example

  • 121B2DF0-406C-4821-9DFC-A4E433A1035B
  • 3YEAR:18542
  • ACT:117
Suggest Edits

Updates a GroupMember by id

Updates an instance of GroupMember by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember/GroupMemberId
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/GroupMember/GroupMemberId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMember/GroupMemberId");
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

GroupMemberId
string
required

Id of GroupMember to be Updated

Body Params

$type
string

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

DropDate
date-time

Gets or sets the drop date.

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.

GroupMemberId
string

Gets or sets the group member Id.

IsActive
boolean

Gets or sets the is active indicator.

JoinDate
date-time

Gets or sets the join date.

MembershipDetails
array of objects

A collection of groupmemberdetaildata.

$type
EffectiveDate
ExpirationDate
GroupMemberDetailId
IsActive
IsMarkedForDelete
Note
NumberOfUnits 
ReciprocalRole 
Role 
Stage 
Title
Party
object

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

 
Party.$type
string

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

Party.CityName
string

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

Party.CountryName
string

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

Party.CountrySubEntityName
string

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

Party.Email
string

Gets or sets the primary email.

Party.Id
string

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

Party.ImageVirtualPath
string

Gets or sets the image virtual path.

Party.IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Party.Name
string

Gets or sets the name of the party.

Party.PartyId
string

Gets or sets the party Id.

Party.Phone
string

Gets or sets the primary phone.

Party.Sort
string

Gets or sets the sort string.

Party.Status
object

Party status.

 
Party.Status.$type
string

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

Party.Status.ActiveStatus
string

Party active status enumeration.

Party.Status.Description
string

Gets or sets the description.

Party.Status.Name
string

Gets or sets the name.

Party.Status.PartyStatusId
string

Gets or sets the party status id.

Party.UniformId
string

Gets or sets the uniform identifier.

Response

The request was successful.

Suggest Edits

GroupMemberSummary

 
Suggest Edits

Returns a list of GroupMemberSummary

Returns a list containing a collection of GroupMemberSummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMemberSummary
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/GroupMemberSummary");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMemberSummary");
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 GroupMemberSummary by id

Returns an instance of GroupMemberSummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMemberSummary/GroupMemberSummaryId
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/GroupMemberSummary/GroupMemberSummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupMemberSummary/GroupMemberSummaryId");
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

GroupMemberSummaryId
string
required

Id of GroupMemberSummary to be Returned

Response

The request was successful.

GroupMemberSummaryId (GroupMemberId) Examples

  • ASSOC:18928
  • ASSOC:20804
  • 121B2DF0-406C-4821-9DFC-A4E433A1035B
Suggest Edits

GroupSummary

 
Suggest Edits

Returns a list of GroupSummary

Returns a list containing a collection of GroupSummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupSummary
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/GroupSummary");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupSummary");
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 GroupSummary by id

Returns an instance of GroupSummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupSummary/GroupSummaryId
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/GroupSummary/GroupSummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/GroupSummary/GroupSummaryId");
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

GroupSummaryId
string
required

Id of GroupSummary to be Returned

Response

The request was successful.

GroupSummaryId (GroupId) Examples

  • AA72EF89-FEA6-458E-BB0F-5826044587D0
  • ASSOC
  • AVAIL_CREDIT
Suggest Edits

Returns a list of Party

Returns a list containing a collection of Party

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party
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/Party");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party");
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 a Party

Creates an instance of Party

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party
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/Party");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party");
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.Membership.DataContracts.PersonData, Asi.Contracts","Asi.Soa.Membership.DataContracts.OrganizationData, Asi.Contracts","Asi.Soa.Membership.DataContracts.ComboPartyData, Asi.Contracts"

Addresses
array of objects

A collection of full addresses.

$type
AdditionalLines
Address 
AddresseeText
AddressPurpose
BadAddress
CommunicationPreferences
DisplayName
DisplayOrganizationName
DisplayOrganizationTitle
Email
Fax
FullAddressId
IsAddresseeOverridden
IsMarkedForDelete
Note
Phone
Salutation 
Status 
AlternateIds
array of objects

A collection of alternate ids.

$type
AlternateIdId
Id
IdType
IsMarkedForDelete
CityName
string

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

CommunicationTypePreferences
array of objects

Collection of links to party's communicationtypepreference entries.

$type
CommunicationTypeId
OptInFlag
PartyCommunicationTypePreferenceId
CountryName
string

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

CountrySubEntityName
string

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

Email
string

Gets or sets the primary email.

Emails
array of objects

Collection of email addresses.

$type
Address
EmailType
IsPrimary
FinancialInformation
object

Financial information.

 
FinancialInformation.$type
string

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

FinancialInformation.BillToPartyId
string

Gets or sets the bill to party Id.

FinancialInformation.CreditLimit
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
FinancialInformation.CreditLimit.$type
string

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

FinancialInformation.CreditLimit.Amount
object

Gets or sets the amount.

 
FinancialInformation.CreditLimit.Currency
object

Currency (value type).

 
FinancialInformation.CreditLimit.Currency.$type
string

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

FinancialInformation.CreditLimit.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

FinancialInformation.CreditLimit.Currency.DecimalPositions
int32

Gets the decimal positions.

FinancialInformation.CreditLimit.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

FinancialInformation.DonorReceiptPreference
string

Receipt preference

FinancialInformation.GiftAidInformation
array of objects

Collection of gift aid declarations.

$type
Cancelled
ConfirmationLetterSent
DeclarationReceived
GiftAidDeclarationId
IsOngoing
IsPast
MethodOfDeclaration
OneOffOrderLineKey 
Status
FinancialInformation.PaymentTermsId
string

Gets or sets the default payment terms.

FinancialInformation.TaxAuthority
string

Gets or sets the tax authority.

FinancialInformation.TaxExemptionNumber
string

Gets or sets the tax exemption number.

FinancialInformation.VatInformation
object

Vat information.

 
FinancialInformation.VatInformation.$type
string

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

FinancialInformation.VatInformation.Country
string

Gets or sets the VAT country.

FinancialInformation.VatInformation.IsExempt
boolean

Gets or sets a value indicating whether this instance is VAT exempt.

FinancialInformation.VatInformation.RegistrationNumber
string

Gets or sets the VAT registration number.

Id
string

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

ImageVirtualPath
string

Gets or sets the image virtual path.

IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Name
string

Gets or sets the name of the party.

PartyId
string

Gets or sets the party Id.

Phone
string

Gets or sets the primary phone.

Phones
array of objects

Collection of phone numbers.

$type
IsPrimary
Number
PhoneType
Salutations
array of objects

A collection of salutations.

$type
IsMarkedForDelete
IsOverridden
SalutationId
SalutationMethod 
Text
SocialNetworks
array of objects

Collection of links to party's social network profiles.

$type
PartySocialNetworkId
SocialNetwork 
SocialNetworkProfileLinkURL
SocialNetworkToken
SocialNetworkUserId
SocialNetworkUserName
UseSocialNetworkProfilePhoto
Sort
string

Gets or sets the sort string.

SortIsOverridden
boolean

Gets or sets the sort is overridden indicator.

Status
object

Party status.

 
Status.$type
string

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

Status.ActiveStatus
string

Party active status enumeration.

Status.Description
string

Gets or sets the description.

Status.Name
string

Gets or sets the name.

Status.PartyStatusId
string

Gets or sets the party status id.

UniformId
string

Gets or sets the uniform identifier.

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.

WebsiteUrl
string

Gets or sets the website URI/URL.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes a Party by id

Removes an instance of Party by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party/PartyId
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/Party/PartyId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party/PartyId");
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

PartyId
string
required

Id of Party to be Removed

Response

The request was successful.

Suggest Edits

Returns a Party by id

Returns an instance of Party by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party/PartyId
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/Party/PartyId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party/PartyId");
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

PartyId
string
required

Id of Party to be Returned

Response

The request was successful.

PartyId Examples

  • 19734
  • 21810
  • 18051
Suggest Edits

Updates a Party by id

Updates an instance of Party by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party/PartyId
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/Party/PartyId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/Party/PartyId");
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

PartyId
string
required

Id of Party to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Membership.DataContracts.PersonData, Asi.Contracts","Asi.Soa.Membership.DataContracts.OrganizationData, Asi.Contracts","Asi.Soa.Membership.DataContracts.ComboPartyData, Asi.Contracts"

Addresses
array of objects

A collection of full addresses.

$type
AdditionalLines
Address 
AddresseeText
AddressPurpose
BadAddress
CommunicationPreferences
DisplayName
DisplayOrganizationName
DisplayOrganizationTitle
Email
Fax
FullAddressId
IsAddresseeOverridden
IsMarkedForDelete
Note
Phone
Salutation 
Status 
AlternateIds
array of objects

A collection of alternate ids.

$type
AlternateIdId
Id
IdType
IsMarkedForDelete
CityName
string

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

CommunicationTypePreferences
array of objects

Collection of links to party's communicationtypepreference entries.

$type
CommunicationTypeId
OptInFlag
PartyCommunicationTypePreferenceId
CountryName
string

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

CountrySubEntityName
string

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

Email
string

Gets or sets the primary email.

Emails
array of objects

Collection of email addresses.

$type
Address
EmailType
IsPrimary
FinancialInformation
object

Financial information.

 
FinancialInformation.$type
string

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

FinancialInformation.BillToPartyId
string

Gets or sets the bill to party Id.

FinancialInformation.CreditLimit
object

Monetary amount datacontract (value type). Though we do not usually site business logic in a data contract, we make an exception here as monetaryamountdata and culturedata are extensively used for any monetary amount.

 
FinancialInformation.CreditLimit.$type
string

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

FinancialInformation.CreditLimit.Amount
object

Gets or sets the amount.

 
FinancialInformation.CreditLimit.Currency
object

Currency (value type).

 
FinancialInformation.CreditLimit.Currency.$type
string

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

FinancialInformation.CreditLimit.Currency.CurrencyCode
string

Gets or sets the type of the currency (USD, etc).

FinancialInformation.CreditLimit.Currency.DecimalPositions
int32

Gets the decimal positions.

FinancialInformation.CreditLimit.IsAmountDefined
boolean

Gets or sets an indication of whether this instance of represents a defined monetary amount.

FinancialInformation.DonorReceiptPreference
string

Receipt preference

FinancialInformation.GiftAidInformation
array of objects

Collection of gift aid declarations.

$type
Cancelled
ConfirmationLetterSent
DeclarationReceived
GiftAidDeclarationId
IsOngoing
IsPast
MethodOfDeclaration
OneOffOrderLineKey 
Status
FinancialInformation.PaymentTermsId
string

Gets or sets the default payment terms.

FinancialInformation.TaxAuthority
string

Gets or sets the tax authority.

FinancialInformation.TaxExemptionNumber
string

Gets or sets the tax exemption number.

FinancialInformation.VatInformation
object

Vat information.

 
FinancialInformation.VatInformation.$type
string

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

FinancialInformation.VatInformation.Country
string

Gets or sets the VAT country.

FinancialInformation.VatInformation.IsExempt
boolean

Gets or sets a value indicating whether this instance is VAT exempt.

FinancialInformation.VatInformation.RegistrationNumber
string

Gets or sets the VAT registration number.

Id
string

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

ImageVirtualPath
string

Gets or sets the image virtual path.

IsMarkedForDelete
boolean

Gets or sets the marked for delete.

Name
string

Gets or sets the name of the party.

PartyId
string

Gets or sets the party Id.

Phone
string

Gets or sets the primary phone.

Phones
array of objects

Collection of phone numbers.

$type
IsPrimary
Number
PhoneType
Salutations
array of objects

A collection of salutations.

$type
IsMarkedForDelete
IsOverridden
SalutationId
SalutationMethod 
Text
SocialNetworks
array of objects

Collection of links to party's social network profiles.

$type
PartySocialNetworkId
SocialNetwork 
SocialNetworkProfileLinkURL
SocialNetworkToken
SocialNetworkUserId
SocialNetworkUserName
UseSocialNetworkProfilePhoto
Sort
string

Gets or sets the sort string.

SortIsOverridden
boolean

Gets or sets the sort is overridden indicator.

Status
object

Party status.

 
Status.$type
string

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

Status.ActiveStatus
string

Party active status enumeration.

Status.Description
string

Gets or sets the description.

Status.Name
string

Gets or sets the name.

Status.PartyStatusId
string

Gets or sets the party status id.

UniformId
string

Gets or sets the uniform identifier.

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.

WebsiteUrl
string

Gets or sets the website URI/URL.

Response

The request was successful.

Suggest Edits

PartyImage

 
Suggest Edits

Returns a list of PartyImage

Returns a list containing a collection of PartyImage

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage
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/PartyImage");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage");
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 a PartyImage

Creates an instance of PartyImage

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage
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/PartyImage");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage");
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.Membership.DataContracts.PartyImageData, Asi.Contracts"

Description
string

Gets or sets the image description.

Image
object

Gets or sets the image.

 
IsPreferred
boolean

Gets or sets the is preferred indicator.

PartyId
string

Gets or sets the party id.

PartyImageId
string

Gets or sets the party image id.

Purpose
string

Gets or sets the purpose.

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.

VirtualFile
object

Class virtualfiledata.

 
VirtualFile.$type
string

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

VirtualFile.AlternateText
string

Gets or sets the alternate text.

VirtualFile.Description
string

Gets or sets the description.

VirtualFile.IsDefault
boolean

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

VirtualFile.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

VirtualFile.VirtualPath
string

Gets or sets the image virtual path.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes a PartyImage by id

Removes an instance of PartyImage by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage/PartyImageId
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/PartyImage/PartyImageId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage/PartyImageId");
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

PartyImageId
string
required

Id of PartyImage to be Removed

Response

The request was successful.

Suggest Edits

Returns a PartyImage by id

Returns an instance of PartyImage by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage/PartyImageId
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/PartyImage/PartyImageId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage/PartyImageId");
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

PartyImageId
string
required

Id of PartyImage to be Returned

Response

The request was successful.

PartyImageId Examples

  • 2
  • 24
  • 392
Suggest Edits

Updates a PartyImage by id

Updates an instance of PartyImage by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage/PartyImageId
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/PartyImage/PartyImageId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyImage/PartyImageId");
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

PartyImageId
string
required

Id of PartyImage to be Updated

Body Params

$type
string

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

Description
string

Gets or sets the image description.

Image
object

Gets or sets the image.

 
IsPreferred
boolean

Gets or sets the is preferred indicator.

PartyId
string

Gets or sets the party id.

PartyImageId
string

Gets or sets the party image id.

Purpose
string

Gets or sets the purpose.

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.

VirtualFile
object

Class virtualfiledata.

 
VirtualFile.$type
string

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

VirtualFile.AlternateText
string

Gets or sets the alternate text.

VirtualFile.Description
string

Gets or sets the description.

VirtualFile.IsDefault
boolean

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

VirtualFile.ThumbnailVirtualPath
string

Gets or sets the thumbnail image virtual path.

VirtualFile.VirtualPath
string

Gets or sets the image virtual path.

Response

The request was successful.

Suggest Edits

PartyNote

 
Suggest Edits

Returns a list of PartyNote

Returns a list containing a collection of PartyNote

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote
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/PartyNote");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote");
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 a PartyNote

Creates an instance of PartyNote

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote
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/PartyNote");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote");
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.Membership.DataContracts.PartyNoteData, Asi.Contracts"

PartyId
string

Gets or sets the party Id.

PartyNoteId
string

Gets or sets the party note Id.

Purpose
string

Gets or sets the purpose.

Text
string

Gets or sets the text or note.

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.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes a PartyNote by id

Removes an instance of PartyNote by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote/PartyNoteId
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/PartyNote/PartyNoteId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote/PartyNoteId");
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

PartyNoteId
string
required

Id of PartyNote to be Removed

Response

The request was successful.

Suggest Edits

Returns a PartyNote by id

Returns an instance of PartyNote by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote/PartyNoteId
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/PartyNote/PartyNoteId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote/PartyNoteId");
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

PartyNoteId
string
required

Id of PartyNote to be Returned

Response

The request was successful.

PartyNoteId Examples

  • 1
  • 2
  • 3
Suggest Edits

Updates a PartyNote by id

Updates an instance of PartyNote by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote/PartyNoteId
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/PartyNote/PartyNoteId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartyNote/PartyNoteId");
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

PartyNoteId
string
required

Id of PartyNote to be Updated

Body Params

$type
string

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

PartyId
string

Gets or sets the party Id.

PartyNoteId
string

Gets or sets the party note Id.

Purpose
string

Gets or sets the purpose.

Text
string

Gets or sets the text or note.

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.

Response

The request was successful.

Suggest Edits

PartySummary

 
Suggest Edits

Returns a list of PartySummary

Returns a list containing a collection of PartySummary

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartySummary
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/PartySummary");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartySummary");
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 PartySummary by id

Returns an instance of PartySummary by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartySummary/PartySummaryId
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/PartySummary/PartySummaryId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/PartySummary/PartySummaryId");
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

PartySummaryId
string
required

Id of PartySummary to be Returned

Response

The request was successful.

PartySummaryId (PartyId) Examples

  • 19755
  • 18677
  • 18916
Suggest Edits

SocialNetwork

 
Suggest Edits

Returns a list of SocialNetwork

Returns a list containing a collection of SocialNetwork

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/SocialNetwork
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/SocialNetwork");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/SocialNetwork");
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 SocialNetwork by id

Returns an instance of SocialNetwork by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/SocialNetwork/SocialNetworkId
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/SocialNetwork/SocialNetworkId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/SocialNetwork/SocialNetworkId");
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

SocialNetworkId
string
required

Id of SocialNetwork to be Returned

Response

The request was successful.

SocialNetworkId Examples

  • 83678141-860b-4093-a58e-c9cb6db459db
  • 359b00d6-49df-4f13-9905-7cf5f949ba80
  • 7373766e-102b-434f-86e3-b172a81c2aed
Suggest Edits

Returns a list of User

Returns a list containing a collection of User

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/User
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/User");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/User");
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 User by id

Returns an instance of User by id

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/User/UserId
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/User/UserId");

xhr.send(data);
var client = new RestClient("https://testapi.imis.com/Asi.Scheduler_SDKDemo/api/User/UserId");
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

UserId
string
required

Id of User to be Returned

Response

The request was successful.

UserId Examples

  • 100
  • 216
  • 214