Uniforme Interface

De uniforme interface definieert de interface tussen 'clients' en 'servers'. Het vereenvoudigt en ontkoppelt de architectuur, waardoor elk onderdeel onafhankelijk kan evolueren. De vier leidende principes van de uniforme interface zijn: Op bronnen gebaseerde individuele bronnen worden geïdentificeerd in verzoeken met behulp van URI's als resource-identifiers. De bronnen zelf zijn conceptueel gescheiden van de representaties die worden teruggestuurd naar de client. De server verzendt bijvoorbeeld niet zijn database, maar veeleer wat HTML, XML of JSON die enkele databaserecords vertegenwoordigen, bijvoorbeeld uitgedrukt in het Engels en gecodeerd in UTF-8, afhankelijk van de details van het verzoek en de serverimplementatie. Manipulatie van resources via representaties Wanneer een client een representatie van een resource bevat, inclusief eventuele bijgevoegde metadata, heeft deze voldoende informatie om de resource op de server aan te passen of te verwijderen, op voorwaarde dat hiervoor toestemming is verleend. Zelfbeschrijvende berichten, elk bericht bevat voldoende informatie om te beschrijven hoe het bericht moet worden verwerkt. De parser die moet worden aangeroepen, kan bijvoorbeeld worden opgegeven door een type internetmedium (voorheen een MIME-type genoemd). Reacties geven ook expliciet hun cachevermogen aan. Hypermedia als de Engine of Application State (HATEOAS) Clients leveren status via body-content, query-tekstparameters, request headers en de gevraagde URI (de resourcenaam). Services leveren status aan klanten via body-content, responscodes en responsheaders. Dit wordt technisch gesproken aangeduid als hypermedia (of hyperlinks binnen hypertekst). Afgezien van de bovenstaande beschrijving betekent HATEOS ook dat, waar nodig, koppelingen zijn opgenomen in de geretourneerde tekst (of headers) om de URI te leveren voor het ophalen van het object zelf of gerelateerde objecten. De uniforme interface die REST-services moeten bieden, is van fundamenteel belang voor het ontwerp.

Sluit

Stateless

Aangezien REST een afkorting is voor REpresentational State Transfer, staat 'statelessness' centraal. Wat dit in wezen betekent, is dat de noodzakelijke status om het verzoek af te handelen, is vervat in het verzoek zelf, of dit nu onderdeel is van de URI, parameters van queryreeksen, hoofdtekst of headers. De URI identificeert op unieke wijze de resource en de body bevat de status (of statuswijziging) van die resource. Nadat de server de verwerking heeft uitgevoerd, worden de betreffende status of het deel van de staat dat ertoe doet via de headers, status en responstream teruggekoppeld naar de client. In REST moet de client alle informatie voor de server opnemen om aan het verzoek te voldoen, en zo nodig de status opnieuw verzenden als die staat meerdere verzoeken moet omvatten. Staatloosheid maakt grotere schaalbaarheid mogelijk omdat de server die sessiestatus niet hoeft bij te houden, bij te werken of te communiceren. Bovendien hoeven loadbalancers zich geen zorgen te maken over sessieafhankelijkheid voor stateloze systemen. Dus wat is het verschil tussen staat en een bron? Staat, of toepassingsstatus, is dat wat de server op het punt staat te voldoen aan aanvraag-gegevens die nodig zijn voor de huidige sessie of aanvraag. Een resource of resourcestatus zijn de gegevens die de bronrepresentatie definiëren, bijvoorbeeld de gegevens die in de database zijn opgeslagen. De applicatiestatus als gegevens per klant en per verzoek kunnen verschillen. De bronstatus is daarentegen constant voor elke client die daarom vraagt.

Sluit

Cacheable

Net als op het World Wide Web kunnen clients antwoorden opslaan in de cache. Antwoorden moeten daarom impliciet of expliciet zichzelf definiëren als al dan niet 'cacheerbaar', om te voorkomen dat klanten oude of ongepaste gegevens opnieuw gebruiken als reactie op verdere verzoeken. Goed beheerde caching elimineert gedeeltelijk of volledig sommige client-server-interacties, waardoor de schaalbaarheid en prestaties verder worden verbeterd.

Sluit

Client-Server

Deze scheiding van bevoegdheden betekent dat clients zich bijvoorbeeld niet bezighouden met gegevensopslag, die intern blijft voor elke server, zodat de overdraagbaarheid van de clientcode wordt verbeterd. Servers houden zich niet bezig met de gebruikersinterface of gebruikersstatus, zodat servers eenvoudiger en schaalbaarder kunnen zijn. Servers en clients kunnen ook onafhankelijk worden vervangen en ontwikkeld, zolang de interface niet wordt gewijzigd.

Sluit

Gelaagd systeem

De client-kant heeft geen zicht of hij rechtstreeks is verbonden met de eindserver of via een tussenstation. Intermediaire servers kunnen de systeemschaal verbeteren door load-balancing mogelijk te maken en door gedeelde caches aan te bieden. De diverse lagen kunnen ook het beveiligingsbeleid afdwingen.

Sluit

Code op aanvraag

Indien u zelf aan de slag wenst te gaan doch ondersteuning wenst in de vorm van een overleg of code voorbeelden, dan kan dit besproken worden. Neem hiervoor contact op met helpdesk@kto.be.

Sluit

ApiResult

Onder normale omstandigheden ontvangt u een antwoord na elk verzoek. Dit antwoord bevat altijd een ApiResult-object bovenaan. Het ApiResult-object bevat belangrijke informatie voor de client-side programmeur, de helpdesk en om de prestaties van de api-processen te analyseren. Een 'POST', 'PUT' of 'DELETE' verzoek retourneert enkel een apiresult. Een 'GET'-verzoek retourneert altijd ten minste één extra object, een lijst met objecten (lege lijsten zijn mogelijk en worden aangegeven met []) of een geneste structuur van objecten wanneer de gevraagde gegevens worden gevonden. Deze data komt binnen de ApiResult in het Content veld.

Veldnaam	Veldtype	Lengte	Info
apiVersion	string	20	De gebruikte Api versie
timeStamp	integer		Tijdstip van het antwoord
duration	integer		Milliseconden nodig voor het opbouwen van de 'response'
method	string	20	HTTP-methode gebruikt op het API-eindpunt
statusCode	string	20	OK indien alles normaal verlopen, anders foutboodschap
requestUri	string	Max	Uri van uw vraag
throttleCounter	integer		Aantal mogelijke aanvragen vóór blokkeren (max. 60 / uur)
pageCounter	integer		Wanneer bij de eerste opvraging de pagecounter = 1 is, dan zijn er nog 1 of meerdere pagina's die volgen. De volgende pagina's kunnen opgehaald worden door nogmaals dezelfde opvraging uit te voeren. De volgende opvraging(en) voert u telkens na elkaar uit (binnen de 120sec) tot de pagecounter in het antwoord gelijk is aan 0. pageCounter = 0, is de laatste pagina met de resterende orders.
correlationId	guid	20	Hiermee wordt de correlatie-ID opgehaald of ingesteld
content	Array		De HTTP response met de door u gevraagde inhoud. Kan leeg zijn in bepaalde gevallen, zie hierboven voor meer uitleg

Sluit

Orders

Binnen onze Order zijn er twee subklasses voorzien: Ordersummary (samenvatting) en Orderdetail (details). Er zijn 4 verschillende calls voorzien:

• Met [Get the orders by search] kan u een lijst van orders opzoeken op basis van verschillende parameters.
• Met [Get the order by orderId] kan u de samenvatting van één order ophalen op basis van een unieke orderId.
• Met [Get the details for a given orderId] kan u de details van één order bepaald order opvragen. U krijgt niet alleen de gedetailleerde informatie over één order maar ook een lijst met gedetailleerde informatie over de collies die tot dit order behoren .
• Met [Get the photos by orderId] kan u een lijst ophalen van eventuele foto's op orderbasis, voor de eventuele overige foto's moet gekeken worden op anomalie niveau. Foto's worden binair aangeboden en dienen eventueel omgezet te worden naar één of ander beeldformaat in het client gedeelte.

Ordersummary (Orderniveau samenvatting)

Veldnaam	Veldtype	Lengte	Info
orderId	guid		Unieke OrderId nodig om details op te vragen
id	integer		Id van dit record (niet echt van belang)
masterOrderNumberBD	integer		Belgische master ordernummer
masterOrderNumberFD	integer		Frans master ordernummer
carrier	string	4	Partij verantwoordelijk voor de verzending van de goederen TMLB (België) of TMLF (Frankrijk)
actualOrderNumberBD	integer		Huidig belgisch ordernummer
actualOrderNumberFD	integer		Huidig frans ordernummer
actualOrderTypeBD	string	3	Actueel belgisch ordertype, voorbeeld: "WAT", "NA", "RE", ... (blanco = normaal transportorder) NA  Nalevering RE  Retouropdracht SO  Expresslevering UM  Afhaling en levering ARE  Annulatie retouropdracht BLK  Geblokkeerd in KTO CRE  Gestopt bij de distributeur en retour DIS  Afhaling in depot KRE  Gestopt bij KTO en retour PO  Poging tot afhaling W2A  Tweede aanlevering na weigering W3A  Derde aanlevering na weigering WAT  Geweigerd, wacht op antwoord afzender WRE  Retour na weigering LIT  Afhaling beschadigde goederen ENL  Afhalen+Leveren VIA  Transfer via België
actualOrderTypeFD	string	3	Actueel frans ordertype, meer info zie actualOrderTypeBD
supplierLoad	string	20	Leverancier 'load' nummer
supplierReference	string	50	Referentie leverancier
totalQuantity	integer		Totaal aantal ontvangen van leverancier
totalWeight	decimal	10,2	Totaal gewicht in kg
totalquantityHU	integer		Totaal aantal 'handling units'
statusDelivery	string	20	Beschrijving van de leveringsstatus: ' ' (Blanco) = Indien dataOfDelivery een datum bevat is dit order geleverd maar zonder boordcomputer, is dateOfDelivery niet ingevuld dan is dit order (nog) niet geleverd 'Cancelled TRA' = Geannulleerd volgens ERP-toepassing 'Delivered BOC' = Volledig geleverd volgens boordcomputer 'Not delivered TRA' = Niet geleverd volgens ERP-toepassing 'Not delivered BOC' = Niet geleverd volgens boordcomputer 'Part delivered BOC' = Gedeeltelijk geleverd volgens boordcomputer 'Delivered on MD BOC' = Geleverd op verschillende dagen volgens boordcomputer 'Third party BOC' = Overgedragen aan een derde DeliveryRemarkOnBoardComputer wordt opgevuld Status082 wordt opgevuld 'Refused TRA' = Geweigerd volgens ERP-toepassing 'Refused BOC' = Geweigerd volgens boordcomputer 'Loaded BOC' = Geladen volgens boordcomputer (retours) 'Part loaded BOC' = Gedeeltelijk geladen volgens boordcomputer (retours) 'Not loaded BOC' = Niet geladen volgens boordcomputer (retours)
dateOfDelivery	Date		Datum waarop de goederen werden geleverd (formaat jjjj-MM-dd)
pod	boolean		Waar, leverbon is aanwezig voor download
anomaly	boolean		Waar als er een annomalie werd geregistreerd op dit order

Orderdetail

