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

Appeals, Campaigns, Solicitations

 

Communications relates to marketing campaigns, appeals, and solicitations.

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

Create Token

Suggest Edits

AppealSummary

 
Suggest Edits

Returns a list of AppealSummary

Returns a list containing a collection of AppealSummary

 

OAuth2 Auth

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

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

Creates an instance of AppealSummary

 

OAuth2 Auth

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

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

AppealId
string

Gets or sets the appeal id.

CampaignId
string

Gets or sets the campaign id.

Description
string

Gets or sets the description.

Name
string

Gets or sets the name.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Returns an AppealSummary by id

Returns an instance of AppealSummary by id

 

OAuth2 Auth

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

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

AppealSummaryId
string
required

Id of AppealSummary to be Returned

Response

The request was successful.

AppealSummaryId (AppealId) Examples

  • 42078237-b69a-487b-830d-11f13b5d0902
  • dc683b18-df3f-4ac3-bdea-4f314e39b213
Suggest Edits

CampaignSummary

 
Suggest Edits

Returns a list of CampaignSummary

Returns a list containing a collection of CampaignSummary

 

OAuth2 Auth

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

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

Creates an instance of CampaignSummary

 

OAuth2 Auth

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

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

CampaignCode
string

Gets or sets the CampaignCode.

CampaignId
string

Gets or sets the campaign id.

Description
string

Gets or sets the description.

Name
string

Gets or sets the name.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes a CampaignSummary by id

Removes an instance of CampaignSummary by id

 

OAuth2 Auth

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

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

CampaignSummaryId
string
required

Id of CampaignSummary to be Removed

Response

The request was successful.

Delete Campaign

Only Campaigns without appeals can be deleted.

Suggest Edits

Returns a CampaignSummary by id

Returns an instance of CampaignSummary by id

 

OAuth2 Auth

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

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

CampaignSummaryId
string
required

Id of CampaignSummary to be Returned

Response

The request was successful.

CampaignSummaryId (CampaignId) Example

  • 7a88d939-ceef-4d0a-b595-9abd817acc84
Suggest Edits

Communication

 
Suggest Edits

Returns a Communication

Returns a list or single record of Communication

 

OAuth2 Auth

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

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

DocumentVersionKey
string

The DocumentId for the communication.

Path
string

The Path for the communication or folder that contains communications.

Response

The request was successful.

Suggest Edits

Creates a Communication

Creates an instance of Communication

 

OAuth2 Auth

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

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

AlternateName
string

Gets or sets the name of the alternate.

DataSources
object

Communication data source.

 
DataSources.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationDataSourcesData, Asi.Contracts"

DataSources.DataSources
array of objects

Class communication secondary data source collection

$type
DataSourceId
Description
string

Gets or sets the description.

DocumentId
string

Gets or sets the document Id.

DocumentTypeId
string

Gets or sets the type of the document.

DocumentVersionId
string

Gets or sets the document version identifier.

IsFolder
boolean

Gets a value indicating whether this instance is folder.

IsSystem
boolean

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

Name
string

Gets or sets the name.

Options
object

Class communication options

 
Options.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationOptionsData, Asi.Contracts"

Options.AdvancedEmail
boolean

Gets or sets whether this is to be routed via advanced email service.

Options.AutoMatchReportParameter
boolean

Gets or sets whether to automatically match IQA result columns to parameters for any reports attached to the communication.

Options.CommunicationType
object

Class that specifies a communication type.

 
Options.CommunicationType.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationTypeData, Asi.Contracts"

Options.CommunicationType.CannotOptOut
boolean

Gets or sets the cannot opt out.

Options.CommunicationType.CommunicationTypeDisplay
string

Gets or sets the communication type display description.

Options.CommunicationType.CommunicationTypeId
string

Gets or sets the communication type id.

Options.CommunicationType.DefaultOptOut
boolean

Gets or sets the opt out.

Options.CommunicationType.Formula
string

Gets or sets the formula.

Options.CommunicationType.IsDefaultType
boolean

Gets or sets the is default type.

Options.CommunicationType.IsSolicitation
boolean

Gets or sets the is solicitation.

Options.CommunicationType.IsSystem
boolean

Gets or sets the is system.

Options.CommunicationType.ReasonCode
string

Gets or sets the communication reason code.

Options.CommunicationType.Status
boolean

Gets or sets the status.

Options.Exclusions
object

Class to identify rows in a data source

 
Options.Exclusions.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationSelectionData, Asi.Contracts"

Options.Exclusions.Properties
array of strings

Gets or sets the property name(s) against which selections are tested in the datasource.

Options.Exclusions.Values
array of strings

Gets or sets the collection of values which will be tested against in the datasource. Where contains multiple properties, each value should be a : delimited composite.

Options.MaxPrimaryInput
int32

