Versions Compared

Version Old Version 4 New Version Current
Changes made by

Pete Richardson

Pete Richardson

Saved on

Key

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

...

HTTP Status Code

Description

Response Example

200

Successful retrieval of a service record.

 

Code Block
[
 {
    "serviceId": 1,
    "modifiedDateTime": "2023-06-15T13:45:30",
    "modifitationmodification": "UPDATE"
  },
{
    "serviceId": 2,
    "modifiedDateTime": "2023-06-15T13:45:30",
    "modifitationmodification": "CREATE"
  },
{
    "serviceId": 3,
    "modifiedDateTime": "2023-06-15T13:45:30",
    "modifitationmodification": "DELETE"
  },    
]

 

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
{
  "message": "Forbidden"
}

 

 

400

Request is malformed and will not be processed.

 

Code Block
{
  "type": "cie-directory/validation-error",
  "title": "Invalid Parameter",
  "detail": "parameter per_page was greater then the max allowed for this endpoint. per_page: 10000 max_allowed: 100",
  "instance": "237869a1-67f0-4a68-9500-734b3956517b"
}

 

500

Internal Server Error

Code Block
  {
  "type": "cie-directory/unkown-error",
  "title": "There was an error retrieving the services",
  "detail": "{\n\t\"stack\": \"Error: Error message\\n    at ServiceController.GetServicesAllComplete (/var/task/src/services/service-controller.js:214:13)\\n    at processTicksAndRejections (internal/process/task_queues.js:97:5)\\n    at async Runtime.exports.getServicesAllCompleteHandler [as handler] (/var/task/src/services/handler.js:73:22)\",\n\t\"message\": \"Error message\"\n}",
  "instance": "7a025b91-f1ff-4e4f-be75-42390fb02dd2"
}

 

...