Register into network by id

Information

---

Use this endpoint to register a business entity in a network.

This step is mandatory to ensure the receipt of documents.

In the case of a company registered in the domestic FR network, it will be marked as using Iopole as the reception platform. In the case of a PEPPOL connection, the company will be connected to the PEPPOL network with iopole as the reception platform.

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

---

POST/v1/config/business/entity/identifier/{businessEntityIdentifierId}/network/{networkIdentifier}

---

Path parameters

---

businessEntityIdentifierIdstring (uuid) - Required

The unique Iopole Id representing an identifier

---

networkIdentifierstring - Required

---

Body parameters

---

Must be a future date

validityStartDatestring (YYYY-MM-DD) - Default value : If omitted, the default value is tomorrow

The date when the business entity will start to be considered as yours

---

Must be greater than validity start date

validityEndDatestring (YYYY-MM-DD) - Default value : If omitted, no end date is set (ie. the registration remains valid indefinitely)

The date when the business entity will no longer be considered as yours

---

Request

---

POST /v1/config/business/entity/identifier/:businessEntityIdentifierId/network/:networkIdentifier

bash

  curl -X 'POST'   'https://api.ppd.iopole.fr//v1/config/business/entity/identifier/0194cbfe-ab2b-709e-8897-e1b86eca130e/network/DOMESTIC_FR'   -H 'accept: application/json'   -H 'Authorization: Bearer ${TOKEN}'   -H 'Content-Type: application/json' 

javascript

    const got = require('got');
    const url = 'https://api.ppd.iopole.fr//v1/config/business/entity/identifier/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8/network/DOMESTIC_FR';
    const token = 'your_token_here';
    (async () => {
      try {
        const response = await got.post(url, {
          headers: {
            'accept': 'application/json',
            'Authorization': `Bearer ${token}`,
            'Content-Type': 'application/json'
          },
          json: {}
        });
        console.log(response.body);
      } catch (error) {
        console.error('Error:', error.message);
      }
    })();

.NET

    using System;
    using System.Net.Http;
    using System.Net.Http.Headers;
    using System.Threading.Tasks;
    class Program
    {
        static async Task Main(string[] args)
        {
            string url = "https://api.ppd.iopole.fr//v1/config/business/entity/identifier/32c9aec1-e6d6-4ddf-82a0-42dfa29268f8/network/DOMESTIC_FR";
            string token = "your_token_here";
            using HttpClient client = new HttpClient();
            client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
            try
            {
                HttpResponseMessage response = await client.GetAsync(url);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine("Error: {e.Message}");
            }
        }
    }

Response

---

Status: 201 - application/json

Description: Business entity registered

Schema:

• type: enum
  The type of the response object.
• id: string
  The unique identifier for the created element.

Examples:

{
  "type": "DIRECTORY",
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.

Status: 404

Description: Not found - Network not found or operator not connected with it. Or business entity not found

---