Popis veřejných webových služeb





Seznam služeb

Služba

Název

Popis

Address

Adresa

Služba poskytuje identifikátor adresy postupným výběrem kraje, okresu, obce, části obce, ulice, čísla. Identifikátor adresy slouží jako vstupní parametr pro poskytnutí informace o odpoledním doručování

ParcelHistory

Historie zásilky

Služba poskytuje historii stavů požadované zásilky

PostCode

Vyhledávaní PSČ a ověřování doručení v časových pásmech

Služba poskytuje PSČ adresy a informaci, zda je v rámci PSČ poskytováno doručování v časových pásmech

PostOfficeInformation

Informace o poštách

Služba poskytuje informace o poštách

AfternoonParcelDelivery

Informace o odpoledním doručování

Služba poskytuje informace o odpoledním doručování pro požadovanou adresu

ParcelRating

Průzkum spokojenosti s podáním a dodáním

Služba poskytuje zadání spokojenosti s danou zásilkou







WADL soubory aplikaci - https://b2c.cpost.cz/services/Address/application.wadl

https://b2c.cpost.cz/services/ParcelHistory/application.wadl

https://b2c.cpost.cz/services/PostCode/application.wadl

https://b2c.cpost.cz/services/PostOfficeInformation/application.wadl

https://b2c.cpost.cz/services/AfternoonParcelDelivery/application.wadl

https://b2c.cpost.cz/services/ParcelRating/application.wadl



V případě chyby se vrací v HTTP hlavičce chybový kód 400 nebo 503

1.Adresa

1.1.Seznam krajů

Vstupní parametry

Nejsou

Výstupní XML

<regions>

  <region>

    <id></id>

    <name></name>

  </region>

.

</regions>

Výstupní JSON

[{"name":"","id":""},{...}]

Operace

https://b2c.cpost.cz/services/Address/getRegionListAsXml

Operace

https://b2c.cpost.cz/services/Address/getRegionListAsJson

Chybové stavy:

Service Unavailable.

Bad input param.


1.2.Seznam okresů

Vstupní parametry

    id – ID kraje, povinný

Výstupní XML

<districts>

  <district>

    <id></id>

    <name></name>

  </district>

.

</districts>

Výstupní JSON

[{"name":"","id":""},{....}]

Operace

https://b2c.cpost.cz/services/Address/getDistrictListAsXml?id=

Operace

https://b2c.cpost.cz/services/Address/getDistrictListAsJson?id=

Chybové stavy:

Service Unavailable.

Bad input param.

1.3.Seznam obcí

Vstupní parametry

    id – ID okresu, povinný

Výstupní XML

<cities>

  <city>

    <id></id>

    <name></name>

  </city>

.

</cities>

Výstupní JSON

[{"name":"","id":""},{....}]

Operace

https://b2c.cpost.cz/services/Address/getCityListAsXml?id=

Operace

https://b2c.cpost.cz/services/Address/getCityListAsJson?id=

Chybové stavy:

Service Unavailable.

Bad input param.

1.4.Seznam částí obcí

Vstupní parametry

    id – ID obce, povinný

Výstupní XML

<cityParts>

  <cityPart>

    <id></id>

    <name></name>

  </cityPart>

.

</cityParts>

Výstupní JSON

[{"name":"","id":""},{....}]

Operace

https://b2c.cpost.cz/services/Address/getCityPartListAsXml?id=

Operace

https://b2c.cpost.cz/services/Address/getCityPartListAsJson?id=

Chybové stavy:

Service Unavailable.

Bad input param.

1.5.Seznam ulic

Vstupní parametry

    id – ID části obce, povinný

Výstupní XML

<streets>

  <street>

    <id></id>

    <name></name>

  </street>

.

</streets>

Výstupní JSON

[{"name":"","id":""},{....}]

Operace

https://b2c.cpost.cz/services/Address/getStreetListAsXml?id=

Operace

https://b2c.cpost.cz/services/Address/getStreetListAsJson?id=

Chybové stavy:

Service Unavailable.

Bad input param.

1.6.Seznam čísel

