CSmart 300
From UG
(→Transaction Info) |
(→General Info) |
||
Line 52: | Line 52: | ||
Holds the information regarding the file itself. | Holds the information regarding the file itself. | ||
- | * Name // Type // Min/Max // Req // Description | + | * '''Name // Type // Min/Max // Req // Description''' |
* '''BatchNumber''' // N // 1/14 // M // Serves as a identify number for a booking | * '''BatchNumber''' // N // 1/14 // M // Serves as a identify number for a booking | ||
Line 71: | Line 71: | ||
=== ActionType === | === ActionType === | ||
- | '''ActionType''' // AN // 1/3 // M // Indicates if new request, Update or Cancellation. Accepted values are NEW, UPD and CAN. | + | * '''ActionType''' // AN // 1/3 // M // Indicates if new request, Update or Cancellation. |
- | + | ** Accepted values are NEW, UPD and CAN. | |
- | + | ||
- | + | ||
- | + | ||
=== SCAC === | === SCAC === | ||
- | * '''SCAC''' // AN // 1/10 // M // Standard Carrier Alpha Code (SCAC) | + | * '''SCAC''' // AN // 1/10 // M // Standard Carrier Alpha Code (SCAC) |
+ | ** map to [[Steamshipline#SCACCode]] | ||
=== Requested === | === Requested === | ||
- | |||
* '''Date''' // AN // 1/14 // M // Date the request was made Format: ccYYMMDDHHmmSS | * '''Date''' // AN // 1/14 // M // Date the request was made Format: ccYYMMDDHHmmSS | ||
- | ** | + | ** map to current server date |
== ShipmentDetails == | == ShipmentDetails == |
Revision as of 00:08, 29 October 2013
Contents |
Message Structure
<?xml version="1.0" encoding="utf-8"?> <Booking xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="br.xsd"> <Request> <GeneralInfo> ... </GeneralInfo> <ShipmentDetails> ... </ShipmentDetails> </Request> </Booking>
General Info
<TransactionInfo> <BatchNumber>2147483647</BatchNumber> <MessageSender>SINOTRANSGD</MessageSender> <MessageRecipient>CARGOSMART</MessageRecipient> <MessageID>BRXML</MessageID> <DateCreated TimeZone="HKT">20060131004112</DateCreated> <FileName>sample_br.xml</FileName> <Version>1.0</Version> </TransactionInfo> <ActionType>NEW</ActionType> <CSReferenceNumber>CS0674641363</CSReferenceNumber> <SCAC>NYKS</SCAC> <Requested> <By>NYKS</By> <Date TimeZone="HKT">20060131004116</Date> </Requested>
Transaction Info
Holds the information regarding the file itself.
- Name // Type // Min/Max // Req // Description
- BatchNumber // N // 1/14 // M // Serves as a identify number for a booking
- should we use MySQL id for a rec in MasterOcean tbl?
- MessageSender // AN // 1/15 // M // Trading partner ID for incoming, “CARGOSMART” for outgoing
- constant, TBD
- MessageRecipient // AN // 1/15 // M // Trading partner ID for outgoing, “CARGOSMART” for incoming
- constant, TBD
- MessageID // AN // 1/15 // M // Type of message
- default to BRXML (always?)
- Version // AN // 1/7 // M // schema version used
- constant, TBD
ActionType
- ActionType // AN // 1/3 // M // Indicates if new request, Update or Cancellation.
- Accepted values are NEW, UPD and CAN.
SCAC
- SCAC // AN // 1/10 // M // Standard Carrier Alpha Code (SCAC)
- map to Steamshipline#SCACCode
Requested
- Date // AN // 1/14 // M // Date the request was made Format: ccYYMMDDHHmmSS
- map to current server date
ShipmentDetails
<UserReferences> ... </UserReferences>
<LegalParties> ... </LegalParties>
<RouteInformation> ... </RouteInformation>
<EquipmentInformation> ... <EquipmentInformation>
<CargoInformation> ... </CargoInformation>
UserReferences
<UserReferences> <References> <ReferenceType>CR</ReferenceType> <ReferenceNumber>52634</ReferenceNumber> <ReferenceDescription>Customer Reference Number </ReferenceDescription> </References> </UserReferences>
- ReferenceNumber // AN // 1/35 // M // Reference numbers attached to a particular shipment. These numbers were used to identify the shipment as compared to other shipments submitted to the carrier.
- ReferenceType // AN // 1/5 // M // Describes the type of Reference Number used to qualify/identify the reference number.
Reference “CR” is required, it‟s the unique number to identify each booking request.
LegalParties
<Party> <PartyType>BP</PartyType> <PartyName>BookingParty</PartyName> <PartyLocation> <Address> <AddressLines>930 E. 223rd St.</AddressLines> <AddressLines>Carson, US 90745</AddressLines> </Address> <Street>930 E. 223rd St.</Street> <City>Carson</City> <CountryCode>US</CountryCode> <CountryName>United State</CountryName> <PostalCode>90745</PostalCode>
</PartyLocation> <ContactPerson>
<FirstName>FirstName</FirstName> <LastName>LastName</LastName> <Email>FirstName@yahoo.com</Email> </ContactPerson>
</Party> <Party> <PartyType>SH</PartyType> <PartyName>Shipper</PartyName> <PartyLocation>
<Street>1800 Century Park East</Street> <City>Los Angeles</City> <StateProvince>California</StateProvince> <CountryCode>US</CountryCode> <CountryName>United State</CountryName> <PostalCode>90067</PostalCode>
</PartyLocation> </Party>
</LegalParties>
Example
<?xml version="1.0" encoding="utf-8"?> <Booking xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="br.xsd"> <Request> <GeneralInfo> <TransactionInfo> <BatchNumber>2147483647</BatchNumber> <MessageSender>SINOTRANSGD</MessageSender> <MessageRecipient>CARGOSMART</MessageRecipient> <MessageID>BRXML</MessageID> <DateCreated TimeZone="HKT">20060131004112</DateCreated> <FileName>sample_br.xml</FileName> <Version>1.0</Version> </TransactionInfo> <ActionType>NEW</ActionType> <CSReferenceNumber>CS0674641363</CSReferenceNumber> <SCAC>NYKS</SCAC> <Requested> <By>NYKS</By> <Date TimeZone="HKT">20060131004116</Date> </Requested> </GeneralInfo> <ShipmentDetails> <UserReferences> <References> <ReferenceType>CR</ReferenceType> <ReferenceNumber>52634</ReferenceNumber> <ReferenceDescription>Customer Reference Number</ReferenceDescription> </References> </UserReferences> <LegalParties> <Party> <PartyType>BP</PartyType> <PartyName>BookingParty</PartyName> <PartyLocation> <Address> <AddressLines>930 E. 223rd St.</AddressLines> <AddressLines>Carson, US 90745</AddressLines> </Address> <Street>930 E. 223rd St.</Street> <City>Carson</City> <CountryCode>US</CountryCode> <CountryName>United State</CountryName> <PostalCode>90745</PostalCode> </PartyLocation> <ContactPerson> <FirstName>FirstName</FirstName> <LastName>LastName</LastName> <Email>FirstName@yahoo.com</Email> </ContactPerson> </Party> <Party> <PartyType>SH</PartyType> <PartyName>Shipper</PartyName> <PartyLocation> <Street>1800 Century Park East</Street> <City>Los Angeles</City> <StateProvince>California</StateProvince> <CountryCode>US</CountryCode> <CountryName>United State</CountryName> <PostalCode>90067</PostalCode> </PartyLocation> </Party> </LegalParties> <RouteInformation> <IntendedDates> <From TimeZone="LOCAL">20051002000000</From> <To TimeZone="LOCAL">20051030000000</To> <Range>S</Range> </IntendedDates> <Location> <FunctionCode>POR</FunctionCode> <LocationName>LOS ANGELES</LocationName> <LocationDetails> <Street>102 Road</Street> <City>Los Angeles</City> <CountryCode>US</CountryCode> <CountryName>United State</CountryName> <LocationCode> <UNLocationCode>USLAX</UNLocationCode> </LocationCode> </LocationDetails> </Location> <Location> <FunctionCode>FND</FunctionCode> <LocationName>Xiamen</LocationName> <LocationDetails> <Street>102 Road</Street> <City>Xiamen</City> <CountryName>China</CountryName> <LocationCode> <UNLocationCode>CNXMN</UNLocationCode> </LocationCode> </LocationDetails> </Location> <Intermodal> <VesselVoyageInformation> <ServiceName>NY</ServiceName> <VoyageNumberDirection>048E</VoyageNumberDirection> </VesselVoyageInformation> <Location> <FunctionCode>POL</FunctionCode> <LocationName>LOS ANGELES</LocationName> <LocationDetails> <Street>102 Road</Street> <City>Los Angeles</City> <CountryCode>US</CountryCode> <CountryName>United Stated</CountryName> <LocationCode> <UNLocationCode>USLAX</UNLocationCode> </LocationCode> </LocationDetails> </Location> <Location> <FunctionCode>POD</FunctionCode> <LocationName>Xiamen</LocationName> <LocationDetails> <Street>102 Road</Street> <City>Xiamen</City> <CountryName>China</CountryName> <LocationCode> <UNLocationCode>CNXMN</UNLocationCode> </LocationCode> </LocationDetails> </Location> </Intermodal> </RouteInformation> <EquipmentInformation> <Containers> <ContainerType>4260</ContainerType> <Quantity>5</Quantity> <Weight Units="KGS" Qualifier="GROSS">1000000</Weight> <SOCIndicator>0</SOCIndicator> <OutBound> <isMerchantHaulage>0</isMerchantHaulage> </OutBound> <InBound> <isMerchantHaulage>0</isMerchantHaulage> </InBound> </Containers> </EquipmentInformation> <CargoInformation> <CargoDetails> <CargoNature>GC</CargoNature> <TrafficMode> <OutBound>FCL</OutBound> <InBound>FCL</InBound> </TrafficMode> </CargoDetails> </CargoInformation> </ShipmentDetails> </Request> </Booking>