HomeGuidesAPI ReferenceChangelogDiscussions
GuidesiMIS ProfessionaliMIS EnterpriseClient SupportLog In
API Reference
These docs are for v20.3.44. Click to read the latest docs for v20.3.189.

Executes a GroupMember operation

Executes an operation of GroupMember

With the GroupMember service, you can perform the following operations on the execute endpoint:

  • FindRelationships
  • UpdateRelationships
  • CancelAllActiveAndFutureGroupMembers

FindRelationships

BODY PARAMS:
{
	"$type": "Asi.Soa.Membership.DataContracts.FindRelationshipsRequest, Asi.Contracts",
	"EntityTypeName": "GroupMember",
	"OperationName": "FindRelationships",
	"PartyId": "string value",
	"RelatedToPartyId": "string value",
	"GroupClassIdFilter": [
		"string value"
	],
	"IncludeInactive": false
}

UpdateRelationships

BODY PARAMS:
{
	"$type": "Asi.Soa.Membership.DataContracts.UpdateRelationshipsRequest, Asi.Contracts",
	"EntityTypeName": "GroupMember",
	"OperationName": "UpdateRelationships",
	"GroupMembers": {
		"$type": "Asi.Soa.Membership.DataContracts.GroupMemberDataCollection, Asi.Contracts"
	}
}

CancelAllActiveAndFutureGroupMembers

BODY PARAMS:
{
	"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
	"OperationName": "CancelAllActiveAndFutureGroupMembers",
	"EntityTypeName": "GroupMember",
	"Parameters": {
		"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
		"$values": [
			{
				"$type": "System.String",
				"$value": "groupId Value"
			}
		]
	},
	"ParameterTypeName": {
		"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
		"$values": [
			"System.String"
		]
	},
	"UseJson": false
}
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!