Skip to content
This repository was archived by the owner on Oct 10, 2023. It is now read-only.

Creating Appointments

epeloke edited this page Jan 25, 2017 · 10 revisions

Logging in

You will need to use the Access token created in our first step: Creating Access Tokens

*If needed, you can find the full Appointment documentation here

Creating an Appointment

URL: POST https://api-demo.iggbo.com/appointments

Headers:
  • Authorization:Bearer {{access_token}}
  • Content-Type:application/json
Body
  • format is RAW in style of JSON the following examples includes explanation of each attribute.
  • Type can be any of Single/Event/IOP, is case-sensitive.
{  
  "type": "Single", 
  • Time format in ISO, Timezone (Z) can vary, example: 511Z for -5 UTC.
  "time": "2016-11-24T13:00:00.511Z",  
  • Location can be created with the appointment or retrieve existing address via "id":"[id]"
  • Street2 is Optional.
  "location": {    
    "label": "Home",   
    "street": 1234 Simpleton Dr",    
    "street2": "Suite 101",  
    "city": "Richmond",  
    "state": "Virginia",  
    "zip": "23294",  
    "country": "United States",  
    "phone": "8048888888"  
  },  
  • Subject is created with the appointment
  • Address of subject is created with the appointment, or can retrieve existing entry via "id":"[id]"
  • Street2 is Optional.
  "subject": {   
    "name": "John Coleman",  
    "dob": "1977-03-01",  
    "gender": "Male",  
    "phone": "1233211234",  
    "email": "johnc@example.com", 
    "addresses": [    
      {  
        "label": "Home",  
        "street": "1234 Simpleton Dr",  
        "street2": "Suite 101",  
        "city": "Richmond",  
        "state": "Virginia",  
        "zip": "23294",  
        "country": "United States",  
        "phone": "8048888888"  
        }  
    ],  

  },  
  • Services are the services or tests to be performed. For the services, an ID is required and can be looked up via the Services API.
  "services": [   
    {  
      "id": 1001  
    },
    {  
      "id": 1002
    },
    {  
      "id": 1003
    }
  ]  
}     

Full Example

POST /appointments HTTP/1.1
Host: api-demo.iggbo.com
Authorization: Basic ZGVtb25zdHJhdGlvbsdfdeW50aWFsOmRlbW9wYXNzd29yZA==
Content-Type: application/json
Cache-Control: no-cache
Postman-Token: fe0547ff-250f-3dse-2deb-7d2f9b0b833e

{
  "type": "Single",
  "time": "2016-09-23T18:25:43.511Z",
  "location": {
    
    "label": "Home",
    "street": "123 Fourth St",
    "street2": "Suite 101",
    "city": "Richmond",
    "state": "Virginia",
    "zip": "10001",
    "country": "United States",
    "phone": "718-321-1234",
    "latitude": 37.540725,
    "longitude": -77.436048
  },
  "subject": {
    
    "name": "Joseph Coleman",
    "dob": "1977-06-01",
    "gender": "female",
    "phone": "718-321-1234",
    "email": "testguy@example.com",
    "addresses": [
      {
      
        "label": "Home",
        "street": "123 Fourth St",
        "street2": "Suite 101",
        "city": "Richmond",
        "state": "Virginia",
        "zip": "10001",
        "country": "United States",
        "phone": "718-321-1234",
        "latitude": 37.540725,
        "longitude": -77.436048
      }
    ],
    "tags": [
      {
        "id": 1001,
        "name": "Centrifuge"
       
      }
    ]
  },
  "services": [
    {
      "id": 1001
    }
  ]
}


This service will create the appointment in the Iggbo system which will then get to work to send the appointment to qualified specialists in the area who can accept the appointment. All appointment updates can then be shared back into your system via a webhook.

Check out the full Appointment documentation [here] (http://docs.iggboapi.apiary.io/#reference/appointments/appointment-collection/create-new-appointment)


Check out the [Apiary documentation] (http://docs.iggboapi.apiary.io/) if you don't find what you're looking for here, or contact support@iggbo.com for questions or concerns.

Clone this wiki locally