GET PlanCare2Api/Relations/CommonData?relationId={relationId}

Get RelationCommonDataSummary.

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	RelationId	integer	Required

Body Parameters

None.

Response Information

Resource Description

RelationCommonDataSummary.

RelationCommonDataSummary

Name	Description	Type	Additional information
RelationId	RelationId	integer	None
MaritalStatusId	MaritalStatusId	integer	None
MaritalStatus	MaritalStatus	string	None
NationalityId	NationalityId	integer	None
Nationality	Nationality	string	None
LegalStatusId	LegalStatusId	integer	None
LegalStatus	LegalStatus	string	None
LanguageId	LanguageId	integer	None
Language	Language	string	None
ParticularFormOfCommunicationId	ParticularFormOfCommunicationId	integer	None
ParticularFormOfCommunication	ParticularFormOfCommunication	string	None
LivingUnitId	LivingUnitId	integer	None
LivingUnit	LivingUnit	string	None
ReligionId	ReligionId	integer	None
Religion	Religion	string	None

Response Formats

application/json, text/json

Sample:

{
  "RelationId": 1,
  "MaritalStatusId": 1,
  "MaritalStatus": "sample string 2",
  "NationalityId": 1,
  "Nationality": "sample string 3",
  "LegalStatusId": 1,
  "LegalStatus": "sample string 4",
  "LanguageId": 1,
  "Language": "sample string 5",
  "ParticularFormOfCommunicationId": 1,
  "ParticularFormOfCommunication": "sample string 6",
  "LivingUnitId": 1,
  "LivingUnit": "sample string 7",
  "ReligionId": 1,
  "Religion": "sample string 8"
}

application/xml, text/xml

Sample:

<RelationCommonDataSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <Language>sample string 5</Language>
  <LanguageId>1</LanguageId>
  <LegalStatus>sample string 4</LegalStatus>
  <LegalStatusId>1</LegalStatusId>
  <LivingUnit>sample string 7</LivingUnit>
  <LivingUnitId>1</LivingUnitId>
  <MaritalStatus>sample string 2</MaritalStatus>
  <MaritalStatusId>1</MaritalStatusId>
  <Nationality>sample string 3</Nationality>
  <NationalityId>1</NationalityId>
  <ParticularFormOfCommunication>sample string 6</ParticularFormOfCommunication>
  <ParticularFormOfCommunicationId>1</ParticularFormOfCommunicationId>
  <RelationId>1</RelationId>
  <Religion>sample string 8</Religion>
  <ReligionId>1</ReligionId>
</RelationCommonDataSummary>