Retrieves a list of all participants to the requesting party from the trust framework catalogue.
Excerpt |
---|
|
Panel |
---|
panelIconId | 2705 |
---|
panelIcon | :white_check_mark: |
---|
panelIconText | ✅ |
---|
bgColor | #FFF0B3 |
---|
| The trust framework catalogue MUST support a GET call to a /parties endpoint to retrieve a list of DSGO participants (in an array of parties_info objects). |
|
Request
Authorization
An access token must be used in GET calls to the /parties
endpoint. For more information, see Access Token.
...
For information about the parameters that are common to the trust framework’s API’s see Generic API Requirements.
...
Parameter | Type | Description |
---|
name
| Optional | String | Used to search by a party’s name. MUST be the party’s name or contain a single * as wildcard instead |
party_id
| Optional | String | Used to search by a party’s identifier. MUST contain an Organisation ID, containing an EORI or KvK number, or contain a single * as wildcard |
certified_only
| Optional | Boolean | Used to search all certified parties. MUST be equal to null , false or true . If null is provided, then it will not affect the query and will return both certified and non-certified parties. If false is provided, then the query will return non-certified parties. If true is provided, the query will return certified parties. |
active_only
| Optional | Boolean | Used to search all active parties. MUST be equal to null , false or true . If null is provided, then it will not affect the query and will return both active and inactive parties. If false is provided, then the query will return inactive parties. If true is provided, then the query will return active parties. |
certificate_subject_name
| Optional | Boolean | MUST be subjectName as encoded in the X.509 certificate, which corresponds with the party that is being requested from the trust framework catalogue. Used by the catalogue to match the certificate identifier. Subject name attributes may be in any order, but all of them MUST be included and separated by comma, if at least one subject attribute is missing - information won't be returned. Only returns info if combined with the valid Organisation ID associated to it. |
page
| Optional | Integer | Used for navigation in case the result contains more than 10 parties, MUST contain an integer. |
date_time
| Optional | String | Date and time for which the information is requested. MUST be according to ISO 8601, following the timestamp conventions. If provided, the result becomes final and therefore MUST be cacheable. |
...