Vstupní parametry

    idStreet – ID ulice, nepovinný, bude uveden pokud část obce má ulice

    idCityPart – ID části obce, nepovinný, bude uveden pokud část obce nemá ulice

    Jeden z parametrů musí být uveden, pokud jsou oba je upřednostněn parametr idStreet

Výstupní XML

<addresses>

  <address>

    <id></id>

    <name></name>

  </address>

.

</addresses>

Výstupní JSON

[{"name":"","id":""},{....}]

Operace

https://b2c.cpost.cz/services/Address/getNumberListAsXml?idStreet=

https://b2c.cpost.cz/services/Address/getNumberListAsXml?idCityPart=

Operace

https://b2c.cpost.cz/services/Address/getNumberListAsJson?idStreet=

https://b2c.cpost.cz/services/Address/getNumberListAsJson?idCityPart=

Chybové stavy:

Service Unavailable.

Bad input param.

2.Historie zásilky

Vstupní parametry

    idParcel – čárové kódy zásilek oddělené středníkem „;“, maximální počet je 10 zásilek, povinný

    language – jazyková mutace, nepovinný, výčet: cs, en – cs default

Výstupní XML

<parcels>

  <parcel id=““> </parcelId>

    <attributes> 

      <parcelType> </parcelType>

      <weight> </weight>

      <currency> </currency>

      <telefonTyp> </telefonTyp>

      <telefonNazev> </telefonNazev>

      <telefonCislo> </telefonCislo>

    </attributes>

    <states>

      <stated id=““>

      <date></date>

      <text></text>

      <postCode></postCode>

      <postoffice></postoffice>

      <idIcon></idIcon>

      <publicAccess></publicAccess>

      </state>

    </states>

  </parcelId>

</parcels>

Výstupní JSON