Gets or sets the max primary input.

Options.Parameters
array of objects

A collection of generic properties.

$type
Name
Value 
Options.PreviewOnly
boolean

Gets or sets the preview only.

Options.PreviewPager
object

Pager. The pager class is used to control the amount of data to return for operations that could return large amounts of data.

 
Options.PreviewPager.$type
string

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

Options.PreviewPager.HasNext
boolean

Does the returned result contains more rows to be retrieved?

Options.PreviewPager.HasPrevious
boolean

Does the returned result contains previous items ?

Options.PreviewPager.PageCount
int32

Gets or sets the page count.

Options.PreviewPager.PageNumber
int32

Gets or sets the page number.

Options.PreviewPager.PageSize
int32

Gets or sets the size of the page.

Options.PreviewPager.TotalRowCount
int32

Gets or sets the total rows available.

OutputSteps
array of objects

Class communication output step collection

$type
MessageTemplate 
OutputMethod 
RunOnce
Path
string

Gets or sets the path.

Status
string

Gets or sets the status.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Removes a Communication by id

Removes an instance of Communication by id

 

OAuth2 Auth

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

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

CommunicationId
string
required

Id of Communication to be Removed

Response

The request was successful.

Suggest Edits

Returns a Communication by id

Returns an instance of Communication by id

 

OAuth2 Auth

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

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

CommunicationId
string
required

Id of Communication to be Returned

Response

The request was successful.

CommunicationId (DocumentId) Examples

  • 1a44ad14-8fb3-4b29-a8e8-9b553b22bb39
  • 23405203-3bff-4f77-a13e-c1760e3410dd
  • 3fca647f-a5a0-48a0-b8a2-7288788b7665
Suggest Edits

Updates a Communication by id

Updates an instance of Communication by id

 

OAuth2 Auth

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

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

CommunicationId
string
required

Id of Communication to be Updated

Body Params

$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationData, Asi.Contracts"

AlternateName
string

Gets or sets the name of the alternate.

DataSources
object

Communication data source.

 
DataSources.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationDataSourcesData, Asi.Contracts"

DataSources.DataSources
array of objects

Class communication secondary data source collection

$type
DataSourceId
Description
string

Gets or sets the description.

DocumentId
string

Gets or sets the document Id.

DocumentTypeId
string

Gets or sets the type of the document.

DocumentVersionId
string

Gets or sets the document version identifier.

IsFolder
boolean

Gets a value indicating whether this instance is folder.

IsSystem
boolean

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

Name
string

Gets or sets the name.

Options
object

Class communication options

 
Options.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationOptionsData, Asi.Contracts"

Options.AdvancedEmail
boolean

Gets or sets whether this is to be routed via advanced email service.

Options.AutoMatchReportParameter
boolean

Gets or sets whether to automatically match IQA result columns to parameters for any reports attached to the communication.

Options.CommunicationType
object

Class that specifies a communication type.

 
Options.CommunicationType.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationTypeData, Asi.Contracts"

Options.CommunicationType.CannotOptOut
boolean

Gets or sets the cannot opt out.

Options.CommunicationType.CommunicationTypeDisplay
string

Gets or sets the communication type display description.

Options.CommunicationType.CommunicationTypeId
string

Gets or sets the communication type id.

Options.CommunicationType.DefaultOptOut
boolean

Gets or sets the opt out.

Options.CommunicationType.Formula
string

Gets or sets the formula.

Options.CommunicationType.IsDefaultType
boolean

Gets or sets the is default type.

Options.CommunicationType.IsSolicitation
boolean

Gets or sets the is solicitation.

Options.CommunicationType.IsSystem
boolean

Gets or sets the is system.

Options.CommunicationType.ReasonCode
string

Gets or sets the communication reason code.

Options.CommunicationType.Status
boolean

Gets or sets the status.

Options.Exclusions
object

Class to identify rows in a data source

 
Options.Exclusions.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.CommunicationSelectionData, Asi.Contracts"

Options.Exclusions.Properties
array of strings

Gets or sets the property name(s) against which selections are tested in the datasource.

Options.Exclusions.Values
array of strings

Gets or sets the collection of values which will be tested against in the datasource. Where contains multiple properties, each value should be a : delimited composite.

Options.MaxPrimaryInput
int32

Gets or sets the max primary input.

Options.Parameters
array of objects

A collection of generic properties.

$type
Name
Value 
Options.PreviewOnly
boolean

Gets or sets the preview only.

Options.PreviewPager
object

Pager. The pager class is used to control the amount of data to return for operations that could return large amounts of data.

 
Options.PreviewPager.$type
string

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

Options.PreviewPager.HasNext
boolean

Does the returned result contains more rows to be retrieved?

Options.PreviewPager.HasPrevious
boolean

Does the returned result contains previous items ?

Options.PreviewPager.PageCount
int32

