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": "f26f79a2-e863-4acd-b4ec-38fb610d7121",
"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>f26f79a2-e863-4acd-b4ec-38fb610d7121</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": "29d4057c-fcdf-4138-9061-3d0da6493fa1",
"RelationshipID": "90223d13-ac69-48a4-bee1-5d948dbe1cb4",
"GenderID": "491d1e44-4a90-409e-a8db-9146d1e85b47",
"Name": "sample string 2",
"HealthIssues": "sample string 3",
"Alive": true,
"BirthDate": "2025-12-11T14:43:01.7809171+03:00",
"Notes": "sample string 4"
},
{
"PatientFamilyID": "29d4057c-fcdf-4138-9061-3d0da6493fa1",
"RelationshipID": "90223d13-ac69-48a4-bee1-5d948dbe1cb4",
"GenderID": "491d1e44-4a90-409e-a8db-9146d1e85b47",
"Name": "sample string 2",
"HealthIssues": "sample string 3",
"Alive": true,
"BirthDate": "2025-12-11T14:43:01.7809171+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>2025-12-11T14:43:01.7809171+03:00</BirthDate>
<GenderID>491d1e44-4a90-409e-a8db-9146d1e85b47</GenderID>
<HealthIssues>sample string 3</HealthIssues>
<Name>sample string 2</Name>
<Notes>sample string 4</Notes>
<PatientFamilyID>29d4057c-fcdf-4138-9061-3d0da6493fa1</PatientFamilyID>
<RelationshipID>90223d13-ac69-48a4-bee1-5d948dbe1cb4</RelationshipID>
</PatientFamily>
<PatientFamily>
<Alive>true</Alive>
<BirthDate>2025-12-11T14:43:01.7809171+03:00</BirthDate>
<GenderID>491d1e44-4a90-409e-a8db-9146d1e85b47</GenderID>
<HealthIssues>sample string 3</HealthIssues>
<Name>sample string 2</Name>
<Notes>sample string 4</Notes>
<PatientFamilyID>29d4057c-fcdf-4138-9061-3d0da6493fa1</PatientFamilyID>
<RelationshipID>90223d13-ac69-48a4-bee1-5d948dbe1cb4</RelationshipID>
</PatientFamily>
</PatientFamily>
</GetPatientFamilyResponse>