POST api/FamilyMembers

Creates a new family member or updates an existent family member's information.

Request Information

URI Parameters

None.

Body Parameters

FamilyMemberModel
NameDescriptionTypeAdditional information
PatientExternalId

Patient's unique ID on integrating system (Required).

 string

None.
RelativeExternalId

Relative's unique ID on integrating system (Required).

 string

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "patientExternalId": "sample string 1",
  "relativeExternalId": "sample string 2",
  "id": "95ecba17-dbd3-452c-8ea6-fc3bd8a87c45",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<FamilyMemberModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.FamilyMembers">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">95ecba17-dbd3-452c-8ea6-fc3bd8a87c45</Id>
  <PatientExternalId>sample string 1</PatientExternalId>
  <RelativeExternalId>sample string 2</RelativeExternalId>
</FamilyMemberModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FamilyMemberModel'.

Response Information

Resource Description

FamilyMemberModel
NameDescriptionTypeAdditional information
PatientExternalId

Patient's unique ID on integrating system (Required).

 string

None.
RelativeExternalId

Relative's unique ID on integrating system (Required).

 string

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "patientExternalId": "sample string 1",
  "relativeExternalId": "sample string 2",
  "id": "741c6bab-e1b7-4739-aae5-4e99041cfd5f",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<FamilyMemberModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.FamilyMembers">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">741c6bab-e1b7-4739-aae5-4e99041cfd5f</Id>
  <PatientExternalId>sample string 1</PatientExternalId>
  <RelativeExternalId>sample string 2</RelativeExternalId>
</FamilyMemberModel>