Gets or sets the page count.

Options.PreviewPager.PageNumber
int32

Gets or sets the page number.

Options.PreviewPager.PageSize
int32

Gets or sets the size of the page.

Options.PreviewPager.TotalRowCount
int32

Gets or sets the total rows available.

OutputSteps
array of objects

Class communication output step collection

$type
MessageTemplate 
OutputMethod 
RunOnce
Path
string

Gets or sets the path.

Status
string

Gets or sets the status.

Response

The request was successful.

Suggest Edits

FormDefinition

 
Suggest Edits

Returns a list of FormDefinition

Returns a list containing a collection of FormDefinition

 

OAuth2 Auth

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

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

Creates an instance of FormDefinition

 

OAuth2 Auth

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

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

Description
string

Gets or sets the description.

FormDefinitionId
string

Gets or sets the form definition id.

Name
string

Gets or sets the name.

OwnerSystem
string

Gets or sets the owner system.

ResponseEntityTypeName
string

Gets or sets the name of the response entity type.

Sections
array of objects

Form definition section collection

$type
Description
Fields
FormDefinitionSectionId
Name
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 FormDefinition by id

Removes an instance of FormDefinition by id

 

OAuth2 Auth

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

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

FormDefinitionId
string
required

Id of FormDefinition to be Removed

Response

The request was successful.

Suggest Edits

Returns a FormDefinition by id

Returns an instance of FormDefinition by id

 

OAuth2 Auth

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

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

FormDefinitionId
string
required

Id of FormDefinition to be Returned

Response

The request was successful.

FormDefinitionId Examples

  • a2523b89-b90f-4a73-9165-eceb865a38e5
  • c0c9e4d5-6dbc-4756-8539-f06be55089a6
  • 54996a21-2cca-4ad2-bb19-f58b7276854b
 
Suggest Edits

Creates a Message

Creates an instance of Message

 

OAuth2 Auth

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

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

Attachments
array of objects

Attachment collection

$type
Attachment 
AttachmentId
ContentType
Name
BlindCopyTo
array of objects

Message address collection.

$type
Address
Name
CopyTo
array of objects

Message address collection.

$type
Address
Name
From
object

Message address

 
From.$type
string

The DataType must be "Asi.Soa.Communications.DataContracts.MessageAddressData, Asi.Contracts"

From.Address
string

Gets or sets the address.

From.Name
string

Gets or sets the name of the address (optional).

IsHtml
boolean

Gets or sets a value indicating whether this instance is HTML.

MessageId
string

Gets or sets the message id.

MessageType
string

Message type.

Subject
string

Gets or sets the Email's subject.

Text
string

Gets or sets the Email's text.

To
array of objects

Message address collection.

$type
Address
Name

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

SolicitationSummary

 
Suggest Edits

Returns a list of SolicitationSummary

Returns a list containing a collection of SolicitationSummary

 

OAuth2 Auth

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

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

Creates an instance of SolicitationSummary

 

OAuth2 Auth

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

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

AppealId
string

Gets or sets the appeal id.

Description
string

Gets or sets the description.

Name
string

Gets or sets the name.

SolicitationId
string

Gets or sets the solicitation id.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Returns a SolicitationSummary by id

Returns an instance of SolicitationSummary by id

 

OAuth2 Auth

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

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

SolicitationSummaryId
string
required

Id of SolicitationSummary to be Returned

Response

The request was successful.

SolicitationSummaryId (SolicitationId) Examples

  • 2ea8be30-cae2-4f11-8617-6277675f898c
  • 989f1fc2-60fd-4f20-bff5-7a1a2494f3ab
  • 73845408-906b-444b-a867-dd4c1aa18251
Suggest Edits

SourceCodeSummary

 
Suggest Edits

Returns a list of SourceCodeSummary

Returns a list containing a collection of SourceCodeSummary

 

OAuth2 Auth

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

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

Creates an instance of SourceCodeSummary

 

OAuth2 Auth

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

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

Code
string

Gets or sets the code.

Description
string

Gets or sets the description.

Name
string

Gets or sets the name.

SolicitationId
string

Gets or sets the solicitation id.

SourceCodeId
string

Gets or sets the source code id.

Response

The request was successful.

The resource was successfully created.

The resource was asynchronously created.

Suggest Edits

Returns a SourceCodeSummary by id

Returns an instance of SourceCodeSummary by id

 

OAuth2 Auth

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

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

SourceCodeSummaryId
string
required

Id of SourceCodeSummary to be Returned

Response

The request was successful.

SourceCodeSummaryId (SourceCodeId) Examples

  • 6d0e02b0-99f9-4a45-84ec-1665155b7d70
  • 33e1f11e-8e01-4721-b2e2-4492d9031c46
  • 9103e866-95d5-45c7-89f8-65a40a595395