POST api/PatientSexes

Create a new patient sex or update an existing patient sex in the Eye Reach Patients list.

Request Information

URI Parameters

None.

Body Parameters

Model used to create or retrieve a patient sex.

PatientSexModel
NameDescriptionTypeAdditional information
Name

Name of the patient sex (Required).

 string

None.
Active

Indicates whether the patient sex 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.

Request 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: 
<PatientSexModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PatientSexes">
  <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>
</PatientSexModel>

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 'PatientSexModel'.

Response Information

Resource Description

PatientSexModel
NameDescriptionTypeAdditional information
Name

Name of the patient sex (Required).

 string

None.
Active

Indicates whether the patient sex 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: 
<PatientSexModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PatientSexes">
  <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>
</PatientSexModel>