POST api/Patient/GetPatientFamily
Request Information
URI Parameters
None.
Body Parameters
PageRequestBase| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNumber | integer |
None. |
|
| PageCount | integer |
None. |
|
| PatientID | globally unique identifier |
None. |
|
| WebApiVersion | integer |
None. |
|
| Language | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"PageNumber": 1,
"PageCount": 2,
"PatientID": "ddec3313-e8fd-4995-99a6-d81f8346faa2",
"WebApiVersion": 4,
"Language": "sample string 5"
}
application/xml, text/xml
Sample:
<PageRequestBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SehatukaAPI.DTO"> <Language>sample string 5</Language> <PatientID>ddec3313-e8fd-4995-99a6-d81f8346faa2</PatientID> <WebApiVersion>4</WebApiVersion> <PageCount>2</PageCount> <PageNumber>1</PageNumber> </PageRequestBase>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetPatientFamilyResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientFamily | Collection of PatientFamily |
None. |
|
| PageNumber | integer |
None. |
|
| PageCount | integer |
None. |
|
| TotalCount | integer |
None. |
|
| WebApiVersion | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"PatientFamily": [
{
"PatientFamilyID": "d20714ca-6952-455c-b260-befaec747ee3",
"RelationshipID": "3762e3ee-f75f-4684-b130-93c27bdb42eb",
"GenderID": "85518d6d-d4bd-4972-91d2-81f472736dae",
"Name": "sample string 2",
"HealthIssues": "sample string 3",
"Alive": true,
"BirthDate": "2026-04-24T14:25:27.3511638+03:00",
"Notes": "sample string 4"
},
{
"PatientFamilyID": "d20714ca-6952-455c-b260-befaec747ee3",
"RelationshipID": "3762e3ee-f75f-4684-b130-93c27bdb42eb",
"GenderID": "85518d6d-d4bd-4972-91d2-81f472736dae",
"Name": "sample string 2",
"HealthIssues": "sample string 3",
"Alive": true,
"BirthDate": "2026-04-24T14:25:27.3511638+03:00",
"Notes": "sample string 4"
}
],
"PageNumber": 1,
"PageCount": 2,
"TotalCount": 3,
"WebApiVersion": 4
}
application/xml, text/xml
Sample:
<GetPatientFamilyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SehatukaAPI.DTO">
<WebApiVersion>4</WebApiVersion>
<PageCount>2</PageCount>
<PageNumber>1</PageNumber>
<TotalCount>3</TotalCount>
<PatientFamily>
<PatientFamily>
<Alive>true</Alive>
<BirthDate>2026-04-24T14:25:27.3511638+03:00</BirthDate>
<GenderID>85518d6d-d4bd-4972-91d2-81f472736dae</GenderID>
<HealthIssues>sample string 3</HealthIssues>
<Name>sample string 2</Name>
<Notes>sample string 4</Notes>
<PatientFamilyID>d20714ca-6952-455c-b260-befaec747ee3</PatientFamilyID>
<RelationshipID>3762e3ee-f75f-4684-b130-93c27bdb42eb</RelationshipID>
</PatientFamily>
<PatientFamily>
<Alive>true</Alive>
<BirthDate>2026-04-24T14:25:27.3511638+03:00</BirthDate>
<GenderID>85518d6d-d4bd-4972-91d2-81f472736dae</GenderID>
<HealthIssues>sample string 3</HealthIssues>
<Name>sample string 2</Name>
<Notes>sample string 4</Notes>
<PatientFamilyID>d20714ca-6952-455c-b260-befaec747ee3</PatientFamilyID>
<RelationshipID>3762e3ee-f75f-4684-b130-93c27bdb42eb</RelationshipID>
</PatientFamily>
</PatientFamily>
</GetPatientFamilyResponse>