Versions Compared

Version Old Version 3 New Version 4
Changes made by

Pete Richardson

Pete Richardson

Saved on

Key

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

...

Data Element

Description

Default

Query String

startDateTime

This will be the start date and time in which modifications, additions or delegations.  The following is a example format

Code Block
2023-06-15T13:45:30

 Required Field

endDateTime

This is the end date and time. If this parameter is not passed in then the current date and time of the call will be used.

Code Block
2023-06-15T13:45:30

Current Date and Time of Call.

page

This will be which page of data that the user wants to be returned.

Default to Page 1

per_page

This will be the number of records that can be queried at a time. The maximum that can be queried is 100.

Default to 10

...

HTTP Status Code

Description

Response Example

200

Successful retrieval of a service record.

 

Code Block
[
 {
    "serviceId": 1,
    "modifiedDateTime": "2023-06-15T13:45:30",
    "modifitation": "UPDATE"
  },
{
    "serviceId": 2,
    "modifiedDateTime": "2023-06-15T13:45:30",
    "modifitation": "CREATE"
  },
{
    "serviceId": 3,
    "modifiedDateTime": "2023-06-15T13:45:30",
    "modifitation": "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"
}

 

...