POST api/Surgeries

Create a new surgery or update the configuration of an existing surgery in the Eye Reach Patients list.

Request Information

URI Parameters

None.

Body Parameters

Model used to create or retrieve a surgery detail.

SurgeryModel
NameDescriptionTypeAdditional information
Name

Name of the surgery (Required).

 string

None.
Active

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

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

Response Information

Resource Description

SurgeryModel
NameDescriptionTypeAdditional information
Name

Name of the surgery (Required).

 string

None.
Active

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