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

Donations, Tributes, Payments

 

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

Create Token

Suggest Edits

DonationCommitment

 
Suggest Edits

Returns a list of DonationCommitment

Returns a list containing a collection of DonationCommitment

 

OAuth2 Auth

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

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

Returns an instance of DonationCommitment by id

 

OAuth2 Auth

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

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

DonationCommitmentId
string
required

Id of DonationCommitment to be Returned

Response

The request was successful.

DonationCommitmentId Example

  • a2afd97e-31ca-43e1-8d43-fc63337105ca
Suggest Edits

Updates a DonationCommitment by id

Updates an instance of DonationCommitment by id

 

OAuth2 Auth

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

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

DonationCommitmentId
string
required

Id of DonationCommitment to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Fundraising.DataContracts.DonationCommitmentData, Asi.Contracts"

Appeal
string

Distribution

BankAccountName
string

Bank Account name for donor

BankAccountNumber
string

Bank account number for donor

BranchSortCode
string

Branch Sort Code for donor

Campaign
string

The linked campaign

CommitmentNotes
string

Commitment Notes

CommitmentStatusInd
string

Commitment Status Indicator

ContactId
string

Contact/Person the Commitment belongs to (the numeric ID, not the guid!)

Distribution
string

Distribution

DonationAmount
object

The commitment amount

 
DonationCommitmentId
string

Id of the Commitment record

EndDate
date-time

Date commitment finishes/finished

FrequencyCode
int32

TODO: link this to the ref table and grab the description.

Fund
string

The linked Fund

MatchReference
string

Match Reference

PaymentMethod
string

PaymentMethod

StartDate
date-time

Date commitment commences

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

ExpectedPayment

 
Suggest Edits

Returns a list of ExpectedPayment

Returns a list containing a collection of ExpectedPayment

 

OAuth2 Auth

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

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

Returns an instance of ExpectedPayment by id

 

OAuth2 Auth

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

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

ExpectedPaymentId
string
required

Id of ExpectedPayment to be Returned

Response

The request was successful.

ExpectedPaymentId Example

  • 722b80b4-d8d6-42e0-8c3f-0fa1b7a69f0a
Suggest Edits

Updates an ExpectedPayment by id

Updates an instance of ExpectedPayment by id

 

OAuth2 Auth

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

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

ExpectedPaymentId
string
required

Id of ExpectedPayment to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Fundraising.DataContracts.ExpectedPaymentData, Asi.Contracts"

Appeal
string

The linked appeal

BankAccountName
string

Bank Account name for donor

BankAccountNumber
string

Bank account number for donor

BranchSortCode
string

Branch Sort Code for donor

Campaign
string

The linked campaign

ContactId
string

Numeric iMIS ID for the contact record associated with the expected payment (linking the expected payment back via the commitment)

Distribution
string

The linked Distribution

DonationAmount
object

The expected amount to be donated

 
ExpectedPaymentId
string

Id of the expected payment detail

ExpectedPaymentSetId
string

The set the expected payment set the detail belongs to

ExpectedPaymentStatus
string

Status of the expected payment detail

Fund
string

The linked Fund

MatchReference
string

The Match reference

Narrative
string

The narrative for the expected payment

PaymentMethod
string

The expected payment method

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

ExpectedPaymentSet

 
Suggest Edits

Returns a list of ExpectedPaymentSet

Returns a list containing a collection of ExpectedPaymentSet

 

OAuth2 Auth

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

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

Creates an instance of ExpectedPaymentSet

 

OAuth2 Auth

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

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

ExpectedPaymentDate
date-time

Date of expected payment - set to start of month

ExpectedPaymentSetId
string

Id of expected payment set

ExpectedPaymentSetStatus
string

Status of the expected payment set

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 an ExpectedPaymentSet by id

Removes an instance of ExpectedPaymentSet by id

 

OAuth2 Auth

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

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

ExpectedPaymentSetId
string
required

Id of ExpectedPaymentSet to be Removed

Response

The request was successful.

Suggest Edits

Returns an ExpectedPaymentSet by id

Returns an instance of ExpectedPaymentSet by id

 

OAuth2 Auth

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

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

ExpectedPaymentSetId
string
required

Id of ExpectedPaymentSet to be Returned

Response

The request was successful.

ExpectedPaymentSetId Example

  • 792dea6f-fc83-4e7f-b3cb-f9905f5d278e
Suggest Edits

Updates an ExpectedPaymentSet by id

Updates an instance of ExpectedPaymentSet by id

 

OAuth2 Auth

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

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

ExpectedPaymentSetId
string
required

Id of ExpectedPaymentSet to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Fundraising.DataContracts.ExpectedPaymentSetData, Asi.Contracts"

ExpectedPaymentDate
date-time

Date of expected payment - set to start of month

ExpectedPaymentSetId
string

Id of expected payment set

ExpectedPaymentSetStatus
string

Status of the expected payment set

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.