/api/2/registration

`/api/2/registration`

Táto služba umožňuje narábať s registráciami na elektronické doručovanie skrz Zelenú poštu.

`createRegistration`

Vytvorí registráciu na dané UID a PIN s vloženým vlastným komentárom. Registrácia je vytvorená pre prihláseného používateľa.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <createRegistrationRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration">
            <uid>[string?]</uid>
            <pin>[string?]</pin>
            <comment>[string?]</comment>
        </createRegistrationRequest>
    </Body>
</Envelope>

Názov	Popis
`uid`	UID kód.
`pin`	PIN kód.
`comment`	Vlastný komentár k registrácii, ktorý sa zobrazí ako poznámka na portáli.

Odpoveďou je detail vytvorenej registrácie.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body>
        <ns6:createRegistrationResponse>
            <ns6:registration>
                <ns6:id>38339</ns6:id>
                <ns6:senderCustomerId>16203</ns6:senderCustomerId>
                <ns6:name>Bratislavská vodárenská spoločnosť, a. s.</ns6:name>
                <ns6:createdOn>2020-02-25T14:45:29.636+01:00</ns6:createdOn>
                <ns6:updatedOn>2020-02-25T14:45:29.518+01:00</ns6:updatedOn>
                <ns6:recipientCustomerId>59</ns6:recipientCustomerId>
                <ns6:senderAccountId>15838</ns6:senderAccountId>
                <ns6:senderAvatar>16203.png</ns6:senderAvatar>
                <ns6:deliveryId>35465</ns6:deliveryId>
                <ns6:uiz1>koduiz1</ns6:uiz1>
                <ns6:uiz2>koduiz2</ns6:uiz2>
                <ns6:comment>moja prva registracia</ns6:comment>
                <ns6:enabled>true</ns6:enabled>
                <ns6:archiveEnabled>true</ns6:archiveEnabled>
                <ns6:requestBankAccount>false</ns6:requestBankAccount>
                <ns6:rawData>false</ns6:rawData>
                <ns6:dueNotifications>true</ns6:dueNotifications>
                <ns6:alwaysPaid>false</ns6:alwaysPaid>
            </ns6:registration>
        </ns6:createRegistrationResponse>
    </soap:Body>
</soap:Envelope>

Názov	Popis
`id`	Číselný identifikátor vytvorenej registrácie.
`senderCustomerId`	Odosielateľove ID.
`name`	Názov odosielateľa.
`createdOn`	Dátum vytvorenia registrácie.
`updatedOn`	Dátum úpravy registrácie.
`recipientCustomerId`	ID príjmateľa.
`senderAccountId`	ID účtu príjmateľa.
`senderAvatar`	Ikona odosielateľa.
`deliveryId`	ID doručovania.
`uiz1`	Identifikátor zákazníka 1.
`uiz2`	Identifikátor zákazníka 2.
`comment`	Poznámka k registrácii.
`enabled`	Pravdivostná hodnota vyjadrujúca, či je registrácia zapnutá.
`archiveEnabled`	Pravdivostná hodnota vyjadrujúca, či je zapnutá archivácia registrácie.
`requestBankAccount`	Pravdivostná hodnota vyjadrujúca, či je potrebný IBAN.
`rawData`	Špecifické nastavenie o príjmaní surových dát.
`dueNotifications`	Pravdivostná hodnota vyjadrujúca, či sa posielajú notifikácie o splatnosti.
`alwaysPaid`	Pravdivostná hodnota vyjadrujúca, či sa považujú faktúry prichádzajúce skrz túto registráciu stále za splatené.

`getRegisteredCustomers`

Metóda vracia používateľov registrovaných na prihlásenú firmu. Používateľov je možné filtrovať na základe dátumu registrácie a ich zapnutia.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <getRegisteredCustomersRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration">
            <limit>[int]</limit>
            <offset>[int]</offset>
            <dateFrom>[dateTime?]</dateFrom>
            <dateTo>[dateTime?]</dateTo>
            <lastMonth>[boolean]</lastMonth>
            <excludeSummaryDelivery>[boolean]</excludeSummaryDelivery>
            <excludeDisabled>[boolean]</excludeDisabled>
            <onBehalfOf>[string]</onBehalfOf>
        </getRegisteredCustomersRequest>
    </Body>
</Envelope>

