...
In dit document wordt de webservice MediaOrderB2C toegelichtDe Media webservices zijn ontwikkeld . Deze webservice is ontwikkeld met REST/JSON. In In REST wordt gebruik gemaakt van Resources en Operaties. Een resource kan gezien worden als object, een operatie als activiteit op een object. Voor Media zijn de De volgende resources zijn onderkent:
File
...
Resource (object) | YAML | Operatie (activiteit op een object) | Van | Naar | Beschrijving |
|---|---|---|---|---|---|
| File | MediaFile | placeFile | Klant | CB | Het versturen van een bestand (PDF) dat als bijlage aan een order gekoppeld is. Het bestand wordt bij het |
...
gereed maken van de zending geprint en bijgevoegd in de doos |
...
. |
...
Het PDF bestand |
...
dient voorafgaand aan |
...
de order door CB ontvangen te zijn. Opmerking: Deze operatie is nog niet beschikbaar. | |||||
| Order | MediaOrderB2C | placeOrder | Klant | CB | Het versturen van een order naar CB. De bestelling. Bij ontvangst van de order |
...
wordt een basis |
...
validatie uitgevoerd, indien |
...
er geen uitzonderingen zijn aangetroffen zal de order |
...
als ontvangen opdracht wordt vastgelegd en wordt er als reply een bevestiging naar de klant gestuurd. |
...
| |||
| getOrderStatus | Klant | CB | Het opvragen van de status van de door de klant ingediende order. Bij vooraf gedefinieerde statusveranderingen van een order (events) wordt een notify signaal naar de klant gestuurd, operatie notifyOrder. De klant kan vervolgens de gedetailleerde orderstatus bij CB opvragen. De orderstatus geeft informatie van de gehele oorspronkelijk ingediende opdracht. |
...
| getShippingUnits | Klant | CB | Het opvragen van de levereenheden waarin de door de klant ingediende order is verstuurd. Ten behoeve van een volledigheidscontrole kan de klant een overzicht van alle shippingunits |
...
Resource
Operatie
Van
Naar
Beschrijving
/levereenheden opvragen waarin de artikelen van de order in verstuurd zijn. |
...
Opmerking: Deze operatie is nog niet beschikbaar. | |||
| cancelOrderLine | Klant | CB | Het annuleren van een orderregel. De klant kan een order of een orderregel annuleren, dit kan tot het moment dat de order gereed gemaakt wordt voor distributie. |
| MediaOrderNotify | notifyOrder | CB |
| Klant | Het melden dat de order of orderregel een vooraf gedefinieerde status heeft bereikt. |
| Shipment |
| MediaShipmentNotify | notifyShipment | CB |
| Klant | Het melden dat er een shippingunit/levereenheid aan de vervoerder overgedragen is. |
Voor elke levereenheid die klaar staat voor verzending wordt een notify signaal naar de klant gestuurd. De klant kan vervolgens de details van de levereenheid bij CB opvragen, operatie getShippingUnit. | |||||
| MediaShipment | getShippingUnit | Klant | CB | Het opvragen van details van een shippingunit/levereenheid. In de details is per artikel een referentie naar de relevante orderregel opgenomen. | |
| Postponed-order | OrderBeheer | getPostponedOrders | CB | CB | Het opvragen van orders die gedurende het maintenance window zijn geparkeerd en nog niet zijn verwerkt. De klant krijgt bij indienen van de order een bevestiging dat de order ontvangen is. ??? Vraag Wilma: wordt er wel direct bij placeOrder een ontvangstbevestiging teruggegeven? |
| placeSingleOrder | CB | CB | Het doorzetten van een order nadat deze tijdelijk geparkeerd is tijdens het maintenance window. | ||
| getPostponedCancelOrderLines | CB | CB | Het opvragen van annuleringen voor orderregels die gedurende het maintenance window zijn geparkeerd en nog niet zijn verwerkt. | ||
| cancelSingleOrderLine | CB | CB | Het doorzetten van een annulering voor een orderregel nadat deze tijdelijk geparkeerd is tijdens het maintenance window. |
| View file | ||||
|---|---|---|---|---|
|
Waardes voor lijsten
De webservice operaties gebruiken Engelse termen en human readable waardes voor lijsten.
| Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
De webservice operaties gebruiken Engelse termen en human readable waardes voor lijsten. In onderstaande tabel zijn de gebruikte termen voor lijsten in de webservice gemapped naar de termen in de database.
| ONTVANGEN OPDRACHT | ||
|---|---|---|
| OrderType | type_kd | |
| ShipBuyer | LNAFN | |
| ShipOwner | LNEIG | |
| ShipSecundaryOwner | LMEONE | |
| ShipmentDate / ShipmentPeriod | levertijd_kd | |
| ShipmentDate = systeemdatum | D | |
ShipmentDate = systeemdatum + 1 <geen datum opgegeven> | N | |
ShipmentDate > systeemdatum + 1 ShipmentPeriod | L | |
| PartialShipment | deellevering_kd | |
| TRUE | DIRECT | |
| FALSE bij levertijd_kd=L | BESCH_DEEL_PER | |
| FALSE bij andere levertijd_kd | COMPLEET | |
| ONTVANGEN_OPDRACHTREGEL | ||
| TransactionCategory | tvwc_kd | |
| DepotDistribution | DUD | |
| OwnerDistribution | DIO | |
| SpecialOffering | AANB | |
| StockSelectionCode | me_kd | |
| SecundaryOwnerStock | 1 | |
| SecundaryOrPrimary | 2 | |
| PrimaryOwnerStock | 3 | |
| PrimaryOrSecundary | 4 | |
| OPDRACHT AANSPREEKPUNT | ||
| PartyType | type_kd | |
| ReceiverAddress | ONT | |
| DropSiteAddress | AHP | |
| InvoiceAddress | OFA | |
| OPDRACHT | ||
| IncludeStockTransfer | type_kd | |
| FALSE | LNEIG | |
| TRUE | LNAFN | |
| TRUE | <overig> | |
Downloadable yaml files
- MediaOrderB2C v0.9.8.yaml
- MediaFile v0.9.0.yaml
- MediaOrderNotify v0.9.4.yaml
- MediaShipmentB2C v0.9.1.yaml
- MediaShipmentNotify v0.9.3.yaml
- MediaShippingUnit v0.9.2.yaml
...