POST api/appointments/create
Request Information
URI Parameters
None.
Body Parameters
AppointmentInputsName | Description | Type | Additional information |
---|---|---|---|
Environment | string |
None. |
|
ClinicID | integer |
None. |
|
APIKey | string |
None. |
|
ClinicDB | integer |
None. |
|
ProviderID | integer |
None. |
|
ProviderDB | integer |
None. |
|
OperatoryID | integer |
None. |
|
OperatoryDB | integer |
None. |
|
AppointmentDate | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
PatientPhone | string |
None. |
|
PatientID | integer |
None. |
|
PatientDB | integer |
None. |
|
AppointmentStatus | integer |
None. |
|
AppointmentStartTime | string |
None. |
|
AppointmentEndTime | string |
None. |
|
InitialReasonID | integer |
None. |
|
TimePatternArray | string |
None. |
|
BirthDate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Environment": "sample string 1", "ClinicID": 2, "APIKey": "sample string 3", "ClinicDB": 4, "ProviderID": 1, "ProviderDB": 1, "OperatoryID": 1, "OperatoryDB": 1, "AppointmentDate": "sample string 5", "FirstName": "sample string 6", "LastName": "sample string 7", "PatientPhone": "sample string 8", "PatientID": 1, "PatientDB": 1, "AppointmentStatus": 1, "AppointmentStartTime": "sample string 9", "AppointmentEndTime": "sample string 10", "InitialReasonID": 1, "TimePatternArray": "sample string 11", "BirthDate": "sample string 12" }
text/html, text/plain
Sample:
{"Environment":"sample string 1","ClinicID":2,"APIKey":"sample string 3","ClinicDB":4,"ProviderID":1,"ProviderDB":1,"OperatoryID":1,"OperatoryDB":1,"AppointmentDate":"sample string 5","FirstName":"sample string 6","LastName":"sample string 7","PatientPhone":"sample string 8","PatientID":1,"PatientDB":1,"AppointmentStatus":1,"AppointmentStartTime":"sample string 9","AppointmentEndTime":"sample string 10","InitialReasonID":1,"TimePatternArray":"sample string 11","BirthDate":"sample string 12"}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AppointmentName | Description | Type | Additional information |
---|---|---|---|
ReturnCode | integer |
None. |
|
Message | string |
None. |
|
AppointmentID | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "ReturnCode": 1, "Message": "sample string 2", "AppointmentID": 3 }
text/html, text/plain
Sample:
{"ReturnCode":1,"Message":"sample string 2","AppointmentID":3}