{"attributes":{parcelType":"", "weight":"", "currency":"", "telefonTyp":"", "telefonNazev":"", "telefonCislo":""},“states“: {["id":"","date":"", "text":"", "postcode":"", "postoffice":"", "idIcon":"", "publicAccess":""...]}}

Operace

https://b2c.cpost.cz/services/ParcelHistory/getDataAsXml?idParcel=

Operace

https://b2c.cpost.cz/services/ParcelHistory/getDataAsJson?idParcel=

Chybové stavy:

Service Unavailable.

Error: wrong idParcel param.

3.Vyhledávaní PSČ

Vstupní parametry

    idDistrict – ID okresu, nepovinný

    cityOrPart - obec nebo část obce (pokud není vyplněn parametr cityPart), nepovinný

    cityPart - část obce, nepovinný

    nameStreet - název ulice, nepovinný

    number – číslo popisné nebo orientační, nepovinný

    postCodePSČ, nepovinný

    Jeden z parametrů cityOrPart, postCode musí být uveden, pokud jsou oba je upřednostněn parametr postCode

Výstupní XML

<postCodes>

  <PostOffice> 

    <idRegion> </idRegion>

    <nameRegion> </nameRegion>

    <nameCity> </nameCity>

    <nameCityPart> </nameCityPart>

    <nameStreet> </nameStreet>

    <number> </number>

    <name> </name>

    <postCode> </postCode>

    <zone> </zone>

    <casovaPasma> </casovaPasma>

    <casDopoledniPochuzky> </casDopoledniPochuzky>

    <casOdpoledniPochuzky> </casOdpoledniPochuzky>

  </PostOffice> 

.

</postCodes>

Výstupní JSON

[{"idRegion":"","nameRegion":"","nameCity":"","nameCityPart":"","nameStreet":"","number":"","name":"","postCode":"""zone":"","casovaPasma":"","casDopoledniPochuzky":"","casOdpoledniPochuzky":""},{....}]

Operace

https://b2c.cpost.cz/services/PostCode/getDataAsXml?cityOrPart=

Operace

https://b2c.cpost.cz/services/PostCode/getDataAsJson?cityOrPart=

Chybové stavy:

Service Unavailable.


4.Informace o poštách

4.1. PostOfficeInformation

Vstupní parametry

    idDistrict – ID okresu, nepovinný

    place – obec, nebo název pošty, nepovinný

    postCode – PSČ, nepovinný

    gps – GPS souřadnice, nepovinný

    deliveryToPostOffice – balík na poštu, nepovinný (0 – ne, default, 1 - ano)

    deliveryToHand – balík do ruky, nepovinný (0 – ne, default, 1 - ano)

    sale – prodej tisku, nepovinný, (0 – ne, default, 1 – ano)

    copyService – kopírovací služby, nepovinný (0 – ne, default, 1 – ano)

    czechpoint – czech POINT, nepovinný (0 – ne, default, 1 – ano)

    atmCSOB – bnakomat CŠOB, nepovinný (0 – ne, default, 1 – ano)

    stickerHighway – dálniční nálepky, nepovinný (0 – ne, default, 1 – ano)

    westernUnion – Western Union, nepovinný (0 – ne, default, 1 – ano)

    saturday – otevřeno sobota, nepovinný (0 – ne, default, 1 – ano)

    sundayAndHolidayotevřeno neděle, nepovinný (0 – ne, default, 1 – ano)

    shopingCenter – v obchodním centru, nepovinný (0 – ne, default, 1 – ano)

    parking - bit, nepovinný, max. 1 znak, (0 – ne, default, 1 – ano)

    extendedOpeningHours - bit, nepovinný, max. 1 znak, (0 – ne, default, 1 – ano)

    postovna - bit, nepovinný, max. 1 znak, (0 – ne, default, 1 – ano)

    language – jazyková mutace, nepovinný, výčet: cs, en – cs default

Alespoň jeden údaj (idDistrict, place, postCode, gps) musí být uveden

Výstupní XML

<postOfficeInformations>

  <postOfficeInformation>

    <attributes>

      <name></name>

      <commune></commune>

      <street></street>

      <cityPart></cityPart>

      <houseNumber></houseNumber>

      <houseNumberLetter></houseNumberLetter> //nepovinný

      <orientationNumber></orientationNumber>

      <orientationNumberLetter></orientationNumberLetter> //nepovinný

      <postCode></postCode>

      <district></district>

      <region></region>

      <phone></phone>

      <fax></fax>      

      <email></email>      

      <latitude></latitude>      

      <longitude></longitude>      

      <webComment></webComment>      

      <publicAccess></publicAccess>      

      <closingDate></closingDate>      

      <reopeningDate></reopeningDate>      

      <parking></parking>      

      <platbaAsocKarta></platbaAsocKarta>      

      <atmCSOB></atmCSOB>      

      <extendedOpeningHours></extendedOpeningHours>      

      <czechPoint></czechPoint>

      <pressSale></pressSale>

      <stickerHighway></stickerHighway>

      <copyService></copyService>

      <betTerminal></betTerminal>

      <exchangeOffice></exchangeOffice>

      <westernUnion></westernUnion>

      <receivingParcelsPostEntriesAndPayingBills></receivingParcelsPostEntriesAndPayingBills>

      <zone></zone>

    </attributes>

    <openingHours>

      <day name=></name>

        <since1></postCode>

        <to1></district>

        ...

      </day>

    </openingHours>

    <parameters>

      <parameter></parameter>

    </parameters>

    <services>

      <service name="EMS">

        <properties>

            <property parameter="postCodeAtWorkday">

            </property><property parameter="postNameAtWorkday"></property>

            <property parameter="atWorkDayEndTime"></property>

            <property parameter="postCodeOnSaturday"></property>

            <property parameter="postNameOnSaturday"></property>

            <property parameter="onSaturdayEndTime"></property>

            <property parameter="postCodeOnSunday"/>

            <property parameter="postNameOnSunday"/>

            <property parameter="onSundayEndTime"/>

        </properties>

      </service>

      <service name="postfax">

        <properties>

            <property parameter="postCodeForDelivery"></property>

            <property parameter="postCodeForSubmission"></property>

            <property parameter="postNameForSubmission"></property>

            <property parameter="postNameForDelivery"></property>

            <property parameter="postfaxNumberForDelivery"/></properties>

      </service>

      <service name="deliveryToHandWithGuaranteedDeliveryTime">

        <properties><property parameter="atWorkDayEndTime"></property>

            <property parameter="onSaturdayEndTime"></property>

            <property parameter="onSundayEndTime"/></properties>

      </service>

      <service name="deliveryToHand">

        <properties><property parameter="delivers">

            </property><property parameter="receives"></property>

            <property parameter="pointInTimeForReceivingAtWorkDay"></property>

            <property parameter="storingPost"></property>

        </properties>

      </service>

      <service name="deliveryToPostOffice">

        <properties>

            <property parameter="toPickUpAtStoringDay"></property>

            <property parameter="storingPost"></property>

            <property parameter="temporaryStoringConstraint"></property>

            <property parameter="pointInTimeForReceivingAtWorkDay"></property>

        </properties>

      </service>

    </services>


   <numberDeliveryPlaces> //nepovinný

      <property parameter=></property>

      …..

    </numberDeliveryPlaces>

    <specificServices>

      <specificService availability=““>

        <title></title>

      </specificService>

    </specificServices>

    <deliveryPlaces> //nepovinný

      <deliveryPlace>

        <code></code>

        <nameDelivery></nameDelivery>

        <namePostOffice></namePostOffice>

      </deliveryPlace>

      …..

    </deliveryPlaces>

    <mobilOffices> //nepovinný

      <townVillage>

      <arrival>

      <location>

    </mobilOffices>

    <addressDetail> //nepovinný

      <deliveryPost type=“postentries“>

          <address></address>

          <deliveryTimeFrom></deliveryTimeFrom>

          <deliveryTimeTo></deliveryTimeTo>

          <postCode></postCode>

      </deliveryPost >

      <deliveryPost type=“parcels“>

          <address></address>

          <deliveryTimeFrom></deliveryTimeFrom>

          <deliveryTimeTo></deliveryTimeTo>

          <postCode></postCode>

      </deliveryPost >


      <storingPost type=“postentries“>

          <address></address>

          <postCode></postCode>

      </storingPost >

      <storingPost type=“parcels“>

          <address></address>

          <postCode></postCode>

      </storingPost >

    </addressDetail>

  </postOfficeInformation>

</postOfficeInformations>

Operace

{"postOfficeInformation":"name":"","commune":"","street":"","houseNumber":,"houseNumberLetter":"","orientationNumber":,"orientationNumberLetter":"","postCode":"","district":"","region":"","email":"","phone":"","fax":,"latitude":"","longitude":"", "webComment":"","webCpointComment":"","publicAccess":"","closingDate":,"reopeningDate":,"parking":"","platbaAsocKarta":"","extendedOpeningHours":"","atmCSOB":"","czechPoint":"","pressSale":","stickerHighway":"","copyService":"","betTerminal":"","exchangeOffice":"","westernUnion":"","receivingParcelsPostEntriesAndPayingBills":"","zone":""}},"openingHours":{"day":[{"@name":"­","since1":"","to1":"","since2":"","to2":""},...]},"services":{"service":[{"@name":"","properties":{"property":[{"@parameter":"","":""},...]}...]},"numberDeliveryPlaces":{"property":[{"@parameter":"","":""}....]},"specificServices":[{"title":"",“availability“:,{...}}],"deliveryPlaces":{"deliveryPlace":[{"code":"","nameDelivery":"","namePostOffice":""},....]},"mobilOffices":{"mobilOffice":{"arrival":"","location":"","townVillage":""}, "addressDetail":{"deliveryPost":[{"address":"","type":"postentries","postCode":""},{"address":"","type":"parcels","postCode":""}],"storingPost":[{"address":"","type":"postentries","postCode":""},{"address":"","type":"parcels","postCode":""}]}}]

}

Operace

https://b2c.cpost.cz/services/PostOfficeInformation/getDataAsXml?postCode=

Operace

https://b2c.cpost.cz/services/PostOfficeInformation/getDataAsJson?postCode=

Chybové stavy:

Service Unavailable.

At least one parameter of idDistrict, place, postCode and gps must be set.

Musí být vyplněn alespoň jeden z parametrů: idDistrict, place, postCode, gps.

Gps wrong format coordinates.

Špatný formát GPS souřadnice.


4.2. PostOfficeInformation v.2

Vstupní parametry

    idDistrict – ID okresu, nepovinný

    place – obec, nebo název pošty, nepovinný

    postCode – PSČ, nepovinný

    gps – GPS souřadnice, nepovinný

    deliveryToPostOffice – balík na poštu, nepovinný (0 – ne, default, 1 - ano)

    deliveryToHand – balík do ruky, nepovinný (0 – ne, default, 1 - ano)

    sale – prodej tisku, nepovinný, (0 – ne, default, 1 – ano)

    copyService – kopírovací služby, nepovinný (0 – ne, default, 1 – ano)

    czechpoint – czech POINT, nepovinný (0 – ne, default, 1 – ano)

    atmCSOB – bnakomat CŠOB, nepovinný (0 – ne, default, 1 – ano)

    stickerHighway – dálniční nálepky, nepovinný (0 – ne, default, 1 – ano)

    westernUnion – Western Union, nepovinný (0 – ne, default, 1 – ano)

    saturday – otevřeno sobota, nepovinný (0 – ne, default, 1 – ano)

    sundayAndHolidayotevřeno neděle, nepovinný (0 – ne, default, 1 – ano)

    shopingCenter – v obchodním centru, nepovinný (0 – ne, default, 1 – ano)

    parking - bit, nepovinný, max. 1 znak, (0 – ne, default, 1 – ano)

    extendedOpeningHours - bit, nepovinný, max. 1 znak, (0 – ne, default, 1 – ano)

    postalAgency - služba poštovny, bit, nepovinný, max. 1 znak, (0 – ne, default, 1 – ano)

    parcelService - služba balíkovny, bit, nepovinný, max. 1 znak, (0 – ne, default, 1 – ano)

    language – jazyková mutace, nepovinný, výčet: cs, en – cs default

Alespoň jeden údaj (idDistrict, place, postCode, gps) musí být uveden

Výstupní XML

<postOfficeInformations>

  <postOfficeInformation>

    <attributes>

      <name></name>

      <commune></commune>

      <street></street>

      <cityPart></cityPart>

      <houseNumber></houseNumber>

      <houseNumberLetter></houseNumberLetter> //nepovinný

      <orientationNumber></orientationNumber>

      <orientationNumberLetter></orientationNumberLetter> //nepovinný

      <postCode></postCode>

      <district></district>

      <region></region>

      <phone></phone>

      <fax></fax>      

      <email></email>      

      <latitude></latitude>      

      <longitude></longitude>      

      <webComment></webComment>      

      <publicAccess></publicAccess>      

      <closingDate></closingDate>      

      <reopeningDate></reopeningDate>      

      <parking></parking>      

      <platbaAsocKarta></platbaAsocKarta>      

      <atmCSOB></atmCSOB>      

      <extendedOpeningHours></extendedOpeningHours>      

      <czechPoint></czechPoint>

      <pressSale></pressSale>

      <stickerHighway></stickerHighway>

      <copyService></copyService>

      <betTerminal></betTerminal>

      <exchangeOffice></exchangeOffice>

      <westernUnion></westernUnion>

      <receivingParcelsPostEntriesAndPayingBills></receivingParcelsPostEntriesAndPayingBills>

      <zone></zone>

      <parcelService></parcelService>

    </attributes>

    <openingHours>

      <day name=></name>

        <since1></postCode>

        <to1></district>

        ...

      </day>

    </openingHours>

    <parameters>

      <parameter></parameter>

    </parameters>

    <services>

      <service name="EMS">

        <properties>

            <property parameter="postCodeAtWorkday">

            </property><property parameter="postNameAtWorkday"></property>

            <property parameter="atWorkDayEndTime"></property>

            <property parameter="postCodeOnSaturday"></property>

            <property parameter="postNameOnSaturday"></property>

            <property parameter="onSaturdayEndTime"></property>

            <property parameter="postCodeOnSunday"/>

            <property parameter="postNameOnSunday"/>

            <property parameter="onSundayEndTime"/>

        </properties>

      </service>

      <service name="postfax">

        <properties>

            <property parameter="postCodeForDelivery"></property>

            <property parameter="postCodeForSubmission"></property>

            <property parameter="postNameForSubmission"></property>

            <property parameter="postNameForDelivery"></property>

            <property parameter="postfaxNumberForDelivery"/></properties>

      </service>

      <service name="deliveryToHandWithGuaranteedDeliveryTime">

        <properties><property parameter="atWorkDayEndTime"></property>

            <property parameter="onSaturdayEndTime"></property>

            <property parameter="onSundayEndTime"/></properties>

      </service>

      <service name="deliveryToHand">

        <properties><property parameter="delivers">

            </property><property parameter="receives"></property>

            <property parameter="pointInTimeForReceivingAtWorkDay"></property>

            <property parameter="storingPost"></property>

        </properties>

      </service>

      <service name="deliveryToPostOffice">

        <properties>

            <property parameter="toPickUpAtStoringDay"></property>

            <property parameter="storingPost"></property>

            <property parameter="temporaryStoringConstraint"></property>

            <property parameter="pointInTimeForReceivingAtWorkDay"></property>

        </properties>

      </service>

    </services>


   <numberDeliveryPlaces> //nepovinný

      <property parameter=></property>

      …..

    </numberDeliveryPlaces>

    <specificServices>

      <specificService availability=““>

        <title></title>

      </specificService>

    </specificServices>

    <deliveryPlaces> //nepovinný

      <deliveryPlace>

        <code></code>

        <nameDelivery></nameDelivery>

        <namePostOffice></namePostOffice>

      </deliveryPlace>

      …..

    </deliveryPlaces>

    <mobilOffices> //nepovinný

      <townVillage>

      <arrival>

      <location>

    </mobilOffices>

    <addressDetail> //nepovinný

      <deliveryPost type=“postentries“>

          <address></address>

          <deliveryTimeFrom></deliveryTimeFrom>

          <deliveryTimeTo></deliveryTimeTo>

          <postCode></postCode>

      </deliveryPost >

      <deliveryPost type=“parcels“>

          <address></address>

          <deliveryTimeFrom></deliveryTimeFrom>

          <deliveryTimeTo></deliveryTimeTo>

          <postCode></postCode>

      </deliveryPost >


      <storingPost type=“postentries“>

          <address></address>

          <postCode></postCode>

      </storingPost >

      <storingPost type=“parcels“>

          <address></address>

          <postCode></postCode>

      </storingPost >

    </addressDetail>

  </postOfficeInformation>

</postOfficeInformations>

Operace

{"postOfficeInformation":"name":"","commune":"","street":"","houseNumber":,"houseNumberLetter":"","orientationNumber":,"orientationNumberLetter":"","postCode":"","district":"","region":"","email":"","phone":"","fax":,"latitude":"","longitude":"", "webComment":"","webCpointComment":"","publicAccess":"","closingDate":,"reopeningDate":,"parking":"","platbaAsocKarta":"","extendedOpeningHours":"","atmCSOB":"","czechPoint":"","pressSale":","stickerHighway":"","copyService":"","betTerminal":"","exchangeOffice":"","westernUnion":"","receivingParcelsPostEntriesAndPayingBills":"","zone":""}},"openingHours":{"day":[{"@name":"­","since1":"","to1":"","since2":"","to2":""},...]},"services":{"service":[{"@name":"","properties":{"property":[{"@parameter":"","":""},...]}...]},"numberDeliveryPlaces":{"property":[{"@parameter":"","":""}....]},"specificServices":[{"title":"",“availability“:,{...}}],"deliveryPlaces":{"deliveryPlace":[{"code":"","nameDelivery":"","namePostOffice":""},....]},"mobilOffices":{"mobilOffice":{"arrival":"","location":"","townVillage":""}, "addressDetail":{"deliveryPost":[{"address":"","type":"postentries","postCode":""},{"address":"","type":"parcels","postCode":""}],"storingPost":[{"address":"","type":"postentries","postCode":""},{"address":"","type":"parcels","postCode":""}]}}]

}

Operace

https://b2c.cpost.cz/services/PostOfficeInformation/v2/getDataAsXml?postCode=

Operace

https://b2c.cpost.cz/services/PostOfficeInformation/v2/getDataAsJson?postCode=

Chybové stavy:

Service Unavailable.

At least one parameter of idDistrict, place, postCode and gps must be set.

Musí být vyplněn alespoň jeden z parametrů: idDistrict, place, postCode, gps.

Gps wrong format coordinates.

Špatný formát GPS souřadnice.


4.3. LastUpdate

Vstupní parametry

    date – datum (datum >= den změny záznamu v číselníku pošt), povinný

Výstupní XML

<lastUpdateInfoes>

<lastUpdateInfo>

<postCode></postCode>

<state></state> //stavy: inserted, deleted, changed

</lastUpdateInfo>

.

</lastUpdateInfoes>

Výstupní JSON

[{"postCode": ,"state":""}, {....}]

Operace

https://b2c.cpost.cz/services/PostOfficeInformation/getUpdatedPostAsXml?date=

Operace

https://b2c.cpost.cz/services/PostOfficeInformation/getUpdatedPostAsJson?date=

Chybové stavy:

Bad input param.



4.4. Poštovny

Vstupní parametry


Výstupní XML

<postovnaDetails>

<postovna>

<postCode></postCode>

<name></name>

<commune></commune>

<cityPart></cityPart>

<street></street>

<houseNumber></houseNumber>

<houseNumberLetter></houseNumberLetter>

<orientationNumber></orientationNumber>

<orientationNumberLetter></orientationNumberLetter>

<description></description>

<address></address>

</postovna>

</postovnaDetails>


Výstupní JSON

[{"postCode":"","name":,"commune":,"cityPart":,"street":,"houseNumber":,"houseNumberLetter":,"orientationNumber":,"orientationNumberLetter":,"description":"","address":}


Operace

https://b2c.cpost.cz/services/PostOfficeInformation/getPostovnyAsXml

Operace

https://b2c.cpost.cz/services/PostOfficeInformation/getPostovnyAsJson

Chybové stavy:

Service Unavailable.



5.Odpolední doručování

Vstupní parametry

    idAddress – ID adresy, povinný

Výstupní XML

<afternoonParcelDelivery>

  <available> </available>

</afternoonParcelDelivery>

Výstupní JSON

{"available":""}

Operace

https://b2c.cpost.cz/services/AfternoonParcelDelivery/getDataAsXml?idAddress=

Operace

https://b2c.cpost.cz/services/AfternoonParcelDelivery/getDataAsJson?idAddress=

Chybové stavy:

Bad input param.




6. Průzkum spokojenosti s podáním a dodáním

6.1. Seznam typu nespokojenosti

Vstupní parametry

    evaluator – typ hodnotitele (0 – odesílatel, 1 – adresát), povinný

    language – jazyková mutace, nepovinný, výčet: cs, en – cs default

Výstupní XML

<reasons>

<reason id=““ requiredText=““>

<title></title>

</reason>

.

</reasons>

Výstupní JSON

[{"id": <id>,"requiredText":<0|1>,"title":"<title>"}, {....}]

Operace

https://b2c.cpost.cz/services/ParcelRating/getReasonsAsXml

Operace

https://b2c.cpost.cz/services/ParcelRating/getReasonsAsJson

Chybové stavy:

Error: evaluator param is required.

Error: Wrong type of evaluator.

Service Unavailable.

6.2. Odeslání průzkumu spokojenosti

Vstupní parametry (POST)

    idParcel – čárový kód zásilky, povinný

    evaluator - typ hodnotitele (0 – odesílatel, 1 – adresát), povinný

    rating – hodnocení (0 – nespokojen, 1 – spokojen), povinný

    channel – kanál (0 – web aplikace, 1 – mobil aplikace), povinný

    reason – typ nespokojenosti viz seznam typu nespokojenosti (výčet reason id oddělený čárkou), povinný

    description – text k průzkumu spokojenosti, pokud je zadaná reakce typu jiný důvod, tak je parametr povinný

Výstupní XML

<wsResponse>

  <code></code>

</wsResponse>

Pozn.: Kód 0 = úspěch

Výstupní JSON

{"code":} Pozn.: Kód 0 = úspěch

Operace

https://b2c.cpost.cz/services/ParcelRating/setRatingXml

Operace

https://b2c.cpost.cz/services/ParcelRating/setRatingJson

Chybové stavy:

Error: reason is required.

Error: Reason description text is required.

Service Unavailable.

Error: evaluator param is required.

Error: wrong format of evaluator param.

Error: evaluator, rating and channel param are required.

Error: wrong type of evaluator param.

Error: wrong format of rating.

Error: wrong format of channel param.

ERROR: Db error code: