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

Batches, Tags

 

Transaction records are created for the various financial actions, such as membership joins, membership renewals, product purchases, event registrations, open invoice payments, and donations, that take place on your website. iMIS automatically groups these transactions in batches by date.

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

Create Token

Suggest Edits

ImportBatch

 
Suggest Edits

Returns a list of ImportBatch

Returns a list containing a collection of ImportBatch

 

OAuth2 Auth

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

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

Creates an instance of ImportBatch

 

OAuth2 Auth

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

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

Batch
object

Gets or sets the batch.

 
BatchDate
date-time

A user defined date for the batch.

BatchId
string

Gets or sets the batch Id.

BatchStatus
string

Enumerated values of possible import batch statuses.

BatchType
string

The type of batch.

DateCreated
date-time

Gets or sets the date created.

Name
string

Gets or sets the batch name.

Results
string

Text containing the results message following processing of the batch.

UserId
string

The ImisId of the user that created the batch.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes an ImportBatch by id

Removes an instance of ImportBatch by id

 

OAuth2 Auth

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

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

ImportBatchId
string
required

Id of ImportBatch to be Removed

Response

The request was successful.

Suggest Edits

Returns an ImportBatch by id

Returns an instance of ImportBatch by id

 

OAuth2 Auth

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

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

ImportBatchId
string
required

Id of ImportBatch to be Returned

Response

The request was successful.

Suggest Edits

Updates an ImportBatch by id

Updates an instance of ImportBatch by id

 

OAuth2 Auth

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

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

ImportBatchId
string
required

Id of ImportBatch to be Updated

Body Params

$type
string

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

Batch
object

Gets or sets the batch.

 
BatchDate
date-time

A user defined date for the batch.

BatchId
string

Gets or sets the batch Id.

BatchStatus
string

Enumerated values of possible import batch statuses.

BatchType
string

The type of batch.

DateCreated
date-time

Gets or sets the date created.

Name
string

Gets or sets the batch name.

Results
string

Text containing the results message following processing of the batch.

UserId
string

The ImisId of the user that created the batch.

Response

The request was successful.

Suggest Edits

ImportBatchSummary

 
Suggest Edits

Returns a list of ImportBatchSummary

Returns a list containing a collection of ImportBatchSummary

 

OAuth2 Auth

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

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

Removes an instance of ImportBatchSummary by id

 

OAuth2 Auth

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

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

ImportBatchSummaryId
string
required

Id of ImportBatchSummary to be Removed

Response

The request was successful.

Suggest Edits

Returns a list of Tag

Returns a list containing a collection of Tag

 

OAuth2 Auth

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

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

Returns an instance of Tag by id

 

OAuth2 Auth

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

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

TagId
string
required

Id of Tag to be Returned

Response

The request was successful.

TagId Examples

  • 9d6c1f4c-598b-42e0-8ab4-0b0517966677
  • bf5896ad-20cb-4ae1-8ae1-33b623cb4405
  • 7d900831-3391-49a3-bd01-4c362e560fc4