1 General
1.1 System
MyMPS is a SCHENKER application developed to support handling of marineparts. It is built on modern Internet technology, and can easily be accessed from anywhere in the world without any installation.
The system is a multi-layer architecture, developed in .Net and running on Windows and MS SQL
1.2 Description
This document explains how MyMPS can send status messages to the client. This is the specification. This document explains the Status messages that are sent from MyMPS. Status messages will send for every hour if updates are done.
1.3 Architecture
An exemplified overview of the set-up, this based on MyMPS standard format which is included in the document. This document describes Status Messages. Status messages will be sent on scheduled basis, in every hour.
2 EDI integration – Status messages
MyMPS standard is to send xml-files to a local that is available via ftp. Other format than MyMPS standard has to be mapped.
2.1 File format
Document will be encoded using UTF-8.
2.1.1 XMLStructure
Envelope
Attribute | Code | Man | Explanation | Type |
FromPartner |
| Y | Provided from MyMPS team | string(50) |
FromPartnerUser |
| Y |
| string(50) |
ToPartner | MYMPS | Y | Fixed | |
ToPartnerUser |
| Y |
| string(50) |
DateTime |
| Y | Time when message was created | dateTime |
DocumentVersion | 1.0 | Y | Version of this fileformat | string(10) |
DocumentNumber |
| Y | Unique reference number for message. First message no 1 then 2,3 etc | Unsigned integer, max: 2147483647 |
DocumentName | ORDERSTATUS | Y | Message name ”ORDERSTATUS” | Fixed |
Order
Attribute | Code | Man | Explanation | Comment | Type |
OrderId |
| Y | OrderId |
| Integer |
OrderNumber |
| Y | OrderNumber |
| String(200) |
PortCode5CL |
| Y | Port code |
| String(50) |
PortCode3CL |
| Y | Port code |
| String(50) |
LocationType |
| Y | Type of location |
| V50 |
RefNo |
| Y | Buyer's PO Reference Number |
| V 50 |
ChangeDate |
| Y | Date for the statuschange |
| YY-MM-DD hh:mm |
RequistionNo |
| N | RequistionsNo |
| V15 |
Status | NEW HUB DEP ANN PEN BKD DLV ARR | Y | NEW=New order HUB=Received DEP=Departed ANN=Cancelled PEN=Pending BKD=Booked DLV=Delivered ARR=Arrived |
| V50 |
CargoDetials |
| N | Used to add the package details |
| TypePackage |
TypePackage
Attribute | Code | Man | Explanation | Comment | Type |
Quantity |
| N | Package quantity |
| Integer |
Weight |
| N | Package weight |
| Decimal |
Length |
| N | Package length |
| Decimal |
Width |
| N | Package width |
| Decimal |
Height |
| N | Package height |
| Decimal |
Stackable |
| N | Is package stackable |
| Boolean |
DangerousGoods |
| N | Is Package contains dangerous goods |
| Boolean |
DGNumberOfPackages |
| N | DGNumberOfPackages |
| String(50) |
DGTypeOfPackages |
| N | DGTypeOfPackages |
| String(50) |
DGContentOfPackages |
| N | DGContentOfPackages |
| String(50) |
DGCargoAircraftOnly |
| N | DGCargoAircraftOnly |
| Boolean |
DGMarinePollutant |
| N | DGMarinePollutant |
| Boolean |
DGLimitedQuantity |
| N | DGLimitedQuantity |
| Boolean |
DGUnNumber |
| N | DGUnNumber |
| String(50) |
DgdgrClass |
| N | DgdgrClass |
| String(50) |
DGPackageGroup |
| N | DGPackageGroup |
| String(50) |
DGWeightValue |
| N | DGWeightValue |
| Decimal |
DGWeightUnit |
| N | DGWeightUnit |
| String(50) |
DGVolumeValue |
| N | DGVolumeValue |
| Decimal |
DGVolumeUnit |
| N | DGVolumeUnit |
| String(50) |
DGShippingName |
| N | DGShippingName |
| String(50) |
DGTechnicalName |
| N | DGTechnicalName |
| String(50) |
3 Example
3.1 XML Status message
<?xml version="1.0" encoding="utf-8"?>
<LxirEnvelope>
<Header FromPartner="MyMPS" FromPartnerUser="User1" ToPartner="Client" ToPartnerUser="ClientUser" DateTime="1900-01-01T01:01:01+01:00" DocumentVersion="1.0" DocumentNumber="123" DocumentName="ORDERSTATUS" />
<Body>
<OrderStatus>
<OrderId>123</OrderId>
<OrderNumber>str1234</OrderNumber>
<PortCode5CL>str1234</PortCode5CL>
<PortCode3CL>str1234</PortCode3CL>
<LocationType>Air</LocationType>
<RefNNo>str1234</RefNNo>
<ChangeDate>2012-12-13T12:12:12</ChangeDate>
<RequisitionNumber>str1234</RequisitionNumber>
<Status>NEW</Status>
<CargoDetails>
<Packages>
<Quantity>123</Quantity>
<Weight>123.45</Weight>
<Length>123.45</Length>
<Width>123.45</Width>
<Height>123.45</Height>
<Stackable>true</Stackable>
<DangerousGoods>true</DangerousGoods>
<DGNumberOfPackages>123</DGNumberOfPackages>
<DGTypeOfPackages>str1234</DGTypeOfPackages>
<DGContentOfPackages>str1234</DGContentOfPackages>
<DGCargoAircraftOnly>true</DGCargoAircraftOnly>
<DGMarinePollutant>true</DGMarinePollutant>
<DGLimitedQuantity>true</DGLimitedQuantity>
<DGUnNumber>str1234</DGUnNumber>
<DGdgrClass>str1234</DGdgrClass>
<DGPackageGroup>str1234</DGPackageGroup>
<DGWeightValue>123.45</DGWeightValue>
<DGWeightUnit>str1234</DGWeightUnit>
<DGVolumeValue>123.45</DGVolumeValue>
<DGVolumeUnit>str1234</DGVolumeUnit>
<DGShippingName>str1234</DGShippingName>
<DGTechnicalName>str1234</DGTechnicalName>
</Packages>
</CargoDetails>
</OrderStatus>
</Body>
</LxirEnvelope>
Version
3.2 History
Version and date | Author | Comment |
PA1 2011-11-20 | Martin Fransson | First draft without example |
PA2 2011-11-21 | Martin Fransson | With example |
PA3 2011-12-12 | Martin Fransson | Added requisition Number after meeting with Helge |
PA4 2012-04-20 | Niclas Sparr | Added xsd and changed fileformat |
PA5 2012-05-16 | Muhammad Jawad | Added PortCode5CL, PortCode3CL, LocationType and LocationType enum |
PA6 2015-03-24 | Muhammad Jawad | Added cargo details and package info |