Submitting request for aggregated identifiers

Example

POST https://idissuer.pl/api/v3/identifiers/aggregated/requests
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}} 
{
  "economicOperatorId": "PWPK0000001",
  "facilityId": "PWPK0000002",
  "quantity": 1000,
  "processImmediately": false
}
              

"processImmediately" - option "true" results in processing of the request without 24-hour waiting period for a possible cancellation decision.

Response

HTTP/1.1 201 Created
Connection: close
Date: Thu, 11 Jan 2024 09:23:37 GMT
Content-Type: application/json; charset=utf-8
Location: /api/v3/identifiers/aggregated/requests/10
{
    "aggregatedIdentifiersRequestId": 10
}
                

Get details of request for aggregated identifiers

Example

GET https://idissuer.pl/api/v3/identifiers/aggregated/requests/10
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}
                

Response

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 09:42:24 GMT
Content-Type: application/json; charset=utf-8
{
    "aggregatedIdentifiersRequestId": 10,
    "economicOperatorId": "PWPK0000001",
    "facilityId": "PWPK0000002",
    "quantity": 1000,
    "processImmediately": true,
    "registrationDate": "2024-01-11T09:23:38.0369064+00:00",
    "status": "PassedToGeneration"
}
                

Aggregated identifiers request states

New
Rejected - request rejected
Accepted - request accepted, awaiting 24 hours for cancellation
CanceledByClient - request cancelled
PassedToGeneration - request accepted without possibility for cancellation or 24 hours cancellation period ended

Aggregated identifiers rejection reasons

ContractNotExisting
ContractNotValid
EONotActive
UserHasNoAccessToEO
FacilityNotActive
UserHasNoAccessToFacility
FacilityNotAssignedToEO
EONotExistingInRouter
FacilityNotExistingInRouter
FacilityNotAssignedToEOInRouter
SingleValueAddressExisting
LegacyTechnicalError

Cancellation of request for aggregated identifiers

Example

PUT https://idissuer.pl/api/v3/identifiers/aggregated/requests/11/cancellation
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}
{
  "economicOperatorId": "PWPK0000001",
  "cancellationReason": "EventNotMaterialise",
  "cancellationDescription": "",
  "cancellationAdditionalDescription": ""
}
                

Response

HTTP/1.1 204 No Content
Date: Thu, 11 Jan 2024 10:34:25 GMT
Content-Type: application/json; charset=utf-8
                

Aggregated identifiers cancellation reasons

EventNotMaterialise
ErroneousInformation
Other

Search requests for aggregated identifiers

Example

GET https://idissuer.pl/api/v3/identifiers/aggregated/requests?economicOperatorId=PWPK0000001
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}
                

Search parameters

economicOperatorId
facilityId
status - status of request
registrationDateFrom
registrationDateTo
pageNumber
pageSize - amount of items per page (max 100)

Response

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 10:34:25 GMT
Content-Type: application/json; charset=utf-8
{
    "items": [
        {
            "aggregatedIdentifiersRequestId": 11,
            "economicOperatorId": "PWPK0000001",
            "facilityId": "PWPK0000002",
            "quantity": 1000,
            "processImmediately": false,
            "creationDate": "2024-01-11T10:33:55.5339401+00:00",
            "status": "CanceledByClient"
        },
        {
            "aggregatedIdentifiersRequestId": 10,
            "economicOperatorId": "PWPK0000001",
            "facilityId": "PWPK0000002",
            "quantity": 1000,
            "processImmediately": true,
            "creationDate": "2024-01-11T09:23:38.0369064+00:00",
            "status": "PassedToGeneration"
        }
    ],
    "pagesCount": 1,
    "totalItemsCount": 2,
    "pageNumber": 1,
    "pageSize": 25
}
                                        

Getting details of aggregated identifiers

After request is in state "PassedToGeneration" identifiers are generated

Example

GET https://idissuer.pl/api/v3/identifiers/aggregated/10
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}}
                                  

Response

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 09:42:24 GMT
Content-Type: application/json; charset=utf-8
{
    "aggregatedIdentifiersRequestId": 10,
    "quantity": 1000,
    "registrationDate": "2024-01-11T09:23:38.0369064+00:00",
    "status": "Synchronized"
}
    

Identifiers states

PassedToGeneration - waiting for generation
Generated - waiting for synchronization
Synchronized - synchronized with Dentsu - ready to download
CannotSynchronize - synchronization error - cannot be download
Downloaded
DownloadConfirmed

Search aggregated identifiers

Example

GET https://idissuer.pl/api/v3/identifiers/aggregated?status=Synchronized
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}
                    

Search parameters

status - status of request
registrationDateFrom
registrationDateTo
pageNumber
pageSize - amount of items per page (max 100)

Response

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 10:34:25 GMT
Content-Type: application/json; charset=utf-8
{
    "items": [
        {
            "aggregatedIdentifiersRequestId": 10,
            "quantity": 1000,
            "registrationDate": "2024-01-11T09:23:38.0369064+00:00",
            "status": "Synchronized"
        }
    ],
    "pagesCount": 1,
    "totalItemsCount": 1,
    "pageNumber": 1,
    "pageSize": 25
}

Download aggregated identifiers

Identifiers are ready to download when in state "Synchronized". They download as csv file with identifiers list inside.

Example

GET https://idissuer.pl/api/v3/identifiers/aggregated/10/csv
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}}
            

Response

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 09:42:24 GMT
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=10.csv; filename*=UTF-8''10.csv
            

Confirm aggregated identifiers

Example

PUT https://idissuer.pl/api/v3/identifiers/aggregated/10/confirmation
Content-Type: application/json
Authorization: Bearer {{AUTH_TOKEN}}
{
  "checksum": "f741c63818a3ea47ec5492e86b1c1b2432fecb5eb4ceb3a5fe57cd6c091b91fb"
}
            

Checksum is calculated with SHA256 from csv file.

Odpowiedź

    HTTP/1.1 204 No Content
    Date: Thu, 11 Jan 2024 09:42:24 GMT
    Content-Type: application/json; charset=utf-8