GET api/PatientMaritalStatuses?externalId={externalId}

Gets the configuration for a marital status in the Eye Reach Patients list.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

Unique ID of the marital status on integrating system.

 string

Required

Body Parameters

None.

Response Information

Resource Description

PatientMaritalStatusModel
NameDescriptionTypeAdditional information
Name

The name of a marital status.

 string

None.
Active

Indicates whether the location is active or not.

 boolean

None.
Id

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

 string

None.
ExternalId

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "active": true,
  "id": "sample string 3",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<PatientMaritalStatusModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PatientMaritalStatuses">
  <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">sample string 3</Id>
  <Active>true</Active>
  <Name>sample string 1</Name>
</PatientMaritalStatusModel>