Get Contact Relation Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "SourceContactId": 123,
  "SourcePersonId": 123,
  "DestinationContactId": 123,
  "DestinationPersonId": 123,
  "RelationId": 123,
  "Comment": "<string>",
  "RelationDefinitionId": 123,
  "Reversed": 123,
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "CreatedDate": "2023-11-07T05:31:56Z",
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SourceContactName": "<string>",
  "SourcePersonName": "<string>",
  "DestinationContactName": "<string>",
  "DestinationPersonName": "<string>",
  "ActiveText": "<string>",
  "PassiveText": "<string>",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Get Contact Relation Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Relation/GetContactRelationEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "SourceContactId": 123,
  "SourcePersonId": 123,
  "DestinationContactId": 123,
  "DestinationPersonId": 123,
  "RelationId": 123,
  "Comment": "<string>",
  "RelationDefinitionId": 123,
  "Reversed": 123,
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "CreatedDate": "2023-11-07T05:31:56Z",
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SourceContactName": "<string>",
  "SourcePersonName": "<string>",
  "DestinationContactName": "<string>",
  "DestinationPersonName": "<string>",
  "ActiveText": "<string>",
  "PassiveText": "<string>",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

contactRelationEntityId

integer<int32>

required

The identifier of the ContactRelationEntity object

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Response

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition. Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the Relation Agent.

SourceContactId

integer<int32>

Id of the source contact. The value is mandatory.

SourcePersonId

integer<int32>

Id of the source person. The value is not mandatory. The person must belong to the source contact.

DestinationContactId

integer<int32>

Id of the destination contact. The value is mandatory.

DestinationPersonId

integer<int32>

Id of the destination person. The value is not mandatory. The person must belong to the destination contact.

RelationId

integer<int32>

Primary key

Comment

string

Comment for relation

RelationDefinitionId

integer<int32>

Reference to definition

Reversed

integer<int32>

Is direction reversed relative to definition

UpdatedDate

string<date-time>

Last updated when in UTC.

CreatedDate

string<date-time>

Registered when in UTC.

CreatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

UpdatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

SourceContactName

string

Name of the source contact.

SourcePersonName

string

Name of the source person.

DestinationContactName

string

Name of the destination contact.

DestinationPersonName

string

Name of the destination person.

ActiveText

string

Active text for the relation.

PassiveText

string

Passive text for the relation.

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes