Złożenie wniosku o identyfikatory zbiorcze

Przykład

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" - opcja "true" spowoduje rozpoczęcie przetwarzania wniosku z pominięciem 24-godzinnego okresu oczekiwania na ewentualną decyzję o anulowaniu.

Odpowiedź

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
{
    "requestId": 10
}
                

Pobranie szczegółów wniosku o identyfikatory zbiorcze

Przykład

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

Odpowiedź

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 09:42:24 GMT
Content-Type: application/json; charset=utf-8
{
"requestId": 1,
  "economicOperatorId": "PWPS0000001",
  "facilityId": "PWPS0000002",
  "quantity": 1000,
  "status": "PassedToGeneration",
  "processImmediately": true,
  "createdOn": "2023-12-21T09:00:00.000Z",
  "createdBy": "submitting.user@pwpw.pl",
  "rejectionReason": null
}
                                

Statusy wniosków o identyfikatory zbiorcze

New - nowy
Rejected - wniosek odrzucony
Accepted - wniosek zaakceptowany, oczekuje 24 godziny na anulowanie
CanceledByClient - wniosek anulowany
PassedToGeneration - wniosek został zaakceptowany bez możliwości anulowania lub upłynął 24 godzinny okres na anulowanie

Powody odrzucenia wniosków o identyfikatory zbiorcze

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

Anulowanie wniosków o identyfikatory zbiorcze

Przykład

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": ""
}
                        

Odpowiedź

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

Powody odrzucenia wniosków o identyfikatory zbiorcze (cancellationReason)

EventNotMaterialise
ErroneousInformation
Other

Wyszukiwanie wniosków o identyfikatory zbiorcze

Przykład

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

Dopuszczalne parametry wyszukiwania

requestId - Identyfikator wniosku
economicOperatorId - Identyfikator podmiotu
facilityId - Identyfikator zakładu
status - Status wniosku
createdOnFrom - Data rejestracji "od"
createdOnTo - Data rejestracji "do"
pageNumber - numer wybranej strony
pageSize - ilość rekordów na stronę (max 100)

Odpowiedź

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 10:34:25 GMT
Content-Type: application/json; charset=utf-8
{
    "items": [
         {
          "requestId": 1,
          "economicOperatorId": "PWPS0000001",
          "facilityId": "PWPS0000002",
          "quantity": 1000,
          "status": "PassedToGeneration",
          "processImmediately": true,
          "createdBy": "submitting.user@pwpw.pl",
          "createdOn": "2023-12-21T09:00:00.000Z"
        },
        {
            "requestId": 10,
            "economicOperatorId": "PWPK0000001",
            "facilityId": "PWPK0000002",
            "quantity": 1000,
            "status": "PassedToGeneration"
            "processImmediately": true,
            "createdBy": "submitting.user@pwpw.pl",
            "createdOn": "2024-01-11T09:23:38.0369064+00:00"
        }
    ],
    "pagesCount": 1,
    "totalItemsCount": 2,
    "pageNumber": 1,
    "pageSize": 25
}

Pobranie szczegółów identyfikatorów zbiorczych

Po przejściu wniosku w status "PassedToGeneration" generowane są identyfikatory na opakowania

Przykład

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

Odpowiedź

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 09:42:24 GMT
Content-Type: application/json; charset=utf-8
{
  "requestId": 1,
  "quantity": 1000,
  "createdOn": "2023-12-21T09:00:00.000Z",
  "createdBy": "submitting.user@pwpw.pl",
  "status": "Synchronized"
}
                                

Statusy identyfikatorów

PassedToGeneration - oczekujące na generowanie
Generated - wygenerowane, oczekujące na proces synchronizacji
Synchronized - zsynchronizwane z Dentsu - gotowe do pobrania
CannotSynchronize - błąd synchronizacji - nie można pobrać
Downloaded - pobrane
DownloadConfirmed - potwierdzone

Wyszukiwanie identyfikatorów zbiorczych

Przykład

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

Dopuszczalne parametry wyszukiwania

requestId - Identyfikator wniosku
status - Status wniosku
createdOnFrom - Data rejestracji "od"
createdOnTo - Data rejestracji "do"
pageNumber - numer wybranej strony
pageSize - ilość rekordów na stronę (max 100)

Odpowiedź

HTTP/1.1 200 OK
Date: Thu, 11 Jan 2024 10:34:25 GMT
Content-Type: application/json; charset=utf-8
{
    "items": [
         {
      "requestId": 1,
      "status": "Synchronized",
      "quantity": 1000,
      "createdBy": "submitting.user@pwpw.pl",
      "createdOn": "2023-12-21T09:00:00.000Z"
    }
    ],
    "pagesCount": 1,
    "totalItemsCount": 1,
    "pageNumber": 1,
    "pageSize": 25
}

Pobranie identyfikatorów zbiorczych

Identyfikatory są gotowe do pobrania w statusie "Synchronized". Formatem wynikowym jest plik csv z listą identyfikatorów.

Przykład

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

Odpowiedź

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
        

Potwierdzanie identyfikatorów zbiorczych

Przykład

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

Suma kontrolna jest wyliczana algorytmem SHA256 z pliku csv.

Odpowiedź

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