GET api/patientfamilymembers/search?page={page}&itemsPerPage={itemsPerPage}

Returns the family members of the patient

Request Information

URI Parameters

Name	Description	Type	Additional information
page	Page number requested (search results are paginated).	integer	Default value is 1
itemsPerPage	Items to return on each page. See page parameter above.	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfPatientFamilyMemberModel

Name	Type	Additional information
TotalItems	integer	None.
ItemsPerPage	integer	None.
CurrentPage	integer	None.
TotalPages	integer	None.
FirstRowOnPage	integer	None.
LastRowOnPage	integer	None.
Rows	Collection of PatientFamilyMemberModel	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "RelativeId": "ee5e3a23-28e3-432e-b6d8-142ce693af65",
      "RelativeFullName": "sample string 2",
      "RelativeEmail": "sample string 3",
      "RelativePhone": "sample string 4"
    },
    {
      "RelativeId": "ee5e3a23-28e3-432e-b6d8-142ce693af65",
      "RelativeFullName": "sample string 2",
      "RelativeEmail": "sample string 3",
      "RelativePhone": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<ListModelOfPatientFamilyMemberModelaKbTw8r2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentRequests">
    <d2p1:PatientFamilyMemberModel>
      <d2p1:RelativeEmail>sample string 3</d2p1:RelativeEmail>
      <d2p1:RelativeFullName>sample string 2</d2p1:RelativeFullName>
      <d2p1:RelativeId>ee5e3a23-28e3-432e-b6d8-142ce693af65</d2p1:RelativeId>
      <d2p1:RelativePhone>sample string 4</d2p1:RelativePhone>
    </d2p1:PatientFamilyMemberModel>
    <d2p1:PatientFamilyMemberModel>
      <d2p1:RelativeEmail>sample string 3</d2p1:RelativeEmail>
      <d2p1:RelativeFullName>sample string 2</d2p1:RelativeFullName>
      <d2p1:RelativeId>ee5e3a23-28e3-432e-b6d8-142ce693af65</d2p1:RelativeId>
      <d2p1:RelativePhone>sample string 4</d2p1:RelativePhone>
    </d2p1:PatientFamilyMemberModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientFamilyMemberModelaKbTw8r2>