POST api/Calendar/PatientAppointmentPost_v1

Request Information

URI Parameters

None.

Body Parameters

AppointmentModel
NameDescriptionTypeAdditional information
EncounterTypeId

globally unique identifier

None.

EncounterTypeModeDurationId

globally unique identifier

None.

ProviderId

globally unique identifier

None.

UserId

globally unique identifier

Required

PatientId

globally unique identifier

None.

SpecialityId

globally unique identifier

None.

AppointmentOn

date

Required

SecondaryAppointmentOn

date

None.

Reason

string

Required

String length: inclusive between 0 and 250

Note

string

String length: inclusive between 0 and 1000

ParentId

globally unique identifier

None.

ReferredParentId

globally unique identifier

None.

PaidAmount

decimal number

None.

AccountId

globally unique identifier

Required

ServiceId

globally unique identifier

None.

MethodId

integer

None.

IsCustomFormFlow

string

None.

DocIds

string

None.

Reasons

Collection of Reasons

None.

Request Formats

application/json, text/json

Sample:
{
  "EncounterTypeId": "109c2dc7-c908-4ae2-9f86-9aa7c76fa12b",
  "EncounterTypeModeDurationId": "3d612cee-2fcf-4415-8bb8-f292b8e92896",
  "ProviderId": "0bff14dc-4fc2-4d7a-854e-5c57e2a03eb8",
  "UserId": "a27086b9-bc13-42d0-ad2d-c96ff733c3d0",
  "PatientId": "1c098e35-8166-4037-9685-954bad659f8b",
  "SpecialityId": "e39989c7-72df-47f5-a535-e2c358dbe9cd",
  "AppointmentOn": "2024-07-05T16:36:44.3126754-05:00",
  "SecondaryAppointmentOn": "2024-07-05T16:36:44.3126754-05:00",
  "Reason": "sample string 3",
  "Note": "sample string 4",
  "ParentId": "f5820e86-978b-40e3-b570-ed18e4744aff",
  "ReferredParentId": "10db0ac6-e5ad-4294-9827-1b0abe5ce338",
  "PaidAmount": 5.0,
  "AccountId": "897215f8-f342-4909-a070-2ef2656efefa",
  "ServiceId": "a030bf9a-6bd2-4b2c-94ad-7fe46009eeed",
  "MethodId": 1,
  "IsCustomFormFlow": "sample string 7",
  "DocIds": "sample string 8",
  "Reasons": [
    {
      "ReasonId": "eb62eec3-9be8-4eac-8149-c853dbd1d002"
    },
    {
      "ReasonId": "eb62eec3-9be8-4eac-8149-c853dbd1d002"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.