Názov	Popis
`limit`	Číselný limit pre počet vrátených registrácií. Predvolená hodnota je 100. Ak je zadaná 0 limit nebude použitý.
`offset`	Posun vo vrátených registráciách pre potreby stránkovania. Predvolená hodnota je 0. Výsledky sú usporiadané podľa dátumu registrácie.
`dateFrom`	Začiatočný dátum vrátených registrácií (vrátane).
`dateTo`	Konečný dátum vrátených registrácií (nie vrátane).
`lastMonth`	Pravdivostná hodnota, ak true tak sú vrátené len registrácie z posledného mesiaca.
`excludeSummaryDelivery`	Ak true z výsledku budú vypustené hviezdičkové registrácie.
`excludeDisabled`	Ak true vrátené budú len zapnuté registrácie.
`onBehalfOf`	Pokiaľ sme uvedený ako priateľ inému účtu (s právom na prezeranie registrácií), môžeme zadať jeho číslo účtu alebo alias a uvidíme jeho registrácie miesto našich. Zoznam priateľov je možné získať pomocou api/2/friend/getFriendships

Odpoveďou tejto metódy je zoznam vyhovujúcich registrácií. Okrem zoznamu registeredCustomers obsahuje výsledok aj totalCount (celkový počet registrácií).

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body>
        <ns6:getRegisteredCustomersResponse>
            <ns6:registeredCustomers>
                <ns6:registeredCustomer>
                    <ns6:uiz1>100000640</ns6:uiz1>
                    <ns6:uiz2>*</ns6:uiz2>
                    <ns6:companyName>accalio</ns6:companyName>
                    <ns6:street>1234</ns6:street>
                    <ns6:zip>821 04</ns6:zip>
                    <ns6:city>13324</ns6:city>
                    <ns6:countryCode>SK</ns6:countryCode>
                    <ns6:registrationCreatedAt>2017-06-12T00:00:00+02:00</ns6:registrationCreatedAt>
                    <ns6:acceptEmails>false</ns6:acceptEmails>
                    <ns6:registrationChangedAt>2018-11-30T00:00:00+01:00</ns6:registrationChangedAt>
                    <ns6:registrationDisabledAt>2018-11-30T00:00:00+01:00</ns6:registrationDisabledAt>
                </ns6:registeredCustomer>
                <ns6:registeredCustomer>
                    <ns6:uiz1>123456</ns6:uiz1>
                    <ns6:uiz2></ns6:uiz2>
                    <ns6:firstName>Tester</ns6:firstName>
                    <ns6:lastName>Testovič</ns6:lastName>
                    <ns6:street>Testovacia 12</ns6:street>
                    <ns6:zip>81234</ns6:zip>
                    <ns6:city>Bratislava</ns6:city>
                    <ns6:countryCode>SK</ns6:countryCode>
                    <ns6:registrationCreatedAt>2014-01-08T00:00:00+01:00</ns6:registrationCreatedAt>
                    <ns6:acceptEmails>true</ns6:acceptEmails>
                    <ns6:registrationChangedAt>2014-01-08T00:00:00+01:00</ns6:registrationChangedAt>
                </ns6:registeredCustomer>
            </ns6:registeredCustomers>
            <ns6:totalCount>31</ns6:totalCount>
        </ns6:getRegisteredCustomersResponse>
    </soap:Body>
</soap:Envelope>

`getRegistration`

Vráti informácie o registrácii na prihláseného zákazníka. Registrácia je vrátená na základe jej ID.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <getRegistrationRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration">
            <id>38339</id>
        </getRegistrationRequest>
    </Body>
</Envelope>

Odpoveďou tejto metódy je registrácia s daným ID a informácie o nej.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body>
        <ns6:getRegistrationResponse>
            <ns6:registration>
                <ns6:id>38339</ns6:id>
                <ns6:senderCustomerId>16203</ns6:senderCustomerId>
                <ns6:name>Bratislavská vodárenská spoločnosť, a. s.</ns6:name>
                <ns6:createdOn>2020-02-25T14:45:29.636+01:00</ns6:createdOn>
                <ns6:updatedOn>2020-02-25T14:45:29.518+01:00</ns6:updatedOn>
                <ns6:recipientCustomerId>59</ns6:recipientCustomerId>
                <ns6:senderAccountId>15838</ns6:senderAccountId>
                <ns6:senderAvatar>16203.png</ns6:senderAvatar>
                <ns6:deliveryId>35465</ns6:deliveryId>
                <ns6:uiz1>uiz1</ns6:uiz1>
                <ns6:uiz2>uiz2</ns6:uiz2>
                <ns6:comment>moja prva registracia</ns6:comment>
                <ns6:enabled>true</ns6:enabled>
                <ns6:archiveEnabled>true</ns6:archiveEnabled>
                <ns6:requestBankAccount>false</ns6:requestBankAccount>
                <ns6:rawData>false</ns6:rawData>
                <ns6:dueNotifications>true</ns6:dueNotifications>
                <ns6:alwaysPaid>false</ns6:alwaysPaid>
            </ns6:registration>
            <ns6:delivery>
                <ns6:id>35465</ns6:id>
                <ns6:createdOn>2020-02-25T14:45:29.636+01:00</ns6:createdOn>
                <ns6:updatedOn>1970-01-01T00:00:00+01:00</ns6:updatedOn>
                <ns6:emailTo>ios@accalio.com</ns6:emailTo>
                <ns6:subjectSuffix>Zelená pošta</ns6:subjectSuffix>
            </ns6:delivery>
            <ns6:senderServices>ALLOW_ARCHIVE</ns6:senderServices>
            <ns6:senderServices>ALLOW_RAWDATA</ns6:senderServices>
            <ns6:senderServices>ALLOW_BANKACCOUNT</ns6:senderServices>
            <ns6:senderServices>ALLOW_GDC</ns6:senderServices>
        </ns6:getRegistrationResponse>
    </soap:Body>
