GET Relation/{id}

Some tooltip text!

• 4 minutes to read

 • 4 minutes to read

GET /api/v1/Relation/{id}

Gets a ContactRelationEntity object.

Calls the Relation agent service GetContactRelationEntity.

Path Part	Type	Description
id	int32	The id of the ContactRelationEntity to return. Required

Query String Parameters

Parameter Name	Type	Description
$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.

GET /api/v1/Relation/{id}?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept	Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

ContactRelationEntity found.

Response	Description
200	ContactRelationEntity found.
304	ContactRelationEntity has not changed since the requested If-Modified-Since date.
404	Not Found.

Response body: ContactRelationEntityWithLinks

Property Name	Type	Description
SourceContactId	int32	Id of the source contact. The value is mandatory.
SourcePersonId	int32	Id of the source person. The value is not mandatory. The person must belong to the source contact.
DestinationContactId	int32	Id of the destination contact. The value is mandatory.
DestinationPersonId	int32	Id of the destination person. The value is not mandatory. The person must belong to the destination contact.
RelationId	int32	Primary key
Comment	string	Comment for relation
RelationDefinitionId	int32	Reference to definition
Reversed	int32	Is direction reversed relative to definition
UpdatedDate	date-time	Last updated when in UTC.
CreatedDate	date-time	Registered when in UTC.
CreatedBy	Associate	Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
UpdatedBy	Associate	Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
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	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

GET /api/v1/Relation/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 ContactRelationEntity found.
Content-Type: application/json; charset=utf-8
Last-Modified: Wed, 07 Aug 2019 03:45:28 G8T

{
  "SourceContactId": 171,
  "SourcePersonId": 658,
  "DestinationContactId": 860,
  "DestinationPersonId": 534,
  "RelationId": 3,
  "Comment": "odit",
  "RelationDefinitionId": 613,
  "Reversed": 659,
  "UpdatedDate": "2019-08-07T03:45:28.2328189+02:00",
  "CreatedDate": "2019-06-04T03:45:28.2328189+02:00",
  "CreatedBy": null,
  "UpdatedBy": null,
  "SourceContactName": "Swaniawski-Daugherty",
  "SourcePersonName": "Herman, Bogan and Fisher",
  "DestinationContactName": "Littel-Walker",
  "DestinationPersonName": "VonRueden Inc and Sons",
  "ActiveText": "est",
  "PassiveText": "facilis",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 917
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}