Public
Documentation Settings
Nymus Api Xpress Test Environment
Double Column
cURL - cURL
Nymus Api Xpress
Introduction
Participants
Documents

Nymus Api Xpress

Participants

POSTRegister a new participant to you environment.

https://test-api.nymus.eu/v1/nymusapixpress/peppol/participants

Register a new participant on your environment. Registering a participant to your environment allows you to use this participant identifier as the sender party when sending documents over the Peppol Network and/or as the receiver party when receiving documents over the Peppol Network

AUTHORIZATIONAPI Key
Key

apiKey

Value

•••••••

HEADERS
Content-Type

application/json

Accept

application/json

Bodyraw (json)
json
{
  "participantId": "0208:0713775488",
  "participantName": "LAVA Project",
  "isSender": "true",
  "isReceiver": "true"
}
Example Request
Participant successfully registered to your environment.
curl
curl --location 'https://test-api.nymus.eu/v1/nymusapixpress/peppol/participants' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'apiKey: <API Key>' \
--data '{
  "participantId": "<string>",
  "participantName": "<string>",
  "countryCode": "<string>",
  "isSender": "<boolean>",
  "isReceiver": "<boolean>",
  "documentTypes": [
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "ORDER_CANCELLATION"
    },
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "MESSAGE_LEVEL_RESPONSE_3_0"
    }
  ]
}'
200 OK
Example Response
json
{
  "participantId": "<string>",
  "participantName": "<string>",
  "countryCode": "<string>",
  "isSender": "<boolean>",
  "isReceiver": "<boolean>",
  "documentTypes": [
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "ORDER_CANCELLATION"
    },
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "MESSAGE_LEVEL_RESPONSE_3_0"
    }
  ]
}
Content-Type

application/json

PUTUpdate a participant on you environment.

https://test-api.nymus.eu/v1/nymusapixpress/peppol/participants/:participantId

Update a participant on your environment.

AUTHORIZATIONAPI Key
Key

apiKey

Value

•••••••

HEADERS
Content-Type

application/json

Accept

application/json

PATH VARIABLES
participantId

<string>

(Required) Participant to update on your environment.

Bodyraw (json)
json
{
  "participantId": "<string>",
  "participantName": "<string>",
  "countryCode": "<string>",
  "isSender": "<boolean>",
  "isReceiver": "<boolean>",
  "documentTypes": [
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "ORDER_CANCELLATION"
    },
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "MESSAGE_LEVEL_RESPONSE_3_0"
    }
  ]
}
Example Request
Participant successfully updated on your environment.
curl
curl --location --request PUT 'https://test-api.nymus.eu/v1/nymusapixpress/peppol/participants/:participantId' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'apiKey: <API Key>' \
--data '{
  "participantId": "<string>",
  "participantName": "<string>",
  "countryCode": "<string>",
  "isSender": "<boolean>",
  "isReceiver": "<boolean>",
  "documentTypes": [
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "ORDER_CANCELLATION"
    },
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "MESSAGE_LEVEL_RESPONSE_3_0"
    }
  ]
}'
200 OK
Example Response
json
{
  "participantId": "<string>",
  "participantName": "<string>",
  "countryCode": "<string>",
  "isSender": "<boolean>",
  "isReceiver": "<boolean>",
  "documentTypes": [
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "ORDER_CANCELLATION"
    },
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "MESSAGE_LEVEL_RESPONSE_3_0"
    }
  ]
}
Content-Type

application/json

GETRetrieve a participant from your environment.

https://test-api.nymus.eu/v1/nymusapixpress/peppol/participants/:participantId

Retrieve a participant from your environment.

AUTHORIZATIONAPI Key
Key

apiKey

Value

•••••••

HEADERS
Accept

application/json

PATH VARIABLES
participantId

<string>

(Required) Participant to retrieve from your environment.

Example Request
The retrieved participant from your environment.
curl
curl --location 'https://test-api.nymus.eu/v1/nymusapixpress/peppol/participants/:participantId' \
--header 'Accept: application/json' \
--header 'apiKey: <API Key>'
200 OK
Example Response
json
{
  "participantId": "<string>",
  "participantName": "<string>",
  "countryCode": "<string>",
  "isSender": "<boolean>",
  "isReceiver": "<boolean>",
  "documentTypes": [
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "ORDER_CANCELLATION"
    },
    {
      "peppolDocumentTypeIdentifier": "<string>",
      "documentType": "MESSAGE_LEVEL_RESPONSE_3_0"
    }
  ]
}
Content-Type

application/json