Monti | Posts: 6

Get a filtered list of transactions

0 votes

Hello!
I would like to know if there is any endpoint within the REST API to which I can send a parameter and get a list of transactions whose name contains that parameter.

For example: https://sandbox.esignlive.com/api/packages?filter=FILTER_NAME_TRANSACTION

 

Thank you!


Approved Answer
Duo_Liang | Posts: 3776

Reply to: Get a filtered list of transactions

0 votes

Hi Monti,

 

You'll need another two parameters "from" and "to" to paginate all the results, for example:
GET /api/packages?from=1&to=100&search=keyword

GET /api/packages?from=101&to=200&search=keyword

 

Duo


Duo_Liang | Posts: 3776

Reply to: Get a filtered list of transactions

0 votes

Hi Monti,

 

Yes, you can use the parameter "search" to filter the transactions. By default, a wildcard search will be done in the transaction name and description for the search value, and if you additionally set the parameter "&searchtype=exact", a restrictive searches will be applied.

 

Duo


Monti | Posts: 6

Reply to: Get a filtered list of transactions

0 votes

Thanks for your quick response!
I tried to perform a query with the "search" parameter, which returned a 200 code response with the content:
{
    "count":688,
    "results":[

              {

            "autocomplete": true,

            "consent": "default-consent",

            "description": "Firma rápida",

            "documents": [

                 ....

                ],

             ... etc
             }

      ]

}

This is a correct answer? That is, the API found 688 transaction results that contain the name/description "a", but in the "results" field it returns an array with only 1 element.


Monti | Posts: 6

Reply to: Get a filtered list of transactions

0 votes

Excellent!
Thank you!


Hello! Looks like you're enjoying the discussion, but haven't signed up for an account.

When you create an account, we remember exactly what you've read, so you always come right back where you left off