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

Find party using filter

Find party using filter operator

 
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/party
jQuery.ajax("https://myserver.com/api/party?lastname=eq:smith", {
   type: "GET", 
   contentType: "application/json", 
   headers: {"RequestVerificationToken": document.getElementById("__RequestVerificationToken").value}, 
   success: function(data){console.log(data);}
})
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

lastname
string

Example: "eq:smith"

 

Search filters are entered into the querystring.

Filter Names:

Note

This list is incomplete. As more search filters are discovered, they will be added to this list.

  • firstName
  • lastName
  • email
  • cityName
  • countrySubEntityName (State / Province)
  • updatedOn (Does not always appear to filter correctly)
  • createdOn

Data Types:

  • string: URL encode, pass as-is
    • Example: ?filter=hello%20,world
  • number: Pass as-is
    • Example: ?filter=4
  • date: Pass in IS08601 format
    • Example: ?filter=2017-06-25
  • boolean: Use isTrue: and isFalse: filters
    • Example: ?filter=isTrue:

Operator Names:

  • between (usage: ?filter=between:item1|item2, items separated by a |)
  • contains
  • endsWith
  • equal, eq, or ==
  • greaterThan, gt, or >
  • greaterThanOrEqual, ge, or >=
  • in (usage: ?filter=in:item1|item2|item3|..., items separated by a |)
  • isEmpty, empty (usage: ?filter=isEmpty:, no parameter after :)
  • isFalse, false (usage: ?filter=isFalse:, no parameter after :)
  • isTrue, true (usage: ?filter=isTrue:, no parameter after :)
  • lessThan, lt, <
  • lessThanOrEqual, le, <=
  • notContain, !contain
  • notEmpty, !empty
  • notEqual, ne, !=
  • startsWith
Suggest Edits

DataContract single

Get a single record from a data contract

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/datacontract/id
jQuery.ajax("https://myserver.com/api/country/AF", {
	type : "GET",  
	contentType: "application/json", 
	headers: {"RequestVerificationToken": document.getElementById("__RequestVerificationToken").value}, 
	success: function(data){console.log(data);}
})

A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

datacontract
string
required

Party, Order, Event, Country etc.

id
string
required

Party Id, Order Id, Event Code, Country Code (US, AF, CA)

 

Tip: Multiple Primary Keys

:bulb+: If a data contract has multiple primary keys / identity elements defined, the syntax for querying a single record from that contract is:

/api/contractName/~key1|key2

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

Create Token

Suggest Edits

DataContract multiple

Get a list of records from a data contract

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/datacontract
jQuery.ajax("https://myserver.com/api/country", {
	type : "GET", 
	contentType: "application/json", 
	headers: {"RequestVerificationToken": document.getElementById("__RequestVerificationToken").value}, 
	success: function(data){console.log(data);}
})

A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

datacontract
string
required

Party, Order, Event, Country etc.

 
Suggest Edits

DataContract delete record

Delete a single record from a data contract

 
deletehttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/datacontract/id
jQuery.ajax("https://myserver.com/api/country/AF", {
	type : "DELETE", 
	contentType: "application/json", 
	headers: {"RequestVerificationToken": document.getElementById("__RequestVerificationToken").value}, 
	success: function(data){console.log(data);}
})

A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

datacontract
string
required

Party, Order, Event, Country etc.

id
string
required

Party Id, Order Id, Event Code, Country Code (US, AQ, CA)

 

Not all available data contracts support deleting

Available Data Contracts