Dictionary
Access Point
An access point (AP) is a server that enables Participants to exchange electronic documents.
Access Point Provider
An access point provider is an entity that provides one or more Access Points. The access point providers have a customer relation with the Service Providers.
Organization
An organization is an entity – such as a company, an institution, or an association.
Participant
A participant is an Organization's customer relation with a specific Service Provider. An organization can have multiple participants.
Service Provider
A service provider is an entity that provides the ability for Organizations to exchange electronic documents. An Organization that is a customer of a service provider is a Participant.
How to get access
Most of the API requires the user to be registered in ELMA as a Service Provider or an Access Point Provider. To get such a registration, you have to make an agreement with the Norwegian Peppol Authority in The Norwegian Agency for Public and Financial Management(DFØ). To initiate such a process, please send an email to peppolmyndighet@dfo.no. A registration is needed for all environments (test and production).
| The service should not be used to find out if an organization can receive a certain document type in the Peppol network. This service will only give such information for organization registered in ELMA. The correct way to do such a check for the Peppol network is to use a combination of SML and SMP. ELMA is only one of several SMPs in the Peppol network. The SML will give information on which SMP that contain more details about the organization. An example of a library performing a SML + SMP lookup can be found here: https://github.com/OxalisCommunity/vefa-peppol - More specifically: the LookupClient class. If query by organization name is required, please use the REST API in Peppol Directory. |
Specification
The services
| Method | URL | Description | Allowed Roles |
|---|---|---|---|
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY |
||
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY |
||
PUT |
/rest/api/participants/{qualifiedIdentifier}/transfer/{serviceProviderIdentifier} |
SERVICE_PROVIDER |
|
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY, ANONYMOUS |
||
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY, ANONYMOUS |
||
POST |
ADMIN, PEPPOL_AUTHORITY |
||
PUT |
ADMIN, PEPPOL_AUTHORITY |
||
DELETE |
ADMIN, PEPPOL_AUTHORITY |
||
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY, ANONYMOUS |
||
GET |
SERVICE_PROVIDER, ADMIN, PEPPOL_AUTHORITY |
||
GET |
SERVICE_PROVIDER, ADMIN, PEPPOL_AUTHORITY |
||
GET |
SERVICE_PROVIDER |
||
GET |
SERVICE_PROVIDER, ADMIN, PEPPOL_AUTHORITY |
||
POST |
SERVICE_PROVIDER |
||
PUT |
SERVICE_PROVIDER |
||
DELETE |
SERVICE_PROVIDER |
||
DELETE |
SERVICE_PROVIDER,ADMIN |
||
GET |
SERVICE_PROVIDER |
||
GET |
/rest/api/participants/{identifier}/processes |
SERVICE_PROVIDER, ADMIN, PEPPOL_AUTHORITY |
|
PUT |
/rest/api/participants/{qualifiedIdentifier}/transfer/{serviceProviderIdentifier} |
SERVICE_PROVIDER |
|
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY, ANONYMOUS |
||
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY, ANONYMOUS |
||
GET |
SERVICE_PROVIDER, ACCESS_POINT_PROVIDER, ADMIN, PEPPOL_AUTHORITY, ANONYMOUS |
||
POST |
ADMIN, PEPPOL_AUTHORITY |
||
PUT |
ADMIN, PEPPOL_AUTHORITY |
||
DELETE |
ADMIN, PEPPOL_AUTHORITY |
Access Points
Find access points
The service is used to search for Access Points. The response is paged with a default page size of 10.
Example 1 - Find all Access Points
Curl
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/find/curl-request.adoc[]Request
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/find/http-request.adoc[]Response
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/find/http-response.adoc[]Example 2 - Sorting
Curl
$ curl 'https://elma-smp.no/rest/api/accessPoints?sort=qualifiedIdentifier.value%2Casc' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.accesspoints.find.v1+json;charset=UTF-8'Request
GET /rest/api/accessPoints?sort=qualifiedIdentifier.value%2Casc HTTP/1.1
Accept: application/vnd.no.digdir.elma.accesspoints.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.accesspoints.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1728
{
"content" : [ {
"identifier" : "1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0",
"title" : "The Great Access Point",
"provider" : {
"identifier" : "d51718f7-f889-4d75-86a3-bc7475e23347",
"title" : "The Hitech Company",
"contact" : {
"name" : "Mr. Robot",
"email" : "robot@hitech.com",
"phoneNumber" : "12345678"
}
},
"endpoints" : [ {
"transportProfile" : {
"title" : "Peppol AS2 Profile 2.0",
"value" : "busdox-transport-as2-ver2p0",
"certificateTypes" : [ "Peppol Production" ]
},
"url" : "https://www.example.com/oxalis/as4"
} ]
}, {
"identifier" : "6a450eaf-7023-419b-9e69-b21d2775cade",
"title" : "The Shiny Access Point",
"provider" : {
"identifier" : "d51718f7-f889-4d75-86a3-bc7475e23347",
"title" : "The Hitech Company",
"contact" : {
"name" : "Mr. Robot",
"email" : "robot@hitech.com",
"phoneNumber" : "12345678"
}
},
"endpoints" : [ {
"transportProfile" : {
"title" : "Peppol AS2 Profile 2.0",
"value" : "busdox-transport-as2-ver2p0",
"certificateTypes" : [ "Peppol Production" ]
},
"url" : "https://www.example.com/shiny/as4"
} ]
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 2,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"totalElements" : 2,
"totalPages" : 1
}Example 3 - Paging
Curl
$ curl 'https://elma-smp.no/rest/api/accessPoints?page=3&size=10' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.accesspoints.find.v1+json;charset=UTF-8'Request
GET /rest/api/accessPoints?page=3&size=10 HTTP/1.1
Accept: application/vnd.no.digdir.elma.accesspoints.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.accesspoints.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1729
{
"content" : [ {
"identifier" : "1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0",
"title" : "The Great Access Point",
"provider" : {
"identifier" : "d51718f7-f889-4d75-86a3-bc7475e23347",
"title" : "The Hitech Company",
"contact" : {
"name" : "Mr. Robot",
"email" : "robot@hitech.com",
"phoneNumber" : "12345678"
}
},
"endpoints" : [ {
"transportProfile" : {
"title" : "Peppol AS2 Profile 2.0",
"value" : "busdox-transport-as2-ver2p0",
"certificateTypes" : [ "Peppol Production" ]
},
"url" : "https://www.example.com/oxalis/as4"
} ]
}, {
"identifier" : "6a450eaf-7023-419b-9e69-b21d2775cade",
"title" : "The Shiny Access Point",
"provider" : {
"identifier" : "d51718f7-f889-4d75-86a3-bc7475e23347",
"title" : "The Hitech Company",
"contact" : {
"name" : "Mr. Robot",
"email" : "robot@hitech.com",
"phoneNumber" : "12345678"
}
},
"endpoints" : [ {
"transportProfile" : {
"title" : "Peppol AS2 Profile 2.0",
"value" : "busdox-transport-as2-ver2p0",
"certificateTypes" : [ "Peppol Production" ]
},
"url" : "https://www.example.com/shiny/as4"
} ]
} ],
"empty" : false,
"first" : false,
"last" : true,
"number" : 3,
"numberOfElements" : 2,
"pageable" : {
"offset" : 30,
"pageNumber" : 3,
"pageSize" : 10,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 10,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 32,
"totalPages" : 4
}About the service
Request parameters
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/find/request-parameters.adoc[]
Response fields
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/find/response-fields.adoc[]
Get access point
Use this service to get information about an Access Point.
Example 1 - Get a accessPoint
Curl
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/get/curl-request.adoc[]Request
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/get/http-request.adoc[]Response
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/get/http-response.adoc[]Example 2 - Not found
Curl
$ curl 'https://elma-smp.no/rest/api/accessPoints/1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.accesspoints.get.v1+json;charset=UTF-8'Request
GET /rest/api/accessPoints/1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0 HTTP/1.1
Accept: application/vnd.no.digdir.elma.accesspoints.get.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 314
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 404,
"error" : "Not Found",
"exception" : "no.difi.elma.lang.NotFoundException",
"message" : "Unable to find instance with identifier '1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0'.",
"path" : "/rest/api/accessPoints/1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0"
}About the service
Path parameters
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/get/path-parameters.adoc[]
Response fields
Unresolved directive in accessPoints.adoc - include::../../../target/generated-snippets/accessPoints/get/response-fields.adoc[]
Document Types
Find document types
The service is used to search for Document Types. The response is paged with a default page size of 10.
Example 1 - Find all Document Types
Curl
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/find/curl-request.adoc[]Request
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/find/http-request.adoc[]Response
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/find/http-response.adoc[]Example 2 - Sorting
Curl
$ curl 'https://elma-smp.no/rest/api/document-types?sort=qualifiedIdentifier.value%2Casc' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.document-types.find.v1+json;charset=UTF-8'Request
GET /rest/api/document-types?sort=qualifiedIdentifier.value%2Casc HTTP/1.1
Accept: application/vnd.no.digdir.elma.document-types.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.document-types.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1285
{
"content" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"title" : "Arkivmelding",
"processes" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0",
"title" : "Arkivmelding_Administrasjon",
"visible" : true,
"restricted" : false
} ]
}, {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"processes" : [ ]
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 2,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"totalElements" : 2,
"totalPages" : 1
}Example 3 - Paging
Curl
$ curl 'https://elma-smp.no/rest/api/document-types?page=3&size=10' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.document-types.find.v1+json;charset=UTF-8'Request
GET /rest/api/document-types?page=3&size=10 HTTP/1.1
Accept: application/vnd.no.digdir.elma.document-types.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.document-types.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1286
{
"content" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"title" : "Arkivmelding",
"processes" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0",
"title" : "Arkivmelding_Administrasjon",
"visible" : true,
"restricted" : false
} ]
}, {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"processes" : [ ]
} ],
"empty" : false,
"first" : false,
"last" : true,
"number" : 3,
"numberOfElements" : 2,
"pageable" : {
"offset" : 30,
"pageNumber" : 3,
"pageSize" : 10,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 10,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 32,
"totalPages" : 4
}About the service
Request parameters
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/find/request-parameters.adoc[]
Response fields
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/find/response-fields.adoc[]
Get document type
Use this service to get information about a document type.
Example 1 - Get a document type by identifier
Curl
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/get/curl-request.adoc[]Request
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/get/http-request.adoc[]Response
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/get/http-response.adoc[]Example 2 - Not found
Curl
$ curl 'https://elma-smp.no/rest/api/document-types/4891fab2-03da-42b1-812b-a9cf624ea588' -i -u 'admin:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.document-types.get.v1+json;charset=UTF-8'Request
GET /rest/api/document-types/4891fab2-03da-42b1-812b-a9cf624ea588 HTTP/1.1
Accept: application/vnd.no.digdir.elma.document-types.get.v1+json;charset=UTF-8
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.noResponse
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 316
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 404,
"error" : "Not Found",
"exception" : "no.difi.elma.lang.NotFoundException",
"message" : "Unable to find instance with identifier '4891fab2-03da-42b1-812b-a9cf624ea588'.",
"path" : "/rest/api/document-types/4891fab2-03da-42b1-812b-a9cf624ea588"
}About the service
Path parameters
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/get/path-parameters.adoc[]
Response fields
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/get/response-fields.adoc[]
Add document type
Use this service to add a new document type.
Example 1 - Add a document type
Curl
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/add/curl-request.adoc[]Request
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/add/http-request.adoc[]Response
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/add/http-response.adoc[]Example 2 - Missing domain in input
Curl
$ curl 'https://elma-smp.no/rest/api/document-types' -i -u 'admin:pw123' -X POST \
-H 'Content-Type: application/vnd.no.digdir.elma.document-types.add.v1+json;charset=UTF-8' \
-H 'Accept: application/vnd.no.digdir.elma.document-types.add.v1+json;charset=UTF-8' \
-d '{
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"visible" : true,
"processes" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd",
"alias" : "Arkivmelding_Administrasjon",
"capabilities" : [ ],
"dependencies" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595cab",
"alias" : "Arkivmelding_Response",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:response:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Response",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ "705d8c8d-8ff1-4c21-a444-3e74815956cd" ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"title" : "Arkivmelding",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Administrasjon",
"visible" : true
} ]
}'Request
POST /rest/api/document-types HTTP/1.1
Content-Type: application/vnd.no.digdir.elma.document-types.add.v1+json;charset=UTF-8
Accept: application/vnd.no.digdir.elma.document-types.add.v1+json;charset=UTF-8
Content-Length: 1547
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.no
{
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"visible" : true,
"processes" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd",
"alias" : "Arkivmelding_Administrasjon",
"capabilities" : [ ],
"dependencies" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595cab",
"alias" : "Arkivmelding_Response",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:response:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Response",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ "705d8c8d-8ff1-4c21-a444-3e74815956cd" ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"title" : "Arkivmelding",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Administrasjon",
"visible" : true
} ]
}Response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 741
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 400,
"error" : "Bad Request",
"exception" : "org.springframework.web.bind.MethodArgumentNotValidException",
"message" : "Validation failed for object='documentTypeFormDTO'. Error count: 1",
"errors" : [ {
"objectName" : "documentTypeFormDTO",
"field" : "title",
"codes" : [ "NotEmpty.documentTypeFormDTO.title", "NotEmpty.title", "NotEmpty.java.lang.String", "NotEmpty" ],
"arguments" : [ {
"code" : "title",
"codes" : [ "documentTypeFormDTO.title", "title" ],
"defaultMessage" : "title"
} ],
"bindingFailure" : false,
"code" : "NotEmpty",
"defaultMessage" : "must not be empty"
} ],
"path" : "/rest/api/document-types"
}About the service
Request fields
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/add/request-fields.adoc[]
Response fields
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/add/response-fields.adoc[]
Update document type
Use this service to update a document type.
Example 1 - Update a document type
Curl
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/update/curl-request.adoc[]Request
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/update/http-request.adoc[]Response
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/update/http-response.adoc[]Example 2 - Missing domain in input
Curl
$ curl 'https://elma-smp.no/rest/api/document-types/8e83282a-577f-4b06-8207-f8d6674b0da7' -i -u 'admin:pw123' -X PUT \
-H 'Content-Type: application/vnd.no.digdir.elma.document-types.update.v1+json;charset=UTF-8' \
-H 'Accept: application/vnd.no.digdir.elma.document-types.update.v1+json;charset=UTF-8' \
-d '{
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"visible" : true,
"processes" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd",
"alias" : "Arkivmelding_Administrasjon",
"capabilities" : [ ],
"dependencies" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595cab",
"alias" : "Arkivmelding_Response",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:response:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Response",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ "705d8c8d-8ff1-4c21-a444-3e74815956cd" ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"title" : "Arkivmelding",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Administrasjon",
"visible" : true
} ]
}'Request
PUT /rest/api/document-types/8e83282a-577f-4b06-8207-f8d6674b0da7 HTTP/1.1
Content-Type: application/vnd.no.digdir.elma.document-types.update.v1+json;charset=UTF-8
Accept: application/vnd.no.digdir.elma.document-types.update.v1+json;charset=UTF-8
Content-Length: 1547
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.no
{
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"visible" : true,
"processes" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd",
"alias" : "Arkivmelding_Administrasjon",
"capabilities" : [ ],
"dependencies" : [ {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595cab",
"alias" : "Arkivmelding_Response",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:response:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Response",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ "705d8c8d-8ff1-4c21-a444-3e74815956cd" ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding",
"title" : "Arkivmelding",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da9",
"title" : "e-Government",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "Arkivmelding_Administrasjon",
"visible" : true
} ]
}Response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 778
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 400,
"error" : "Bad Request",
"exception" : "org.springframework.web.bind.MethodArgumentNotValidException",
"message" : "Validation failed for object='documentTypeFormDTO'. Error count: 1",
"errors" : [ {
"objectName" : "documentTypeFormDTO",
"field" : "title",
"codes" : [ "NotEmpty.documentTypeFormDTO.title", "NotEmpty.title", "NotEmpty.java.lang.String", "NotEmpty" ],
"arguments" : [ {
"code" : "title",
"codes" : [ "documentTypeFormDTO.title", "title" ],
"defaultMessage" : "title"
} ],
"bindingFailure" : false,
"code" : "NotEmpty",
"defaultMessage" : "must not be empty"
} ],
"path" : "/rest/api/document-types/8e83282a-577f-4b06-8207-f8d6674b0da7"
}About the service
Request fields
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/update/request-fields.adoc[]
Response fields
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/update/response-fields.adoc[]
Delete document type
Use this service to delete a document type.
Example 1 - Delete a document type
Curl
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/delete/curl-request.adoc[]Request
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/delete/http-request.adoc[]Response
Unresolved directive in document-types.adoc - include::../../../target/generated-snippets/document-types/delete/http-response.adoc[]Example 2 - Process not found
Curl
$ curl 'https://elma-smp.no/rest/api/document-types/4891fab2-03da-42b1-812b-a9cf624ea588' -i -u 'admin:pw123' -X DELETE \
-H 'Accept: application/vnd.no.digdir.elma.document-types.delete.v1+json;charset=UTF-8'Request
DELETE /rest/api/document-types/4891fab2-03da-42b1-812b-a9cf624ea588 HTTP/1.1
Accept: application/vnd.no.digdir.elma.document-types.delete.v1+json;charset=UTF-8
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.noResponse
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 316
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 404,
"error" : "Not Found",
"exception" : "no.difi.elma.lang.NotFoundException",
"message" : "Unable to find instance with identifier '4891fab2-03da-42b1-812b-a9cf624ea588'.",
"path" : "/rest/api/document-types/4891fab2-03da-42b1-812b-a9cf624ea588"
}Organizations
Find organization processes
The service is used to search for processes that are in use by an organization. The response is paged with a default page size of 10. Please note! The service should not be used to find out if an organization can receive a certain document type in the Peppol network. This service will only give such information for organization registered in ELMA. The correct way to do such a check for the Peppol network is to use a combination of SML and SMP. ELMA is only one of several SMPs in the Peppol network. The SML will give information on which SMP that contain more details about the organization. An example of a library performing a SML + SMP lookup can be found here: https://github.com/OxalisCommunity/vefa-peppol - More specifically: the LookupClient class.
Example 1 - Find all processes
Curl
Unresolved directive in organizations.adoc - include::../../../target/generated-snippets/organizations/processes/curl-request.adoc[]Request
Unresolved directive in organizations.adoc - include::../../../target/generated-snippets/organizations/processes/http-request.adoc[]Response
Unresolved directive in organizations.adoc - include::../../../target/generated-snippets/organizations/processes/http-response.adoc[]About the service
Path parameters
Unresolved directive in organizations.adoc - include::../../../target/generated-snippets/organizations/processes/path-parameters.adoc[]
Response fields
Unresolved directive in organizations.adoc - include::../../../target/generated-snippets/organizations/processes/response-fields.adoc[]
Participants
Find participants (Array)
The service is used to search for participants. The response is an array with all hits.
Example 1 - Find all participants
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/stream/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/stream/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/stream/http-response.adoc[]About the service
Request parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/stream/request-parameters.adoc[]
Response fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/stream/response-fields.adoc[]
Find participants (Paged)
The service is used to search for participants. The response is paged with a default page size of 10.
Example 1 - Find all participants
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/find/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/find/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/find/http-response.adoc[]Example 2 - Query on organization number
Curl
$ curl 'https://elma-smp.no/rest/api/participants?query=987654321' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8'Request
GET /rest/api/participants?query=987654321 HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 918
{
"content" : [ {
"identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321",
"icd" : "0192",
"organizationIdentifier" : "987654321",
"name" : "Snow Factory AS",
"registrationDate" : "2020-08-26",
"lastModificationDate" : "2020-09-02",
"contact" : {
"name" : "Snømannen Kalle",
"email" : "kalle@snowfactory.no",
"phoneNumber" : "111111111"
}
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 1,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}Example 3 - Query on name
Curl
$ curl 'https://elma-smp.no/rest/api/participants?query=snow+fa' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8'Request
GET /rest/api/participants?query=snow+fa HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 918
{
"content" : [ {
"identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321",
"icd" : "0192",
"organizationIdentifier" : "987654321",
"name" : "Snow Factory AS",
"registrationDate" : "2020-08-26",
"lastModificationDate" : "2020-09-02",
"contact" : {
"name" : "Snømannen Kalle",
"email" : "kalle@snowfactory.no",
"phoneNumber" : "111111111"
}
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 1,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}Example 4 - Query on lastModifiedDate
Curl
$ curl 'https://elma-smp.no/rest/api/participants?lastModificationDate=2020-09-02' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8'Request
GET /rest/api/participants?lastModificationDate=2020-09-02 HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 918
{
"content" : [ {
"identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321",
"icd" : "0192",
"organizationIdentifier" : "987654321",
"name" : "Snow Factory AS",
"registrationDate" : "2020-08-26",
"lastModificationDate" : "2020-09-02",
"contact" : {
"name" : "Snømannen Kalle",
"email" : "kalle@snowfactory.no",
"phoneNumber" : "111111111"
}
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 1,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}Example 5 - Query on lastModifiedDate range
Curl
$ curl 'https://elma-smp.no/rest/api/participants?lastModificationDateFrom=2020-01-01&lastModificationDateTo=2023-01-01' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8'Request
GET /rest/api/participants?lastModificationDateFrom=2020-01-01&lastModificationDateTo=2023-01-01 HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 918
{
"content" : [ {
"identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321",
"icd" : "0192",
"organizationIdentifier" : "987654321",
"name" : "Snow Factory AS",
"registrationDate" : "2020-08-26",
"lastModificationDate" : "2020-09-02",
"contact" : {
"name" : "Snømannen Kalle",
"email" : "kalle@snowfactory.no",
"phoneNumber" : "111111111"
}
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 1,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}Example 6 - Sorting
Curl
$ curl 'https://elma-smp.no/rest/api/participants?sort=registrationDate%2Casc' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8'Request
GET /rest/api/participants?sort=registrationDate%2Casc HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1382
{
"content" : [ {
"identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321",
"icd" : "0192",
"organizationIdentifier" : "987654321",
"name" : "Snow Factory AS",
"registrationDate" : "2020-08-26",
"lastModificationDate" : "2020-09-02",
"contact" : {
"name" : "Snømannen Kalle",
"email" : "kalle@snowfactory.no",
"phoneNumber" : "111111111"
}
}, {
"identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222",
"icd" : "0192",
"organizationIdentifier" : "222222222",
"name" : "Doofenshmirtz Evil Inc",
"registrationDate" : "2001-05-12",
"lastModificationDate" : "2020-09-01",
"contact" : {
"name" : "Heinz Doofenshmirtz",
"email" : "heinz.doofemshmirtz@evil.inc",
"phoneNumber" : "22222222"
}
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 2,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"totalElements" : 2,
"totalPages" : 1
}Example 7 - Paging
Curl
$ curl 'https://elma-smp.no/rest/api/participants?page=3&size=10' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8'Request
GET /rest/api/participants?page=3&size=10 HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1383
{
"content" : [ {
"identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321",
"icd" : "0192",
"organizationIdentifier" : "987654321",
"name" : "Snow Factory AS",
"registrationDate" : "2020-08-26",
"lastModificationDate" : "2020-09-02",
"contact" : {
"name" : "Snømannen Kalle",
"email" : "kalle@snowfactory.no",
"phoneNumber" : "111111111"
}
}, {
"identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222",
"icd" : "0192",
"organizationIdentifier" : "222222222",
"name" : "Doofenshmirtz Evil Inc",
"registrationDate" : "2001-05-12",
"lastModificationDate" : "2020-09-01",
"contact" : {
"name" : "Heinz Doofenshmirtz",
"email" : "heinz.doofemshmirtz@evil.inc",
"phoneNumber" : "22222222"
}
} ],
"empty" : false,
"first" : false,
"last" : true,
"number" : 3,
"numberOfElements" : 2,
"pageable" : {
"offset" : 30,
"pageNumber" : 3,
"pageSize" : 10,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 10,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 32,
"totalPages" : 4
}About the service
Request parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/find/request-parameters.adoc[]
Response fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/find/response-fields.adoc[]
Get participant
Use this service to get information about a participant.
Example 1 - Get a participant by qualified identifier
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/get/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/get/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/get/http-response.adoc[]Example 2 - Get a participant by identifier
Curl
$ curl 'https://elma-smp.no/rest/api/participants/a74363a2-1038-4a3f-a599-97ff860787e0' -i -u 'admin:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.get.v1+json;charset=UTF-8'Request
GET /rest/api/participants/a74363a2-1038-4a3f-a599-97ff860787e0 HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.get.v1+json;charset=UTF-8
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.participants.get.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2441
{
"identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0",
"qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222",
"icd" : "0192",
"organizationIdentifier" : "222222222",
"name" : "Doofenshmirtz Evil Inc",
"registrationDate" : "2001-05-12",
"lastModificationDate" : "2020-09-01",
"contact" : {
"name" : "Heinz Doofenshmirtz",
"email" : "heinz.doofemshmirtz@evil.inc",
"phoneNumber" : "22222222"
},
"provider" : {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"title" : "The Big Bank"
},
"processes" : [ {
"identifier" : "adf9c140-995e-4be6-a1be-a09add595423",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"domain" : "Post-Award",
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"restricted" : false,
"visible" : true,
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"title" : "peppolbis_order"
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"title" : "TEST DEPENDENCY",
"restricted" : false,
"visible" : true
} ],
"requiredICDs" : [ "0192" ]
}, {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0",
"domain" : "Post-Award",
"title" : "PEPPOLBIS_28A_2.0",
"alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)",
"restricted" : false,
"visible" : true,
"capabilities" : [ ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"dependencies" : [ ],
"requiredICDs" : [ "0192" ]
} ]
}Example 3 - Not found
Curl
$ curl 'https://elma-smp.no/rest/api/participants/iso6523-actorid-upis::0192:333333333' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.participants.get.v1+json;charset=UTF-8'Request
GET /rest/api/participants/iso6523-actorid-upis::0192:333333333 HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.get.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 302
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 404,
"error" : "Not Found",
"exception" : "no.difi.elma.lang.NotFoundException",
"message" : "Couldn't find organization for iso6523-actorid-upis::0192:333333333",
"path" : "/rest/api/participants/iso6523-actorid-upis::0192:333333333"
}About the service
Path parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/get/path-parameters.adoc[]
Response fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/get/response-fields.adoc[]
Add participant
Use this service to add a new participant.
Example 1 - Add a participant
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/add/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/add/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/add/http-response.adoc[]Example 2 - Missing contact in input
Curl
$ curl 'https://elma-smp.no/rest/api/participants' -i -u 'sp1:pw123' -X POST \
-H 'Content-Type: application/vnd.no.digdir.elma.participants.add.v1+json;charset=UTF-8' \
-H 'Accept: application/vnd.no.digdir.elma.participants.add.v1+json;charset=UTF-8' \
-d '{
"icd" : "0192",
"organizationIdentifier" : "222222222",
"processes" : [ {
"identifier" : "adf9c140-995e-4be6-a1be-a09add595423",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"visible" : true
} ]
}'Request
POST /rest/api/participants HTTP/1.1
Content-Type: application/vnd.no.digdir.elma.participants.add.v1+json;charset=UTF-8
Accept: application/vnd.no.digdir.elma.participants.add.v1+json;charset=UTF-8
Content-Length: 1619
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.no
{
"icd" : "0192",
"organizationIdentifier" : "222222222",
"processes" : [ {
"identifier" : "adf9c140-995e-4be6-a1be-a09add595423",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"visible" : true
} ]
}Response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 775
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 400,
"error" : "Bad Request",
"exception" : "org.springframework.web.bind.MethodArgumentNotValidException",
"message" : "Validation failed for object='addParticipantFormDTO'. Error count: 1",
"errors" : [ {
"objectName" : "addParticipantFormDTO",
"field" : "contact",
"codes" : [ "NotNull.addParticipantFormDTO.contact", "NotNull.contact", "NotNull.no.difi.elma.dto.rest.ContactFormDTO", "NotNull" ],
"arguments" : [ {
"code" : "contact",
"codes" : [ "addParticipantFormDTO.contact", "contact" ],
"defaultMessage" : "contact"
} ],
"bindingFailure" : false,
"code" : "NotNull",
"defaultMessage" : "must not be null"
} ],
"path" : "/rest/api/participants"
}About the service
Request fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/add/request-fields.adoc[]
Response fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/add/response-fields.adoc[]
Update participant
Use this service to update a participant.
Example 1 - Update a participant
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/update/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/update/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/update/http-response.adoc[]Example 2 - Missing contact in input
Curl
$ curl 'https://elma-smp.no/rest/api/participants/iso6523-actorid-upis::0192:222222222' -i -u 'sp1:pw123' -X PUT \
-H 'Content-Type: application/vnd.no.digdir.elma.participants.update.v1+json;charset=UTF-8' \
-H 'Accept: application/vnd.no.digdir.elma.participants.update.v1+json;charset=UTF-8' \
-d '{
"icd" : "0192",
"organizationIdentifier" : "222222222",
"processes" : [ {
"identifier" : "adf9c140-995e-4be6-a1be-a09add595423",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"visible" : true
} ]
}'Request
PUT /rest/api/participants/iso6523-actorid-upis::0192:222222222 HTTP/1.1
Content-Type: application/vnd.no.digdir.elma.participants.update.v1+json;charset=UTF-8
Accept: application/vnd.no.digdir.elma.participants.update.v1+json;charset=UTF-8
Content-Length: 1619
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.no
{
"icd" : "0192",
"organizationIdentifier" : "222222222",
"processes" : [ {
"identifier" : "adf9c140-995e-4be6-a1be-a09add595423",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"visible" : true
} ]
}Response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 824
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 400,
"error" : "Bad Request",
"exception" : "org.springframework.web.bind.MethodArgumentNotValidException",
"message" : "Validation failed for object='updateParticipantFormDTO'. Error count: 1",
"errors" : [ {
"objectName" : "updateParticipantFormDTO",
"field" : "contact",
"codes" : [ "NotNull.updateParticipantFormDTO.contact", "NotNull.contact", "NotNull.no.difi.elma.dto.rest.ContactFormDTO", "NotNull" ],
"arguments" : [ {
"code" : "contact",
"codes" : [ "updateParticipantFormDTO.contact", "contact" ],
"defaultMessage" : "contact"
} ],
"bindingFailure" : false,
"code" : "NotNull",
"defaultMessage" : "must not be null"
} ],
"path" : "/rest/api/participants/iso6523-actorid-upis::0192:222222222"
}About the service
Request fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/update/request-fields.adoc[]
Path parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/update/path-parameters.adoc[]
Response fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/update/response-fields.adoc[]
Delete participant
Use this service to delete a participant.
Example 1 - Delete a participant by qualified identifier
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete/http-response.adoc[]Example 2 - Delete a participant by identifier
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete-by-identifier/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete-by-identifier/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete-by-identifier/http-response.adoc[]Example 3 - Not found
Curl
$ curl 'https://elma-smp.no/rest/api/participants/iso6523-actorid-upis::0192:333333333' -i -u 'sp1:pw123' -X DELETE \
-H 'Accept: application/vnd.no.digdir.elma.participants.delete.v1+json;charset=UTF-8'Request
DELETE /rest/api/participants/iso6523-actorid-upis::0192:333333333 HTTP/1.1
Accept: application/vnd.no.digdir.elma.participants.delete.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 302
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 404,
"error" : "Not Found",
"exception" : "no.difi.elma.lang.NotFoundException",
"message" : "Couldn't find organization for iso6523-actorid-upis::0192:333333333",
"path" : "/rest/api/participants/iso6523-actorid-upis::0192:333333333"
}About the service
There are two variants.
By qualified identifier
Path parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete/path-parameters.adoc[]
By UUID identifier
Path parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/delete-by-identifier/path-parameters.adoc[]
Get participant processes
Use this service to get processes belonging to a participant.
Example 1 - Get participant processes by qualified identifier
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes/http-response.adoc[]Example 2 - Get participant processes by identifier
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes-by-identifier/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes-by-identifier/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes-by-identifier/http-response.adoc[]About the service
Path parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes/path-parameters.adoc[]
Response fields
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/processes/response-fields.adoc[]
Transfer participant
Use this service to transfer a participant to another service provider.
Example 1 - Transfer participant
Curl
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/transfer/curl-request.adoc[]Request
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/transfer/http-request.adoc[]Response
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/transfer/http-response.adoc[]About the service
Path parameters
Unresolved directive in participants.adoc - include::../../../target/generated-snippets/participants/transfer/path-parameters.adoc[]
Processes
Find processes (Array)
The service is used to search for Processes. The response is an array.
Example 1 - Find all Processes
Curl
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/stream/curl-request.adoc[]Request
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/stream/http-request.adoc[]Response
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/stream/http-response.adoc[]About the service
Response fields
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/stream/response-fields.adoc[]
Find processes (Paged)
The service is used to search for Processes. The response is paged with a default page size of 10.
Example 1 - Find all Processes
Curl
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/find/curl-request.adoc[]Request
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/find/http-request.adoc[]Response
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/find/http-response.adoc[]Example 2 - Sorting
Curl
$ curl 'https://elma-smp.no/rest/api/processes?sort=qualifiedIdentifier.value%2Casc' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.processes.find.v1+json;charset=UTF-8'Request
GET /rest/api/processes?sort=qualifiedIdentifier.value%2Casc HTTP/1.1
Accept: application/vnd.no.digdir.elma.processes.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.processes.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2236
{
"content" : [ {
"identifier" : "adf9c140-995e-4be6-a1be-a09add595423",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"domain" : "Post-Award",
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"restricted" : false,
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"title" : "peppolbis_order"
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something"
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"title" : "TEST DEPENDENCY",
"restricted" : false
} ],
"requiredICDs" : [ "0192" ]
}, {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0",
"domain" : "Post-Award",
"title" : "PEPPOLBIS_28A_2.0",
"alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)",
"restricted" : false,
"capabilities" : [ ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something"
} ],
"dependencies" : [ ],
"requiredICDs" : [ "0192" ]
} ],
"empty" : false,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 2,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 30,
"paged" : true,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"unpaged" : false
},
"size" : 30,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"totalElements" : 2,
"totalPages" : 1
}Example 3 - Paging
Curl
$ curl 'https://elma-smp.no/rest/api/processes?page=3&size=10' -i -u 'sp1:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.processes.find.v1+json;charset=UTF-8'Request
GET /rest/api/processes?page=3&size=10 HTTP/1.1
Accept: application/vnd.no.digdir.elma.processes.find.v1+json;charset=UTF-8
Authorization: Basic c3AxOnB3MTIz
Host: elma-smp.noResponse
HTTP/1.1 200 OK
Content-Type: application/vnd.no.digdir.elma.processes.find.v1+json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2237
{
"content" : [ {
"identifier" : "adf9c140-995e-4be6-a1be-a09add595423",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"domain" : "Post-Award",
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"restricted" : false,
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"title" : "peppolbis_order"
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something"
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"title" : "TEST DEPENDENCY",
"restricted" : false
} ],
"requiredICDs" : [ "0192" ]
}, {
"identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0",
"domain" : "Post-Award",
"title" : "PEPPOLBIS_28A_2.0",
"alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)",
"restricted" : false,
"capabilities" : [ ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something"
} ],
"dependencies" : [ ],
"requiredICDs" : [ "0192" ]
} ],
"empty" : false,
"first" : false,
"last" : true,
"number" : 3,
"numberOfElements" : 2,
"pageable" : {
"offset" : 30,
"pageNumber" : 3,
"pageSize" : 10,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"unpaged" : false
},
"size" : 10,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"totalElements" : 32,
"totalPages" : 4
}About the service
Request parameters
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/find/request-parameters.adoc[]
Response fields
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/find/response-fields.adoc[]
Get process
Use this service to get information about a process.
Example 1 - Get a process by identifier
Curl
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/get/curl-request.adoc[]Request
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/get/http-request.adoc[]Response
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/get/http-response.adoc[]Example 2 - Not found
Curl
$ curl 'https://elma-smp.no/rest/api/processes/4891fab2-03da-42b1-812b-a9cf624ea588' -i -u 'admin:pw123' -X GET \
-H 'Accept: application/vnd.no.digdir.elma.processes.get.v1+json;charset=UTF-8'Request
GET /rest/api/processes/4891fab2-03da-42b1-812b-a9cf624ea588 HTTP/1.1
Accept: application/vnd.no.digdir.elma.processes.get.v1+json;charset=UTF-8
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.noResponse
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 311
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 404,
"error" : "Not Found",
"exception" : "no.difi.elma.lang.NotFoundException",
"message" : "Unable to find instance with identifier '4891fab2-03da-42b1-812b-a9cf624ea588'.",
"path" : "/rest/api/processes/4891fab2-03da-42b1-812b-a9cf624ea588"
}About the service
Path parameters
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/get/path-parameters.adoc[]
Response fields
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/get/response-fields.adoc[]
Add process
Use this service to add a new process.
Example 1 - Add a process
Curl
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/add/curl-request.adoc[]Request
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/add/http-request.adoc[]Response
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/add/http-response.adoc[]Example 2 - Missing domain in input
Curl
$ curl 'https://elma-smp.no/rest/api/processes' -i -u 'admin:pw123' -X POST \
-H 'Content-Type: application/vnd.no.digdir.elma.processes.add.v1+json;charset=UTF-8' \
-H 'Accept: application/vnd.no.digdir.elma.processes.add.v1+json;charset=UTF-8' \
-d '{
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"restricted" : false,
"visible" : true,
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"requiredICDs" : [ "0192" ]
}'Request
POST /rest/api/processes HTTP/1.1
Content-Type: application/vnd.no.digdir.elma.processes.add.v1+json;charset=UTF-8
Accept: application/vnd.no.digdir.elma.processes.add.v1+json;charset=UTF-8
Content-Length: 1268
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.no
{
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"restricted" : false,
"visible" : true,
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"requiredICDs" : [ "0192" ]
}Response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 717
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 400,
"error" : "Bad Request",
"exception" : "org.springframework.web.bind.MethodArgumentNotValidException",
"message" : "Validation failed for object='processFormDTO'. Error count: 1",
"errors" : [ {
"objectName" : "processFormDTO",
"field" : "domain",
"codes" : [ "NotNull.processFormDTO.domain", "NotNull.domain", "NotNull.java.lang.String", "NotNull" ],
"arguments" : [ {
"code" : "domain",
"codes" : [ "processFormDTO.domain", "domain" ],
"defaultMessage" : "domain"
} ],
"bindingFailure" : false,
"code" : "NotNull",
"defaultMessage" : "must not be null"
} ],
"path" : "/rest/api/processes"
}About the service
Request fields
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/add/request-fields.adoc[]
Response fields
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/add/response-fields.adoc[]
Update process
Use this service to update a process.
Example 1 - Update a process
Curl
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/update/curl-request.adoc[]Request
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/update/http-request.adoc[]Response
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/update/http-response.adoc[]Example 2 - Missing domain in input
Curl
$ curl 'https://elma-smp.no/rest/api/processes/adf9c140-995e-4be6-a1be-a09add595423' -i -u 'admin:pw123' -X PUT \
-H 'Content-Type: application/vnd.no.digdir.elma.processes.update.v1+json;charset=UTF-8' \
-H 'Accept: application/vnd.no.digdir.elma.processes.update.v1+json;charset=UTF-8' \
-d '{
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"restricted" : false,
"visible" : true,
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"requiredICDs" : [ "0192" ]
}'Request
PUT /rest/api/processes/adf9c140-995e-4be6-a1be-a09add595423 HTTP/1.1
Content-Type: application/vnd.no.digdir.elma.processes.update.v1+json;charset=UTF-8
Accept: application/vnd.no.digdir.elma.processes.update.v1+json;charset=UTF-8
Content-Length: 1268
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.no
{
"title" : "PEPPOLBIS_3_0_BILLING_01_UBL",
"alias" : "PEPPOL BIS Billing 3.0 (01, UBL)",
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
"restricted" : false,
"visible" : true,
"capabilities" : [ {
"identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa",
"processes" : [ ],
"title" : "peppolbis_order"
} ],
"documentTypes" : [ {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"processes" : [ ],
"qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1",
"title" : "something",
"visible" : true
} ],
"dependencies" : [ {
"identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd",
"capabilities" : [ ],
"dependencies" : [ ],
"documentTypes" : [ ],
"domain" : {
"identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7",
"title" : "Post-Award",
"visible" : true
},
"qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep",
"requiredIcds" : [ "0192" ],
"restricted" : false,
"title" : "TEST DEPENDENCY",
"visible" : true
} ],
"requiredICDs" : [ "0192" ]
}Response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 754
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 400,
"error" : "Bad Request",
"exception" : "org.springframework.web.bind.MethodArgumentNotValidException",
"message" : "Validation failed for object='processFormDTO'. Error count: 1",
"errors" : [ {
"objectName" : "processFormDTO",
"field" : "domain",
"codes" : [ "NotNull.processFormDTO.domain", "NotNull.domain", "NotNull.java.lang.String", "NotNull" ],
"arguments" : [ {
"code" : "domain",
"codes" : [ "processFormDTO.domain", "domain" ],
"defaultMessage" : "domain"
} ],
"bindingFailure" : false,
"code" : "NotNull",
"defaultMessage" : "must not be null"
} ],
"path" : "/rest/api/processes/adf9c140-995e-4be6-a1be-a09add595423"
}About the service
Request fields
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/update/request-fields.adoc[]
Response fields
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/update/response-fields.adoc[]
Delete process
Use this service to delete a process.
Example 1 - Delete a process
Curl
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/delete/curl-request.adoc[]Request
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/delete/http-request.adoc[]Response
Unresolved directive in processes.adoc - include::../../../target/generated-snippets/processes/delete/http-response.adoc[]Example 2 - Process not found
Curl
$ curl 'https://elma-smp.no/rest/api/processes/4891fab2-03da-42b1-812b-a9cf624ea588' -i -u 'admin:pw123' -X DELETE \
-H 'Accept: application/vnd.no.digdir.elma.processes.delete.v1+json;charset=UTF-8'Request
DELETE /rest/api/processes/4891fab2-03da-42b1-812b-a9cf624ea588 HTTP/1.1
Accept: application/vnd.no.digdir.elma.processes.delete.v1+json;charset=UTF-8
Authorization: Basic YWRtaW46cHcxMjM=
Host: elma-smp.noResponse
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 311
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 404,
"error" : "Not Found",
"exception" : "no.difi.elma.lang.NotFoundException",
"message" : "Unable to find instance with identifier '4891fab2-03da-42b1-812b-a9cf624ea588'.",
"path" : "/rest/api/processes/4891fab2-03da-42b1-812b-a9cf624ea588"
}Errors
Response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 775
{
"timestamp" : "2019-03-25T12:38:23.000",
"status" : 400,
"error" : "Bad Request",
"exception" : "org.springframework.web.bind.MethodArgumentNotValidException",
"message" : "Validation failed for object='addParticipantFormDTO'. Error count: 1",
"errors" : [ {
"objectName" : "addParticipantFormDTO",
"field" : "contact",
"codes" : [ "NotNull.addParticipantFormDTO.contact", "NotNull.contact", "NotNull.no.difi.elma.dto.rest.ContactFormDTO", "NotNull" ],
"arguments" : [ {
"code" : "contact",
"codes" : [ "addParticipantFormDTO.contact", "contact" ],
"defaultMessage" : "contact"
} ],
"bindingFailure" : false,
"code" : "NotNull",
"defaultMessage" : "must not be null"
} ],
"path" : "/rest/api/participants"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Date and time for when the error occured. |
|
|
HTTP status code. |
|
|
Error description |
|
|
The java class of the Exception that was thrown |
|
|
A message describing the error. |
|
|
The request URI |
|
|
A more detailed description of the error. |
|
|
Constraint validations details. |
|
|
The message codes to be used to resolve this message. |
|
|
The default message to be used to resolve this message. |
|
|
The message codes to be used to resolve this message. |
|
|
The default message to be used to resolve this message. |
|
|
The name/path of the object where the constraint validation occurred. |
|
|
The name/path of the field where the constraint validation occurred. |
|
|
The rejected field value. |
|
|
Whether this error represents a binding failure (like a type mismatch); otherwise it is a validation failure. |
|
|
The message code to be used to resolve this message. |
|
|
Constraint arguments. |
|
|
The message codes to be used to resolve this argument. |
|
|
The default message to be used to resolve this argument. |
|
|
The message code to be used to resolve this argument. |
|
|
The message codes to be used to resolve this argument. |
|
|
The default message to be used to resolve this argument. |
|
|
The message code to be used to resolve this argument. |
Versioning
Active versions
| Method | URL | Accept-Header |
|---|---|---|
GET |
application/vnd.no.digdir.elma.accesspoints.find.v1+json |
|
GET |
application/vnd.no.digdir.elma.accesspoints.get.v1+json |
|
GET |
application/vnd.no.digdir.elma.document-types.find.v1+json |
|
GET |
application/vnd.no.digdir.elma.document-types.get.v1+json |
|
POST |
application/vnd.no.digdir.elma.document-types.add.v1+json |
|
PUT |
application/vnd.no.digdir.elma.document-types.update.v1+json |
|
DELETE |
application/vnd.no.digdir.elma.document-types.delete.v1+json |
|
GET |
application/vnd.no.digdir.elma.organization.processes.v1+json |
|
GET |
application/vnd.no.digdir.elma.participants.stream.v1+json |
|
GET |
application/vnd.no.digdir.elma.participants.find.v1+json |
|
GET |
application/vnd.no.digdir.elma.participants.get.v1+json |
|
GET |
application/vnd.no.digdir.elma.participants.get.v1+json |
|
POST |
application/vnd.no.digdir.elma.participants.add.v1+json |
|
PUT |
application/vnd.no.digdir.elma.participants.update.v1+json |
|
DELETE |
application/vnd.no.digdir.elma.participants.delete.v1+json |
|
DELETE |
application/vnd.no.digdir.elma.participants.delete.v1+json |
|
GET |
application/vnd.no.digdir.elma.participants.processes.v1+json |
|
GET |
/rest/api/participants/{identifier}/processes |
application/vnd.no.digdir.elma.participants.processes.v1+json |
PUT |
/rest/api/participants/{qualifiedIdentifier}/transfer/{serviceProviderIdentifier} |
application/vnd.no.digdir.elma.participants.transfer.v1+json |
GET |
application/vnd.no.digdir.elma.processes.stream.v1+json |
|
GET |
application/vnd.no.digdir.elma.processes.find.v1+json |
|
GET |
application/vnd.no.digdir.elma.processes.get.v1+json |
|
POST |
application/vnd.no.digdir.elma.processes.add.v1+json |
|
PUT |
application/vnd.no.digdir.elma.processes.update.v1+json |
|
DELETE |
application/vnd.no.digdir.elma.processes.delete.v1+json |