These docs are for v20.3.44. Click to read the latest docs for v20.3.186.

Discussions

Ask a Question

What to use to get "function level" registration data?

EventRegistration doesn't seem to return anything related to the functions, or payment or anything other than the basic order number and event/party data. Is there something - other than IQA - to call to return the actual registration data for an ID/event? EventRegistrationSummary does return anything different. Thanks.

REST API POST into Multi-instance data source does always return ordinal = 0

Hi this is a rather annoying issue for multi-instance tables because one cannot get the actual reference from the response. I am not sure if I am missing something obvious. If one post something through the REST API into a multi-instance data source, the ID is returned but not the Ordinal with the actual seqn number. For instance, if I post the below POST /api/ZenGoCardless_BankAccounts HTTP/1.1 Host: imistour832.imiscloud.com Content-Type: application/json Authorization: bearer xxxx cache-control: no-cache Host: imistour832.imiscloud.com { "$type": "Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts", "EntityTypeName": "ZenGoCardless_BankAccounts", "PrimaryParentEntityTypeName": "Party", "Properties": { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts", "$values": [ { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "ID", "Value": "23197000" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "Enabled", "Value": { "$type": "System.Boolean", "$value": true } }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "Currency", "Value": "GBP" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "CreatedAt", "Value": "2019-03-04T12:46:56" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "CountryCode", "Value": "GB" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "BankName", "Value": "HSBC BANK PLC (RFB)" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "AccountNumberEnding", "Value": "90" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "AccountHolderName", "Value": "A KOPETZKY" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "CuId", "Value": "CU0005R16SG151" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "BaId", "Value": "BA0005ESE8H5B9" } ] } } This is returned { "$type": "Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts", "EntityTypeName": "ZenGoCardless_BankAccounts", "PrimaryParentEntityTypeName": "Party", "Identity": { "$type": "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts", "EntityTypeName": "ZenGoCardless_BankAccounts", "IdentityElements": { "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib", "$values": [ "23197000", "0" ] } }, "PrimaryParentIdentity": { "$type": "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts", "EntityTypeName": "Party", "IdentityElements": { "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib", "$values": [ "23197000" ] } }, "Properties": { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts", "$values": [ { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "ID", "Value": "23197000" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "Enabled", "Value": { "$type": "System.Boolean", "$value": true } }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "Currency", "Value": "GBP" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "CreatedAt", "Value": "2019-03-04T12:46:56" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "CountryCode", "Value": "GB" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "BankName", "Value": "HSBC BANK PLC (RFB)" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "AccountNumberEnding", "Value": "90" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "AccountHolderName", "Value": "A KOPETZKY" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "CuId", "Value": "CU0005R16SG151" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "BaId", "Value": "BA0005ESE8H5B9" }, { "$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts", "Name": "Ordinal", "Value": { "$type": "System.Int32", "$value": 0 } } ] } } As you can see the value of the Ordinal is 0. I am working on iMIS Cloud 20.3.46.8757 but this is also an issue in iMIS 2017. Thanks! Alex

SSO OAuth2 module

Once I have retrieved the OAuthH2 token and posted it back to the endpoint, how do I get the user's ID and then the Party object for the logged in user?

Remove a person from an organization

Hi, I am trying to remove someone from an organization, so that no organization is tied to the person, but I have not been able to change, ismarkedfordelete. I don't see a flag for 'IsMarkedForDelete' in membership details, but in Party. I tried changing this flag, but an error happens. If I try adding the flag to MembershipDetails, an error is returned. What do I need to do to remove someone from an org? Here is my get request to see the relationship: jQuery.ajax("https://njcaastaging.imiscloud.com/api/GroupMember/?PartyID=23231&GroupID=ORGRELATIONSHIP-23224", { type: "GET", contentType: "application/json", headers: { "RequestVerificationToken": document.getElementById("__RequestVerificationToken").value } }); Here is what is returned. { "$type": "Asi.Soa.Core.DataContracts.PagedResult1[[Asi.Soa.Membership.DataContracts.GroupMemberData, Asi.Contracts]], Asi.Contracts", "Items": { "$type": "System.Collections.Generic.List1[[Asi.Soa.Membership.DataContracts.GroupMemberData, Asi.Contracts]], mscorlib", "$values": [ { "$type": "Asi.Soa.Membership.DataContracts.GroupMemberData, Asi.Contracts", "MembershipDetails": { "$type": "Asi.Soa.Membership.DataContracts.GroupMemberDetailDataCollection, Asi.Contracts", "$values": [ { "$type": "Asi.Soa.Membership.DataContracts.GroupMemberDetailData, Asi.Contracts", "GroupMemberDetailId": "ORGRELATIONSHIP-23224:23231", "Stage": { "$type": "Asi.Soa.Membership.DataContracts.GroupStageData, Asi.Contracts" }, "IsActive": true, "Role": { "$type": "Asi.Soa.Membership.DataContracts.GroupRoleData, Asi.Contracts", "RoleId": "ORGRELATIONSHIP:MEMBER", "Name": "Member" }, "Title": "" } ] }, "GroupMemberId": "ORGRELATIONSHIP-23224:23231", "Group": { "$type": "Asi.Soa.Membership.DataContracts.GroupSummaryData, Asi.Contracts", "GroupId": "ORGRELATIONSHIP-23224", "Name": "York Test Community College", "Description": "Organizational Relationship", "ParentIdentity": { "$type": "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts", "EntityTypeName": "Party", "IdentityElements": { "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib", "$values": [ "23224" ] } }, "GroupClass": { "$type": "Asi.Soa.Membership.DataContracts.GroupClassSummaryData, Asi.Contracts", "GroupClassId": "ORGRELATIONSHIP", "Name": "Organization", "Description": "" } }, "Party": { "$type": "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts", "CityName": "", "CountryName": "", "CountrySubEntityName": "", "Email": "[email protected]", "Phone": "", "PartyId": "23231", "Id": "23231", "UniformId": "c349c619-587b-4d39-97e7-cf8a0bf7d865", "Status": { "$type": "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts", "PartyStatusId": "A", "Name": "Active", "Description": "Active" }, "Name": "Brian Pitch", "Sort": "PITCH, BRIAN", "IsMarkedForDelete": false }, "IsActive": true } ] }, "Offset": 0, "Limit": 100, "Count": 1, "TotalCount": 1, "NextPageLink": null, "HasNext": false, "NextOffset": 0 }

REST API: Is there an endpoint to mark the attendance for the the person attending an event that has been setup in iMIS?

Hi, I am trying to find a way to mark people as attending when they appear for an event. I am hoping this would be a call where I can pass the event key and the iMIS ID of the person attending the event. The API checks if the person is registered for the current event. If yes, then mark this person as attending which also gives them a credit for attending the event. This needs to work for a cloud hosted version 20.3.44.7858. Any guidance is appreciated.

REST API with pass-through auth - how do I get logged in user's ID or username?

If I'm using the pass-through auth, with the Request Verification Token, what's the best way to get the ID or username for the currently authenticated user? Thanks! Brian

Describing IQAs via REST API with aliased property names?

Is there a way to get the definition of an IQA that includes the aliased Property Names? Calling /api/QueryDefinition/_execute with OperationName = "FindByPath" returns values like: { "$type": "Asi.Soa.Core.DataContracts.QueryPropertyData, Asi.Contracts", "QuerySourceId": "063b404c-460c-420a-b67d-878fe4ffaff8.SR2", "Name": "063b404c-460c-420a-b67d-878fe4ffaff8.CL29", "Caption": "NetContactData.Id", "DisplayFormat": "G", "Link": "", "DataTypeName": "String" } But that property is aliased as "PartyId" and will come back as such when the IQA is called via the API, making it harder to use the IQA as an abstraction layer of defined model but flexible data source.

Registration _validate vs _execute in the documentation

Is there any chance someone can have a look at the documentation for the _validate and _execute (POST) options in EventRegistration? The examples and documentation are completely different, there's no payment data in the _execute example, etc. It would stand to reason that the difference between the 2 would be minimal, as they're doing everything the same except processing the order but while I have worked out the payload for the _validate call I can't do the same for the actual registration one. Any additional info would be helpful. Thanks much.

Is there an endpoint to pull member types?

Or customer types or whatever the general term is nowadays? I imagine I could pull them using a generic entity, just trying to not hit tables directly. Thanks.

REST IQA Result: Proper paging OFFSET

Not sure if my initial question made it through, but ... I am running IQA through REST The initial request is form, giving me the **FIRST** 500 records http://my.instance.com/api/iqa?queryname=$/My/IQA&limit=500 I now want the next 500/100/... records using this form : http://my.instance.com/api/iqa?queryname=$/My/IQA&limit=500?offset=500 However I continue to get the **FIRST** 500 records. Any help would be appreciated -- Thanks