FDSG APIs

Structure

All Endpoints have a basic common structure. Any given response will either contain a data or an errors object. But each response may contain a meta object.

{
    "meta": {
        ...
    },
    "data": {
        ...
    },
    "errors": []
}

meta

The meta object is used to communicate extra information about the response to the developer. If all goes well, meta might be empty. For endpoints which support pagination, the meta element will contain information about the current result window you requested.

Example:

{
    "meta": {
        "resultWindow": {
            "total": 1000,
            "isPartialResult": true
        },
        "paging": {
            "page": 1,
            "limit": 100
        }
    }
}

data

The data key is the meat of the response. It may be a list or dictionary, but either way this is where you'll find the data you requested.

errors

If an error occurs, the response will contain a top level errors element which contains an array of error objects with additional data to explain what went wrong.

The error object might look like this:

{
    "errors": [{
        "code": "error code",
        "title": "short error summary",
        "detail": "specific details about this occurance of the error"
    }]
}