</soap:Envelope>

Objekt delivery obsahuje informácie o doručovaní zásielok skrz túto registráciu.

Názov	Popis
`id`	ID doručovania.
`createdOn`	Dátum vytvorenia.
`updatedOn`	Dátum úpravy.
`emailTo`	E-mail, na ktorý sa budú posielať zásielky skrz túto registráciu.
`subjectSuffix`	Koncovka predmetu e-mailu.

Zoznam senderServices obsahuje špeciálne služby odosielateľa.

`getRegistrations`

Metóda vráti registrácie na prihláseného zákazníka.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <getRegistrationsRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration">
            <limit>[int]</limit>
            <offset>[int]</offset>
            <orderBy>[string?]</orderBy>
            <name>[string?]</name>
            <comment>[string?]</comment>
        </getRegistrationsRequest>
    </Body>
</Envelope>

Názov	Popis
`limit`	Maximálny počet vrátených registrácií.
`offset`	Posun vo vrátených registráciách pre potreby stránkovania. Predvolená hodnota je 0. Výsledky sú usporiadané podľa dátumu registrácie.
`orderBy`	Zoradenie výsledného zoznamu, možné hodnoty sú id, name, createdOn a comment. Ak chceme opačné poradie pred tento reťazec umiestnime znamienko -.
`name`	Vráti registrácie s takýmto názvom.
`comment`	Vráti registrácie s takýmto komentárom.

Odpoveďou tejto metódy je zoznam registrácií.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body>
        <ns6:getRegistrationsResponse>
            <ns6:totalCount>1</ns6:totalCount>
            <ns6:registrations>
                <ns6:registration>
                    <ns6:id>38339</ns6:id>
                    <ns6:senderCustomerId>16203</ns6:senderCustomerId>
                    <ns6:name>Bratislavská vodárenská spoločnosť, a. s.</ns6:name>
                    <ns6:createdOn>2020-02-25T14:45:29.636+01:00</ns6:createdOn>
                    <ns6:updatedOn>2020-02-25T14:45:29.518+01:00</ns6:updatedOn>
                    <ns6:recipientCustomerId>59</ns6:recipientCustomerId>
                    <ns6:senderAccountId>15838</ns6:senderAccountId>
                    <ns6:senderAvatar>16203.png</ns6:senderAvatar>
                    <ns6:deliveryId>35465</ns6:deliveryId>
                    <ns6:uiz1>uiz1</ns6:uiz1>
                    <ns6:uiz2>uiz2</ns6:uiz2>
                    <ns6:comment>moja prva registracia</ns6:comment>
                    <ns6:enabled>true</ns6:enabled>
                    <ns6:archiveEnabled>true</ns6:archiveEnabled>
                    <ns6:requestBankAccount>false</ns6:requestBankAccount>
                    <ns6:rawData>false</ns6:rawData>
                    <ns6:dueNotifications>true</ns6:dueNotifications>
                    <ns6:alwaysPaid>false</ns6:alwaysPaid>
                </ns6:registration>
            </ns6:registrations>
        </ns6:getRegistrationsResponse>
    </soap:Body>
</soap:Envelope>

`getRegistrationsList`

Vráti zoznam registrácií pre prihláseného používateľa. Požiadavka je bez ďalších parametrov.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <getRegistrationsListRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration"/>
    </Body>
</Envelope>

Odpoveďou je stručný zoznam registrácií obsahujúci ID účtu a názvy odosielateľov.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body>
        <ns6:getRegistrationsListResponse>
            <ns6:registrations>
                <ns6:registration>
                    <ns6:accountNumber>100174203</ns6:accountNumber>
                    <ns6:name>Bratislavská vodárenská spoločnosť, a. s.</ns6:name>
                </ns6:registration>
                <ns6:registration>
                    <ns6:accountNumber>100212489</ns6:accountNumber>
                    <ns6:name>Slovak Telekom, a.s.</ns6:name>
                </ns6:registration>
                <ns6:registration>
                    <ns6:accountNumber>100125498</ns6:accountNumber>
                    <ns6:name>Slovenský plynárenský priemysel, a.s.</ns6:name>
                </ns6:registration>
            </ns6:registrations>
        </ns6:getRegistrationsListResponse>
    </soap:Body>