Veldnaam	Veldtype	Lengte	Info
masterOrderNumberBD	integer		Belgische master ordernummer
masterOrderNumberFD	integer		Frans master ordernummer
actualOrderNumberBD	integer		Huidig belgisch ordernummer
actualOrderNumberFD	integer		Huidig frans ordernummer
ktoHub	string	50	Actuele TML Hub (Izegem, Parijs, Lyon, ...)
actualOrderTypeBD	string	3	Actueel belgisch ordertype, voorbeeld: "WAT", "NA", "RE", ... (blanco = normaal transportorder) NA  Nalevering RE  Retouropdracht SO  Expresslevering UM  Afhaling en levering ARE  Annulatie retouropdracht BLK  Geblokkeerd in KTO CRE  Gestopt bij de distributeur en retour DIS  Afhaling in depot KRE  Gestopt bij KTO en retour PO  Poging tot afhaling W2A  Tweede aanlevering na weigering W3A  Derde aanlevering na weigering WAT  Geweigerd, wacht op antwoord afzender WRE  Retour na weigering LIT  Afhaling beschadigde goederen ENL  Afhalen+Leveren VIA  Transfer via België
actualOrderTypeFD	string	3	Actueel frans ordertype, meer info zie actualOrderTypeBD
carrier	string	4	Partij verantwoordelijk voor de verzending van de goederen TMLB (België) of TMLF (Frankrijk)
agent	string	14	Naam van de agent
agentStreet	string	40	Straat van de agent
agentZip	string	10	Postcode van de agent
agentCity	string	40	Woonplaats van de agent
agentCountry	string	10	Land van de agent
receiver	string	40	Naam van de ontvanger
receiverStreet	string	40	Straat van de ontvanger
receiverZip	string	10	Postcode van de ontvanger
receiverCity	string	40	Stad van de ontvanger
receiverCountry	string	10	Land van de ontvanger
payer	string	40	Naam van de betaler
payerStreet	string	40	Straat van de betaler
payerZip	string	10	Postcode van de betaler
payerCity	string	40	Woonplaats van de betaler
payerCountry	string	10	Land van de betaler
supplier	string	40	Naam van de leverancier
supplierStreet	string	40	Straat van de leverancier
supplierStreet	string	10	Postcode van de leverancier
supplierCity	string	40	Woonplaats van de leverancier
supplierCountry	string	10	Land van de leverancier
supplierLoad	string	20	Leverancier 'load' nummer
totalWeight	decimal	10,2	Totaal gewicht in kg
totalQuantity	integer		Totaal aantal ontvangen van leverancier
totalquantityHU	integer		Totaal aantal 'handling units'
supplierReference	string	50	Referentie leverancier
supplierReference2	string	50	De optionele tweede referencie van de leverancier
receiverReference	string	50	Referentie van de ontvanger
instructionSupplierToMakeAgreement	boolean		Waar = Er is een instructie van de leverancier om een afspraak te maken
agreementComment	string	50	Commentaar huidige afspraak, meestal een telefoonnummer
firstRequestForDelivery	DateTime		Datum waarop TML de ontvanger gevraagd heeft om toestemming tot het leveren van de goederen
replyOnRequestForDelivery	DateTime		Datum waarop de ontvanger antwoorde op de vraag voor toestemming voor het leveren van de goederen
noReplyOnRequestForDelivery	DateTime		Datum waarop het document ‘impossible to make agreement’ is verzonden naar de leverancier
termType	string	1	Huidige type van de gevraagde datum van levering (of afhaling): (A) Vanaf: termDate = vroegste leveringsdatum (T) Tenlaatste: termDate = uiterste datum van levering (F) Fix: termDate = levering exact op deze datum (P) Periode: leveringdatum in de periode van termDate tot termDate2
termDate	DateTime		Huidige gevraagde datum van levering of ophaling
termDate2	DateTime		Huidige gevraagde datum van aflevering of ophaling (datum-tijd formaat): Als Termdate2 = Termdate: dan is de afspraak om te leveren op deze datum bevestigd door de ontvanger If Termdate2 > Termdate en TermType = 'P': dan is deze datum de einddatum van de periode waarin TML de goederen levert Negeer dit veld anders
termFeeText	string	50	Gevraagde datum van levering of ophaling in vrije tekst
requestedDeliverytimeWindow	string	11	Huidig gevraagd tijdvenster voor levering
deliveryRemark1Carrier	string	50	Eerste leverings of ophaal opmerking vervoerder
deliveryRemark2Carrier	string	50	Tweede leverings of ophaal opmerking vervoerder
deliveryRemark1Agent	string	50	Eerste leverings of ophaal opmerking agent
deliveryRemark2Agent	string	50	Tweede leverings of ophaal opmerking agent
deliveryRemarkOnBoardComputer	string	255	Opmerking geregistreerd door de chauffeur die de goederen heeft afgeleverd of opgehaald
status010DataIntegrated	Date		De datum dat de initiële data werd ingevoerd in onze database (formaat jjjj-MM-dd)
status020AnnouncementArrivalOfGoodsAtTheFirstHub	Date		De datum dat de goederen verwacht worden in de eerste hub (formaat jjjj-MM-dd)
status022ArrivalGoodsConfirmedAtTheFirstHub	DateTime		Ontvangst van de goederen bevestigd op de 1st hub (datum-tijd formaat)
status040UlteriorDateOfDelivery	Date		Datum berekend op basis van: Status020GoodsAnnouncedAtFirstHub, the first hub (aankomst van de goederen) en de finale hub (die de goederen zal uitleveren), in overeenstemming met een onderhandelde of standaard tabel (formaat jjjj-MM-dd)
status050LeftToNextHub	boolean		Waar, de laatste 'handling unit' is vertrokken vanaf de eerste hub
status060GoodsReceivedAtLastHub	boolean		Waar, de laatste 'handling unit' is aangekomen op de laatste hub
status070ExpectedDateOfDelivery	Date		Verwachte leveringsdatum. Goederen zijn gepland om op deze datum geleverd te worden (formaat jjjj-MM-dd). Opgelet! Indien het order van het type " RE" is dan is dit de geplande afhaaldatum!
stopSequence	integer		Leveringen vóór 15/09/2020: de geplande stopvolgnummer binnen de uitleverings/afhaalronde. Leveringen vanaf 15/09/2020: het nummer van de leverings/afhaalronde en de geplande stopvolgnummer binnen deze ronde. Formaat RRRRRRSSS of RRRRRRRRSSS (waarbij RRRRRR of RRRRRRRR het nummer is van de ronde en SSS het stopnummer).
numberOfStopSequence	integer		Het totale aantal stops binnen de ronde
status080OrderLoadedForDelivery	Date		Datum waarop de goederen geladen zijn voor uitlevering (formaat jjjj-MM-dd)
status082OrderLoadedForDeliveryByThirdParties	Date		Datum waarop de goederen geladen zijn voor uitlevering door een onderaannemer (formaat jjjj-MM-dd)
status084TourSendToOnBoardComputer	DateTime		De datum / tijd wanneer de rit verzonden is naar de boordcomputer
status090EtaNextStop	DateTime		De berekende ETA (voorziene aankomstuur) zoals berekend door de boordcomputer op het moment dat de stop is geactiveerd door de chaufeur en voorzover hij rijdt op GPS zoals geïnstrueerd
latitude090NextStop	decimal	18,8	De huidige bekende breedtegraad uit de TML-adressendatabase voor dit bestemmingsadres
longitude090NextStop	decimal	18,8	De huidige bekende lengtegraad van de TML-adressendatabase voor dit bestemmingsadres
status100ArrivalAtDestination	DateTime		Tijd en uur waarop de bestuurder aangaf aangekomen te zijn op de bestemming
latitude100Destination	decimal	18,8	De breedtegraad volgens de GPS
longitude100Destination	decimal	18,8	De lengtegraad volgens de GPS
status110StartingOfUnloading	DateTime		Begin van het lossen
statusDelivery	string	20	Beschrijving van de leveringsstatus: ' ' (Blanco) = Indien dataOfDelivery een datum bevat is dit order geleverd maar zonder boordcomputer, is dateOfDelivery niet ingevuld dan is dit order (nog) niet geleverd 'Cancelled TRA' = Geannulleerd volgens ERP-toepassing 'Delivered BOC' = Volledig geleverd volgens boordcomputer 'Not delivered TRA' = Niet geleverd volgens ERP-toepassing 'Not delivered BOC' = Niet geleverd volgens boordcomputer 'Part delivered BOC' = Gedeeltelijk geleverd volgens boordcomputer 'Delivered on MD BOC' = Geleverd op verschillende dagen volgens boordcomputer 'Third party BOC' = Overgedragen aan een derde DeliveryRemarkOnBoardComputer wordt opgevuld Status082 wordt opgevuld 'Refused TRA' = Geweigerd volgens ERP-toepassing 'Refused BOC' = Geweigerd volgens boordcomputer 'Loaded BOC' = Geladen volgens boordcomputer (retours) 'Part loaded BOC' = Gedeeltelijk geladen volgens boordcomputer (retours) 'Not loaded BOC' = Niet geladen volgens boordcomputer (retours)
dateOfDelivery	Date		Datum waarop de goederen werden geleverd (formaat jjjj-MM-dd)
status130DepartureAtDestination	DateTime		De datum / tijd waarop de bestuurder het vertrek registreert
pod	boolean		Waar, leverbon is aanwezig voor download
anomaly	boolean		Waar als er een annomalie werd geregistreerd op dit order
latestKnownLatitude	decimal	18,8	Laatst gekende positie van de vrachtwagen (tijdens het uitleveren van de goederen) vanaf het moment van vertrek van de vrachtwagen bij de leveringshub tot de afwerking van de stop voor dit order (latitude)
latestKnownLongitude	decimal	18,8	Laatst gekende positie van de vrachtwagen (tijdens het uitleveren van de goederen) vanaf het moment van vertrek van de vrachtwagen bij de leveringshub tot de afwerking van de stop voor dit order (longitude)
photos	boolean		Waar, er is/zijn foto('s) beschikbaar
packages	List[Packages]		Lijst met Colli details van alle collis in dit order
pods	List[Pod]		Lijst met locatiegegevens waarmee de link kan opgebouwd worden om de leverbonnen te downloaden (zie verder bij leverbonnen)

Sluit

Packages

Collies (packages) zijn de onderdelen van een order. Ze kunnen van order veranderen in geval van bijvoorbeeld een 'manco' of een 'geweigerde' colli. In tegenstelling tot het orderniveau is er geen samenvatting en gedetailleerd subniveau, er zijn echter wel verschillende opzoekmogelijkheden voor collies voorzien:

• Net als in de orders is het mogelijk om verschillende parameters te gebruiken om een lijst met collies op te zoeken [Get the Packages by search]
• Om informatie over één specifiek pakket op te vragen kan u de [Get the Packages by PackageId] gebruiken
• Alle collies van één order kan u opzoeken gebruik makend van het orderId via [Get the Packages by orderId]
• Om de eventuele anomalie-info met bijbehorende foto's voor een bepaalde colli op te vragen, kunt u [Get the anomalies of a Package by PackageId] gebruiken

Veldnaam	Veldtype	Lengte	Info
orderId	guid		Unieke OrderId nodig om details op te vragen
packageId	guid		Unieke Id van een colli
actualOrderNumberBD	integer		Huidig belgisch ordernummer
actualOrderNumberFD	integer		Huidig frans ordernummer
anomaly	boolean		Waar = Er werd een anomalie geregistreerd op deze colli
packageNumber	string	20	KTO colli nummer
grouped	boolean		Waar = Deze colli is gegroepeerd met andere collis in één handling unit
lastUpdateOn	DateTime		Timestamp van de laatste update
manco	boolean		Waar = Deze colli is manco
masterOrderNumberBD	integer		Belgische master ordernummer
masterOrderNumberFD	integer		Frans master ordernummer
packageNumberSupplier	string	30	Colli referentie leverancier
endCustomerNumber	string	20	Order- of referentienummer van de eindklant
status030PackagesReceivedAtFirstHub	DateTime		Timestamp ontvangst colli op de eerste Hub
status120Delivered	DateTime		Timestamp levering van de colli

Sluit

Leverbonnen (POD)

Deze opvraging zal een lijst met linken naar de leverbonnen teruggeven op basis van de opgegeven parameters:

• OrderId of colliId.
• De start- en einddatum (datum en tijd dat de colligegevens de laatste maal werden gewijzigd).
• Indien geen parameters worden meegegeven wordt een lege lijst terug gegeven.
  Opmerking: Indien er enkel een einddatum wordt meegegeven zonder startdatum dan zal de lege startdatum vervangen worden door de einddatum - 7 dagen.

[Get the pod-links by search]

Veldnaam	Veldtype	Lengte	Info
documentLink	string	30	'http://archov.transa.be/doc/' + documentLink + '.tif' = Link naar het document
pageNumber	integer		Paginanummer van het document

Sluit

Melting Points Deliveries

Deze opvraging zal een lijst met linken naar de leverbonnen teruggeven op basis van de opgegeven parameters:

• OrderId of colliId.
• De start- en einddatum (datum en tijd dat de colligegevens de laatste maal werden gewijzigd).
• Indien geen parameters worden meegegeven wordt een lege lijst terug gegeven.
  Opmerking: Indien er enkel een einddatum wordt meegegeven zonder startdatum dan zal de lege startdatum vervangen worden door de einddatum - 7 dagen.

[Get the pod-links by search]

Veldnaam	Veldtype	Lengte	Info
documentLink	string	30	'http://archov.transa.be/doc/' + documentLink + '.tif' = Link naar het document
pageNumber	integer		Paginanummer van het document

Sluit

Transport Request Upload

Met de KTO Api kan je ook een transportopdracht doorgeven. Één of meerdere orders die één of meerdere colli's bevatten kunnen gegroepeerd worden in één transportaanvraag. Elk adres dat gebruikt wordt (ophaaladres en alle leveringsadressen) moeten aanwezig zijn of toegevoegd worden aan uw adressen tabel in onze Api database. Swagger info: [Transport request upload]

Veldnaam	Veldtype	Lengte	Info
reverseLoad	boolean		Waar = het betreft een retour (default = onwaar)
collectDate	Date		Datum waarop TML de goederen moet verzamelen    (formaat yyyy-MM-dd)
reference	string	50	Uw transportreferentie
info	string	?	Informatie over het transportverzoek
orders	List[Orders]		Lijst met nieuwe bestellingen en / of bestellingen die moeten worden gewijzigd voor deze load
pickUpAddressCode	integer		Id van het adres in de adressentabel
addresses	List[Address]		Lijst met nieuwe adressen en / of adressen die kunnen worden gewijzigd

Sluit

Addresses

Bij gebruik van de Api transportopdrachten moeten alle gebruikte adressen beschikbaar zijn in de Api database. U kan al uw adressen in onze database opvragen (met paging - zie hierboven) [Get all addresses] U kan nieuwe adressen toevoegen met [Insert address], wissen met [Delete address], één specifiek adres opvragen met [Get single address], en wijzigen met [Update address].

De opmerking zal in princiepe opgenomen worden in elk order dat het adres gebruikt wordt als default. Op orderniveau kan het eventueel wel overschreven worden.

Veldnaam	Veldtype	Lengte	Info
addressCode	int		Unieke code voor het adres
name	string	40	Naam voor dit adres
name	string	55	Straatnaam, huisnummer en busnummer
isoCountryCode	string	3	Code in 2 posities om het land te identificeren (ISO 3166-1). Bijvoorbeeld BE (België), FR (Frankrijk). Meer info zie https://datahub.io/core/country-list
postCode	string	10	Postcode
city	string	40	Stad
remark	string	55	Opmerking over dit leveradres, deze zal bij elke bestelling worden weergegeven. Deze opmerking kan overschreven worden op orderniveau.
phoneNumber	string	50	Telefoonnummer
email	string	50	Email
eanCode	string	13	De beveiligingscode om toegang te geven tot onze data voor alle leveringen op dit adres

Sluit

Anomaly

Ophalen van de colli-anomalieën via PackageId

Veldnaam	Veldtype	Lengte	Info
packageNumber	string	20	KTO colli nummer
packageId	guid		Unieke Id van een colli
orderId	guid		Unieke OrderId nodig om details op te vragen
anomalieDescription	string	50	Omschrijving van de anomalie (01-kernbreuk/02-beschadigde verpakking/...) 01-Kernbreuk 02-Verpakkingsschade 03-Vuil (vb. vet) 04-Waterschade 05-Slecht opgerold 06-Rol beschadigd 07-Ingedeukte rol 08-Pallet beschadigd 09-Slecht geconditioneerd 10-Volledig verlies wegens schade 12-Colli beschadigd 38-Pallet ontbrekende colli 50-Colli buiten proportie 20-Gewicht 13-colli opnieuw verpakt door de afzender Goederen beschadigd GEWEIGERD Goederen beschadigd GELEVERD Inventaris Niemand aanwezig Verkeerd adres Fout afzender Probleem RDV Lossen onmogelijk Niet besteld GEWEIGERD Bestelling geannuleerd Gesloten zonder info Verpakkingsschade GEWEIGERD Niet bereikbaar Manco Reeds ontvangen GEWEIGERD Slecht opgerold GEWEIGERD Probleem levertermijn Geen plaats Ingedeukte rol GEWEIGERD Slecht geconditioneerd GEWEIGERD Waterschade GEWEIGERD Onvolledig order Ontelbaar Verpakkingsschade GELEVERD Slecht opgerold GELEVERD Ingedeukte rol GELEVERD Slecht geconditioneerd GELEVERD Waterschade GELEVERD Overgedragen aan derden Voorlopig afgeleverd bij een andere klant 14-Foto zonder anomalie-registratie 51-Diameter Niemand aanwezig GELEVERD
id	integer		Id van de foto
photos	List[Photos]		Lijst met alle foto-records (op colliniveau)

Sluit

Photos

Foto's voor een opgegeven OrderId

Veldnaam	Veldtype	Lengte	Info
id	integer		Id van de foto
photoData	binary text		Binaire data van de foto

Sluit

TransportRequest

Inleiding

Dit document beschrijft het algemene XML-protocol dat vanaf 2020 zal worden gebruikt in de TML Flooring divisie, maar kan worden gebruikt door alle partijen die xml-bestanden willen aanleveren die moeten worden geïntegreerd in de back-end toepassingen van de TML groep. Het bevat alle benodigde gegevens om een transportorder te maken.
De beschrijving geeft ook aan welke van de aangeboden velden gebruikt kunnen worden om zoekopdrachten uit te voeren in onze API en Private Portal.
Wij doen continu aanpassingen om waar nodig te fine-tunen.

XSD contract

Het xsd contract voor het maken van een geldige xml is ook beschikbaar. Het is een goede gewoonte om dit te gebruiken wanneer u uw code ontwikkelt om de XML te creëren. Immers, je kunt elke xml die gemaakt wordt valideren via deze xsd. De xsd is: TransportRequest.xsd.
Voorbeeld van een correct XML request.

Omschrijving

Een XML-bestand dat voldoet aan het standaard XML-protocol bevat een leveringsaanvraag met één of meer leveringen of een omgekeerde logistieke aanvraag. Elke levering, bevat een beschrijving van de bestelling, 0 of meer opmerkingen en minimum 1 colli.
Zorg ervoor dat alle informatie aanwezig is in het bestand om de leveringsbon te kunnen afdrukken die wij aan uw klant zullen aanbieden.

Indien een niet verplichte tag niet aanwezig is in de xml zal de informatie niet in rekening worden genomen.
Raadpleeg steeds de xsd voor types, lengtes en validatieregels.
De volgende elementen werden gebruikt in de beschrijving van de tags:

• M: is de tag verplicht of niet
• L: de maximale lengte van de tag
• API: kan men in de API zoeken op de inhoud van deze tag
• PP: kan op de inhoud van deze tag worden gezocht in het privéportaal

TransportRequest

Bevat een DeliveryRequest en /of een ReverseLogisticsRequest (nog niet geïmplementeerd).

Attribuutnaam	Verplicht	Veldtype	Lengte	Omschrijving	API	PP
CreatedBy	N	string	40	Beschrijving van het programma / de toepassing die dit XML-bestand heeft gemaakt in hoofdletters.

Sluit