Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP Status Code

Description

Response Example

200

Successful retrieval of a person record.

 

Code Block
{
  "appointments" : [{
    "type": ""
    "organizationName": "Detroit Metro",
    "organizationId": 12344,
    "address": "111 Main Street",
    "city": "Gothem",
    "state": "MI",
    "zip": "49456"
    "timeSlots": [
      {
        "availableDateTime": "",
        "availableDate": "",
        "availableTime": "",
        "availableRange": {"start": "", "end":"", "startUTC": "", "endUTC": "", "numberSlots": 5}
      }
    ]
    },
  ]
  instance: "347984t9"
}  
    


 

403

Request is unauthorized and will not be processed. This will happen if the authorization header does not contain a valid client id and secret.

 

 

Code Block
{
  "type": "cie/unauthorized",
  "title": "Request is not authorized 
            to perform this operation",
  "detail": "The x-api-key header may be 
             missing or is invalid",          
  "instance":"4abdf0d4-e934-5575513f6d5"
}



 

 

400

Request is malformed and will not be processed.

 

Code Block
{
  "type": "cie/validation-error",
  "title": "Your request parameters 
            didn't validate.",
  "instance":"4abdf0d4-e934-5575513f6d5"
}



 

...