POST Groups/Relationship?validateOnly={validateOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
validateOnly

boolean

Default value is False

Body Parameters

EntityRelationshipDTO
NameDescriptionTypeAdditional information
EntityRelationshipID

integer

None.

ChildEntityID

integer

None.

ChildEntityType

EntityType

None.

ChildEntityStringName

string

None.

ChildEntityName

NameDTO

None.

ParentEntityID

integer

None.

ParentEntityType

EntityType

None.

ParentEntityTypeEntryID

integer

None.

ParentEntityTypeEntryValue

string

None.

ParentEntityName

NameDTO

None.

ParentEntityStringName

string

None.

ParentEntityAddresses

AddressesDTO

None.

ParentEntityCommunicationMethods

CommunicationMethodsDTO

None.

EntityRelationshipTypeEntryID

integer

None.

EntityRelationshipTypeValue

string

None.

RecordState

RecordState

None.

Created

AuditDataDTO

None.

LastUpdated

AuditDataDTO

None.

EntityRelationshipDetails

EntityRelationshipDetailsDTO

None.

Comments

string

None.

Request Formats

application/json, text/json

Sample:
{
  "entityRelationshipID": 1,
  "childEntityID": 2,
  "childEntityType": 1,
  "childEntityStringName": "sample string 3",
  "childEntityName": {
    "lastName": "sample string 1",
    "firstName": "sample string 2",
    "preferredName": "sample string 3",
    "middleName": "sample string 4",
    "prefix": "sample string 5",
    "suffix": "sample string 6",
    "summary": "sample string 1, sample string 2 (sample string 3)"
  },
  "parentEntityID": 4,
  "parentEntityType": 1,
  "parentEntityTypeEntryID": 5,
  "parentEntityTypeEntryValue": "sample string 6",
  "parentEntityName": {
    "lastName": "sample string 1",
    "firstName": "sample string 2",
    "preferredName": "sample string 3",
    "middleName": "sample string 4",
    "prefix": "sample string 5",
    "suffix": "sample string 6",
    "summary": "sample string 1, sample string 2 (sample string 3)"
  },
  "parentEntityStringName": "sample string 7",
  "entityRelationshipTypeEntryID": 8,
  "entityRelationshipTypeValue": "sample string 9",
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T08:10:22.7043086+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:10:22 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:10:22.7043086+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:10:22 AM"
  },
  "entityRelationshipDetails": {
    "list": []
  },
  "comments": "sample string 10"
}

application/xml, text/xml

Sample:
<EntityRelationshipDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ChildEntityID>2</ChildEntityID>
  <ChildEntityName>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 1</LastName>
    <MiddleName>sample string 4</MiddleName>
    <PreferredName>sample string 3</PreferredName>
    <Prefix>sample string 5</Prefix>
    <Suffix>sample string 6</Suffix>
  </ChildEntityName>
  <ChildEntityStringName>sample string 3</ChildEntityStringName>
  <ChildEntityType>Organization</ChildEntityType>
  <Comments>sample string 10</Comments>
  <Created>
    <DateUtc>2024-12-04T08:10:22.7043086+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <EntityRelationshipDetails>
    <List />
  </EntityRelationshipDetails>
  <EntityRelationshipID>1</EntityRelationshipID>
  <EntityRelationshipTypeEntryID>8</EntityRelationshipTypeEntryID>
  <EntityRelationshipTypeValue>sample string 9</EntityRelationshipTypeValue>
  <LastUpdated>
    <DateUtc>2024-12-04T08:10:22.7043086+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <ParentEntityAddresses>
    <List />
    <PartialData>FullData</PartialData>
  </ParentEntityAddresses>
  <ParentEntityCommunicationMethods>
    <List />
    <PartialData>FullData</PartialData>
    <PhoneNumbers />
  </ParentEntityCommunicationMethods>
  <ParentEntityID>4</ParentEntityID>
  <ParentEntityName>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 1</LastName>
    <MiddleName>sample string 4</MiddleName>
    <PreferredName>sample string 3</PreferredName>
    <Prefix>sample string 5</Prefix>
    <Suffix>sample string 6</Suffix>
  </ParentEntityName>
  <ParentEntityStringName>sample string 7</ParentEntityStringName>
  <ParentEntityType>Organization</ParentEntityType>
  <ParentEntityTypeEntryID>5</ParentEntityTypeEntryID>
  <ParentEntityTypeEntryValue>sample string 6</ParentEntityTypeEntryValue>
  <RecordState>Active</RecordState>
</EntityRelationshipDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:
��S=O�0�+�'-uܴ
ِ��mY*+v�%;�lG"����I�.!�a�2��{~w~};b�9����yf��]�8��� �i�:C;�mU�>k�̞�[�%�mrh�;�O�+f�(?~*���F������\�Q8lȗ�Ȗ��l �����'����$��Le�v5즾l�'!2M�ƒ=2UZK�I�7��C]����l �1�Wp�Hr�7����!�7�!ع�(��4�SnI$��rE�9���Ą@��
�݌�"��t���퍮�j_�K����:��Ie�����x��$��vx�>�)��

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.