Hello, @zacbutko and @dkayiwa I am sorry I didn’t capture the working endpoint details but it’s the POST
endpoint to /appointment
.
I have a list of endpoints that were shared with me as some of the useful endpoints that I will need to develop the appointments module.
Just in case the Pastebin link fails to work, this is the JSON.
{
"info": {
"_postman_id": "bea353f2-acff-40fb-a303-e563a11a7d29",
"name": "New Collection",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "9064607"
},
"item": [
{
"name": "Get all appointments",
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "Admin123",
"type": "string"
},
{
"key": "username",
"value": "Admin",
"type": "string"
}
]
},
"method": "GET",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment/all",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment",
"all"
]
}
},
"response": []
},
{
"name": "Get all appointment by date",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment/all?forDate=2022-08-02T00:00:00.0Z",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment",
"all"
],
"query": [
{
"key": "forDate",
"value": "2022-08-02T00:00:00.0Z"
}
]
}
},
"response": []
},
{
"name": "Save Appointment",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"providerUuid\": \"823fdcd7-3f10-11e4-adec-0800271c1b75\",\n \"appointmentNumber\": \"1\",\n \"patientUuid\": \"2c33920f-7aa6-48d6-998a-60412d8ff7d5\",\n \"serviceUuid\": \"c36006d4-9fbb-4f20-866b-0ece245615c1\",\n \"startDateTime\": \"2017-07-20\",\n \"endDateTime\": \"2017-07-20\",\n \"appointmentKind\": \"WalkIn\",\n \"providers\": [\n {\n \"uuid\": \"2d15071d-439d-44e8-9825-aa8e1a30d2a2\",\n \"comments\": \"available\",\n \"response\": \"ACCEPTED\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment"
]
}
},
"response": []
},
{
"name": "Get all non-cancelled, non-voided future appointment by appointmentServiceUuid",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment/futureAppointmentsForServiceType?appointmentServiceTypeUuid=678906e5-9fbb-4f20-866b-0ece24564578",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment",
"futureAppointmentsForServiceType"
],
"query": [
{
"key": "appointmentServiceTypeUuid",
"value": "678906e5-9fbb-4f20-866b-0ece24564578"
}
]
}
},
"response": []
},
{
"name": "Count appointment per service type in a date range",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment/appointmentSummary?startDate=2022-08-02T00:00:00.0Z&endDate=2022-08-02T00:00:00.0Z",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment",
"appointmentSummary"
],
"query": [
{
"key": "startDate",
"value": "2022-08-02T00:00:00.0Z"
},
{
"key": "endDate",
"value": "2022-08-02T00:00:00.0Z"
}
]
}
},
"response": []
},
{
"name": "Search appointments by serviceUuid (POST Request)",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"serviceUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a6\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment/search",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment",
"search"
]
}
},
"response": []
},
{
"name": "Create audit info when appointment is editted",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"uuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a7\",\n \"appointmentNumber\": \"1\",\n \"patientUuid\": \"2c33920f-7aa6-48d6-998a-60412d8ff7d5\",\n \"serviceUuid\": \"c36006d4-9fbb-4f20-866b-0ece245615c1\",\n \"serviceTypeUuid\": \"672546e5-9fbb-4f20-866b-0ece24564578\",\n \"startDateTime\": \"2017-07-20\",\n \"endDateTime\": \"2017-07-20\",\n \"comments\": \"Some notes\",\n \"appointmentKind\": \"WalkIn\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment"
]
}
},
"response": []
},
{
"name": "Undo appointment status change, should return an error object",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointment/undoStatusChange/uuid",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointment",
"undoStatusChange",
"uuid"
]
}
},
"response": []
},
{
"name": "Create appointment service",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cardiology Consultation\",\n \"startTime\": \"09:00:00\",\n \"endTime\": \"17:30:00\",\n \"durationMins\": \"30\",\n \"locationUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"specialityUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"maxAppointmentsLimit\": \"30\",\n \"color\": \"#00ff00\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
]
}
},
"response": []
},
{
"name": "Create appointment service with only name",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Sample Appointment Servie\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
]
}
},
"response": []
},
{
"name": "Create appointment service with service availability",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cardiology Consultation\",\n \"startTime\": \"09:00:00\",\n \"endTime\": \"17:30:00\",\n \"durationMins\": \"30\",\n \"locationUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"specialityUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"maxAppointmentsLimit\": \"30\",\n \"color\": \"#0000ff\",\n \"weeklyAvailability\": [\n {\n \"dayOfWeek\": \"MONDAY\",\n \"startTime\": \"09:00:00\",\n \"endTime\": \"17:30:00\",\n \"maxAppointmentsLimit\": \"10\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
]
}
},
"response": []
},
{
"name": "Create appointment with service type",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cardiology Consultation\",\n \"startTime\": \"09:00:00\",\n \"endTime\": \"17:30:00\",\n \"durationMins\": \"30\",\n \"color\": \"#fff000\",\n \"locationUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"specialityUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"serviceTypes\": [\n {\n \"name\": \"type1\",\n \"duration\": \"20\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
]
}
},
"response": []
},
{
"name": "Create appointment with initial appointment status",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cardiology Consultation\",\n \"initialAppointmentStatus\": \"Requested\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
]
}
},
"response": []
},
{
"name": "Get all appointment services",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService/all/default",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService",
"all",
"default"
]
}
},
"response": []
},
{
"name": "Get appointment service by uuid",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService?uuid=some-uuid",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
],
"query": [
{
"key": "uuid",
"value": "some-uuid"
}
]
}
},
"response": []
},
{
"name": "Delete appointment service by appointment servie uuid",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService?uuid=some-delete-uuid",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
],
"query": [
{
"key": "uuid",
"value": "some-delete-uuid"
}
]
}
},
"response": []
},
{
"name": "Update appointment service",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Chemotherapy\",\n \"startTime\": \"09:00:00\",\n \"endTime\": \"17:30:00\",\n \"durationMins\": \"30\",\n \"uuid\": \"uuid\",\n \"locationUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"specialityUuid\": \"c36006e5-9fbb-4f20-866b-0ece245615a1\",\n \"serviceTypes\": [\n {\n \"name\": \"stage 1\",\n \"duration\": \"20\",\n \"uuid\": \"c36006d5-9fcc-4f20-866b-0ece245615b1\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService"
]
}
},
"response": []
},
{
"name": "Get load by serviceType for a dange range",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://dev3.openmrs.org/openmrs/ws/rest/v1/appointmentService/load?uuid=99b2ea38-e041-41eb-9ed2-25a265068764&startDateTime=&endDateTime=",
"protocol": "https",
"host": [
"dev3",
"openmrs",
"org"
],
"path": [
"openmrs",
"ws",
"rest",
"v1",
"appointmentService",
"load"
],
"query": [
{
"key": "uuid",
"value": "99b2ea38-e041-41eb-9ed2-25a265068764"
},
{
"key": "startDateTime",
"value": ""
},
{
"key": "endDateTime",
"value": ""
}
]
}
},
"response": []
},
{
"name": "Get all appointment by date and status",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http:///openmrs/rest/v1/appointmentStatus?forDate=2022-08-02&status=missed",
"protocol": "http",
"path": [
"openmrs",
"rest",
"v1",
"appointmentStatus"
],
"query": [
{
"key": "forDate",
"value": "2022-08-02"
},
{
"key": "status",
"value": "missed"
}
]
}
},
"response": []
}
]
}
Please let me know if you need me to share more information about the appointments.