Retrieve transactions.

get

https://api.consentric.io/v1/permissions/transactions

The following criteria can be used to filter the results:

By Citizens

A citizen can be specified by either a citizenId or externalRef or by both a citizenId and externalRef.
If both a citizenId and externalRef are supplied they must both resolve to the same citizen.
By date range

"A transaction before (exclusive of) a given date, or since (inclusive) of a given date or transactions since and before the given dates" +
By Pagination

Results can be paginated by supplying a limit and or an offset.

The offset is zero or a positive integer that controls the number of transactions to skip before returning transactions while the limit is a positive integer value that controls the size of the page to be returned.

If the request does not filter by a citizen, pagination will be enforced, with a default limit and offset used if these values are not provided.

Note that if citizenId and externalRef are not provided, pagination will be enforced, with default values for limit and offset being used if none are provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

applicationId

string

required

length between 1 and 50

The ID associated with the target Application.

citizenId

string

length between 0 and 50

The ID associated with the target Citizen.

externalRef

string

length between 0 and 100

The unique reference associated with the Citizen.

optionIds

array of strings

A comma separated list of Option Ids. Used to ensure the response returns only Transactions that contains at least one Change that uses a specified Option Id.

optionIds

since

date-time

An ISO 8601 date (and time) specifying an inclusive lower limit for the results sought

before

date-time

An ISO 8601 date (and time) specifying an exclusive upper limit for the results sought

limit

string

Defaults to 20

Number of transactions to return in a page.
This provides for pagination allowing the client to control the size of the returned data set. Will default to 20 if an offset is provided but this field is unset, and will be limited at 1000 if the request does not filter on a citizen.

offset

string

Defaults to 0

Point (inclusive) to return records from.
To allow the next "page" of data to be requested. Will default to 0 if a limit is provided but no offset

recordedAtSortOrder

string

enum

Optional sort order for returned transactions. Returned transactions are grouped by citizenId, then sorted by recordedAt date. Specify either ascending or descending order, default is ascending. Field is case insensitive.

Allowed:

excludeTotal

boolean

Defaults to false

Optional param to omit the total count of transactions from the response.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

403Forbidden

500Internal Server Error

501Not Implemented