/api/2/friend

/api/2/friend

Táto služba sprístupňuje metódy týkajúce sa priateľstiev.

getFriendships

Získa zoznam priateľov prihláseného používateľa a zoznam používateľov, ktorým je prihlásený používateľ priateľom (spolu s detailami potrebnými pre volania onBehalfOf - alias a číslo účtu).

Request je prázdny.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <getFriendshipsRequest xmlns="http://schemas.zelenaposta.sk/friend"/>
    </Body>
</Envelope>

Odpoveďou je detail priateľov a používateľov, ktorým je prihlásený používateľ priateľom.

Názov Popis
friendshipId ID priateľstva.
userId ID používateľa, ktorý vytvoril priateľstvo.
friendId ID priateľa.
inviteEmail Email, na ktorý bola odoslaná žiadosť o priateľstvo.
createdOn Dátum vytvorenia priateľstva.
acceptedOn Dátum akceptovania priateľstva.
deletedOn Dátum vymazania priateľstva.
active Pravdivostná hodnota vyjadrujúca, či je priateľstvo zapnuté.
canViewReceived Práva prezerania prijatých dokumentov.
canViewSent Práva prezerania odoslaných dokumentov.
canSend Právo posielania dokumentov.
canViewRegistrations Právo prezerania registrácií.
fullname Celé meno priateľa/toho komu som priateľ.
username Email priateľa/toho komu som priateľ.
accountNumber Číslo účtu priateľa/toho komu som priateľ.
accountAlias Alias účtu priateľa/toho komu som priateľ.
address Adresa priateľa/toho komu som priateľ.
correspondenceAddress Korešpondenčná adresa priateľa/toho komu som priateľ.
customerId ID zákazníka priateľa/toho komu som priateľ.

Odpoveď obsahuje 2 zoznamy: friends - zoznam priateľov prihláseného používateľa a users - zoznam používateľov, ktorým je prihlásený používateľ priateľom.

<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/friend" xmlns:ns7="http://schemas.zelenaposta.sk/user">
    <soap:Body>
        <ns6:getFriendshipsResponse>
            <ns6:friends>
                <ns6:friend>
                    <ns6:friendshipId>73</ns6:friendshipId>
                    <ns6:userId>59</ns6:userId>
                    <ns6:friendId>123</ns6:friendId>
                    <ns6:inviteEmail>test@asdf.sk</ns6:inviteEmail>
                    <ns6:createdOn>2017-09-29T00:00:00+02:00</ns6:createdOn>
                    <ns6:active>true</ns6:active>
                    <ns6:canViewReceived>true</ns6:canViewReceived>
                    <ns6:canViewSent>true</ns6:canViewSent>
                    <ns6:canSend>false</ns6:canSend>
                    <ns6:canViewRegistrations>false</ns6:canViewRegistrations>
                    <ns6:fullname>TESTOVACIA FIRMA, s. r. o.</ns6:fullname>
                    <ns6:username>test@test.sk</ns6:username>
                    <ns6:accountNumber>100001303</ns6:accountNumber>
                    <ns6:accountAlias>100001303</ns6:accountAlias>
                    <ns6:address>
                        <ns7:name>TESTOVACIA FIRMA, s. r. o.</ns7:name>
                        <ns7:street>Hodžovo námestie 2</ns7:street>
                        <ns7:city>Bratislava</ns7:city>
                        <ns7:zip>81625</ns7:zip>
                        <ns7:country>Slovensko</ns7:country>
                        <ns7:countryCode>sk</ns7:countryCode>
                    </ns6:address>
                    <ns6:customerId>123</ns6:customerId>
                </ns6:friend>
            </ns6:friends>
            <ns6:users>
                <ns6:user>
                    <ns6:friendshipId>66</ns6:friendshipId>
                    <ns6:userId>16514</ns6:userId>
                    <ns6:friendId>59</ns6:friendId>
                    <ns6:inviteEmail>ios@accalio.com</ns6:inviteEmail>
                    <ns6:createdOn>2017-09-05T00:00:00+02:00</ns6:createdOn>
                    <ns6:acceptedOn>2017-09-07T00:00:00+02:00</ns6:acceptedOn>
                    <ns6:active>true</ns6:active>
                    <ns6:canViewReceived>true</ns6:canViewReceived>
                    <ns6:canViewSent>true</ns6:canViewSent>
                    <ns6:canSend>true</ns6:canSend>
                    <ns6:canViewRegistrations>false</ns6:canViewRegistrations>
                    <ns6:fullname>John Doe</ns6:fullname>
                    <ns6:username>tester@zelenaposta.sk</ns6:username>
                    <ns6:accountNumber>123456789</ns6:accountNumber>
                    <ns6:accountAlias>NEJAKE</ns6:accountAlias>
                    <ns6:address>
                        <ns7:name>John Doe</ns7:name>
                        <ns7:street>Galvaniho 17/b</ns7:street>
                        <ns7:city>Bratislava</ns7:city>
                        <ns7:zip>82104</ns7:zip>
                        <ns7:country>Slovensko</ns7:country>
                        <ns7:countryCode>sk</ns7:countryCode>
                    </ns6:address>
                    <ns6:correspondenceAddress>
                        <ns7:name>john doe correspondence</ns7:name>
                        <ns7:street>udernicka 15</ns7:street>
                        <ns7:city>Blava</ns7:city>
                        <ns7:zip>85001</ns7:zip>
                        <ns7:country>Slovensko</ns7:country>
                        <ns7:countryCode>sk</ns7:countryCode>
                    </ns6:correspondenceAddress>
                    <ns6:customerId>16306</ns6:customerId>
                </ns6:user>                
            </ns6:users>
        </ns6:getFriendshipsResponse>
    </soap:Body>
</soap:Envelope>

inviteFriend

Pozve používateľa aby sa stal priateľom prihláseného používateľa.

Request obsahuje email potencionálneho priateľa, povolenia budúceho priateľstva a správu odoslanú spolu s pozvánkou.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <inviteFriendRequest xmlns="http://schemas.zelenaposta.sk/friend">
            <friendEmail>[string?]</friendEmail>
            <message>[string?]</message>
            <canViewReceived>[boolean]</canViewReceived>
            <canViewSent>[boolean]</canViewSent>
            <canSend>[boolean]</canSend>
            <canViewRegistrations>[boolean]</canViewRegistrations>
        </inviteFriendRequest>
    </Body>
</Envelope>

Odpoveď je prázdna. Na email priateľa príde email s potvrdzujúcou URL, po kliknutí na ňu a prihlásení používateľa sa stane priateľstvo aktívnym.

<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/friend" xmlns:ns7="http://schemas.zelenaposta.sk/user">
    <soap:Body>
        <ns6:inviteFriendResponse/>
    </soap:Body>
</soap:Envelope>a


Dotazy:

info@zelenaposta.cz

Služby API2