</soap:Envelope>

`requestChangeDeliveryEmail`

Vyžiada zmenu doručovacieho emailu pre registráciu. Vstupom je ID registrácie a nový email na doručovanie. Výsledkom je email obsahujúci URL na potvrdenie zmeny (zmenu je možné potvrdiť aj manuálne zadaním tokenu do metódy nižšie).

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <requestChangeDeliveryEmailRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration">
            <registrationId>[int]</registrationId>
            <deliveryEmail>[string?]</deliveryEmail>
        </requestChangeDeliveryEmailRequest>
    </Body>
</Envelope>

Názov	Popis
`registrationId`	Číselný identifikátor registrácie.
`deliveryEmail`	Nový e-mail na doručovanie zásielok z danej registrácie.

V prípade úspechu je odpoveď prázdna:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body>
        <ns6:requestChangeDeliveryEmailResponse/>
    </soap:Body>
</soap:Envelope>

Na zadaný e-mail je doručená adresa, na ktorej je možné zmenu potvrdiť. Zmenu je možné potvrdiť aj metódou changeDelivery jej vstupom je token, ktorý možno vydedukovať z doručeného e-mailu. Príklad URL v e-maili je nasledovný: https://beta.zelenaposta.sk/user/change-delivery-email?username=ios%40accalio.com®istrationId=38339&emailTo=e1451093%40urhen.com&token=j8ep42t5o2vbos0613bff67ee, token sa nachádza na konci URL: token=j8ep42t5o2vbos0613bff67ee.

`changeDelivery`

Zmení doručovací email príhlaseného používateľa pre registráciu. Vstupom je ID registrácie, nový email a kód získaný metódou requestChangeDeliveryEmail.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <changeDeliveryEmailRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration">
            <username>[string?]</username>
            <registrationId>[int]</registrationId>
            <deliveryEmail>[string?]</deliveryEmail>
            <code>[string?]</code>
        </changeDeliveryEmailRequest>
    </Body>
</Envelope>

Názov	Popis
`username`	Aktuálny email používateľa.
`registrationId`	Číselný identifikátor registrácie.
`deliveryEmail`	Nový e-mail na doručovanie zásielok z danej registrácie.
`code`	Kód získaný metódou `requestChangeDeliveryEmail` (odoslaný na zadaný e-mail).

V prípade úspechu je odpoveď prázdna:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body>
        <ns6:changeDeliveryEmailResponse/>
    </soap:Body>
</soap:Envelope>

`updateRegistration`

Zmení parametre registrácie pre prihláseného používateľa. V prípade ak nastala zmena doručovacieho e-mailu, tak je nutné nový email potvrdiť, tak ako v prípade metódy changeDelivery.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <updateRegistrationRequest xmlns="http://schemas.zelenaposta.sk/api/2/registration">
            <registrationId>[int?]</registrationId>
            <emailTo>[string?]</emailTo>
            <emailCopy>[string?]</emailCopy>
            <subject>[string?]</subject>
            <comment>[string?]</comment>
            <decryptionPassword>[string?]</decryptionPassword>
            <enabled>[boolean]</enabled>
            <dueNotifications>[boolean]</dueNotifications>
            <rawData>[boolean]</rawData>
            <requestBankAccount>[boolean]</requestBankAccount>
            <bankAccount>[string?]</bankAccount>
        </updateRegistrationRequest>
    </Body>
</Envelope>

Názov	Popis
`registrationId`	Číselný identifikátor registrácie
`emailTo`	Nový e-mail pre príjmanie zásielok registrácie.
`emailCopy`	E-mail, na ktorý budú chodiť kópie zásielky.
`subject`	Predmet príchodzieho e-mailu.
`comment`	Vlastný komentár.
`decryptionPassword`	Heslo na rozšifrovanie zásielky.
`enabled`	Umožňuje zapnúť alebo vypnúť registráciu.
`dueNotifications`	Umožňuje zapnúť notifikácie o splatnosti.
`rawData`	Umožňuje zapnúť doručovanie holých dát (XML) miesto PDF.
`requestBankAccount`	Umožňuje zapnúť požadovanie IBANu.
`bankAccount`	IBAN.

V prípade úspechu je odpoveď prázdna:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/api/2/registration">
    <soap:Body/>
</soap:Envelope>

Dotazy:

info@zelenaposta.cz

Vyberte zemi:

/api/2/registration

createRegistration

getRegisteredCustomers

getRegistration

getRegistrations

getRegistrationsList

requestChangeDeliveryEmail

changeDelivery

updateRegistration

Dotazy:

Služby API2

`/api/2/registration`

`createRegistration`

`getRegisteredCustomers`

`getRegistration`

`getRegistrations`

`getRegistrationsList`

`requestChangeDeliveryEmail`

`changeDelivery`

`updateRegistration`