HomeGuidesAPI ReferenceChangelogDiscussions
GuidesiMIS ProfessionaliMIS EnterpriseClient SupportLog In
API Reference

Executes a Party operation

Executes an operation of Party

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

  • AddOrganizationAdministratorRequest

  • AddressUpdateRequest

  • PartyFindByAlternateIdRequest

  • PartyFindByEmailRequest

  • PartyMatchRequest

  • FindByAlternateId

AddOrganizationAdministratorRequest

BODY PARAMS:
{
  "$type": "Asi.Soa.Membership.DataContracts.AddOrganizationAdministratorRequest, Asi.Contracts",
  "EntityTypeName": "Party",
  "OperationName": "AddOrganizationAdministrator",
  "OrganizationPartyId": "string value",
  "AdministratorPartyId": "string value",
  "SetAdministratorPrimaryOrganizationIfBlank": false,
  "RequestCulture": "string value"
}

AddressUpdateRequest

BODY PARAMS:
{
  "$type": "Asi.Soa.Membership.DataContracts.AddressUpdateRequest, Asi.Contracts",
  "EntityTypeName": "Party",
  "OperationName": "AddressUpdate",
  "PartyId": "string value",
  "AddressUpdated": {
    "$type": "Asi.Soa.Membership.DataContracts.FullAddressData, Asi.Contracts"
  },
  "RequestCulture": "string value"
}

PartyFindByAlternateIdRequest

BODY PARAMS:
{
  "$type": "Asi.Soa.Membership.DataContracts.PartyFindByAlternateIdRequest, Asi.Contracts",
  "EntityTypeName": "Party",
  "OperationName": "FindByAlternateId",
  "AlternateId": {
    "$type": "Asi.Soa.Core.DataContracts.AlternateIdData, Asi.Contracts"
  },
  "RequestCulture": "string value"
}

PartyFindByEmailRequest

BODY PARAMS:
{
  "$type": "Asi.Soa.Membership.DataContracts.PartyFindByEmailRequest, Asi.Contracts",
  "EntityTypeName": "Party",
  "OperationName": "FindByEmail",
  "Email": "string value",
  "RequestCulture": "string value"
}

PartyMatchRequest

BODY PARAMS:
{
  "$type": "Asi.Soa.Membership.DataContracts.PartyMatchRequest, Asi.Contracts",
  "EntityTypeName": "Party",
  "OperationName": "FindByMatch",
  "Party": {
    "$type": "Asi.Soa.Membership.DataContracts.PartyData, Asi.Contracts"
  },
  "MaximumMatches": 6973,
  "RequestCulture": "string value"
}

FindByAlternateId

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