Search for a participant by fulltext

Information

---

Search for a participant by full text on all iopole networks

Link to swagger

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

---

GET/v1/config/participant

---

Query parameters

---

value string - Required

• Anything like participant name (like)
• Match legal identifier value (SIREN in France)
• Match party identifier value (SIRET in France)
• Match Vat number (=)

offset integer - Optional - default 0
The number of records to skip before starting to return results. This is used to specify the starting point of the results to be fetched.

limit integer - Optional - default 50
The maximum number of records to return.

Request

---

GET /v1/config/participant

bash

  curl -X 'GET'
    'https://api.ppd.iopole.fr//v1/config/participant' 
    -H 'accept: application/json'
    -H 'Authorization: Bearer ${token}'

javascript

  const got = require('got');
  const token = 'your_token_here';
  
  (async () => {
    try {
      const response = await got('https://api.ppd.iopole.fr//v1/config/participant?value=myParticipant', {
        headers: {
        'accept': 'application/json',
        'Authorization': `Bearer ${token}`
        },
        responseType: 'json'
      });
      console.log(response.body);
    } catch (error) {
      console.error(error.response.body);
    }
  })();

.NET

using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
  static async Task Main(string[] args)
  {
      var token = "your_token_here";
      var client = new HttpClient();
      client.DefaultRequestHeaders.Add("accept", "application/json");
      client.DefaultRequestHeaders.Add("Authorization", "Bearer ${token}");
      try
        {
            var response = await client.GetAsync("https://api.ppd.iopole.fr//v1/config/participant?value=myParticipant");
            response.EnsureSuccessStatusCode(); // Throw if not a success code.
  
            var responseString = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseString);
        }
      catch (HttpRequestException ex)
        {
            Console.WriteLine("Request error: {ex.Message}");
        }
    }
}

Response

---

200 OK

[
  {
    "participantId": "292354df-5d22-4fad-b230-f32807589a3a",
    "name": "LE FLOCH BAILLON BICHAT",
    "country": "FR",
    "vatNumber": "FRooODuUIHUmG",
    "legalIdentifier": "312914807",
    "partyIdentifier": "31291480700028",
    "participantNetworkIdentifiers": [
      {
        "data": {
          "clientId": "test.test@iopole.com"
        },
        "electronicAddress": {
          "value": "EebonCDDolK",
          "scheme": "0225",
          "address": "0225:EebonCDDolK"
        },
        "networkIdentifier": "DOMESTIC_FR",
        "participantNetworkIdentifierId": "844fd62a-a35f-4f31-a6d6-bd155a507ea6"
      }
    ]
  }
]

---