CSmart 300

From UG

(Difference between revisions)
Jump to: navigation, search
(Created page with 'Category:Ocean Status == Example == <pre> < ? xml version="1.0" encoding="utf - 8" ?> < Booking xmlns:xsi ="http://www.w3.org/2001/XMLSchema - instance" xsi:noNamespaceSch…')
(CSReferenceNumber)
 
(37 intermediate revisions not shown)
Line 1: Line 1:
[[Category:Ocean Status]]
[[Category:Ocean Status]]
-
== Example ==
+
== Message Structure ==
<pre>
<pre>
-
<
+
<?xml version="1.0" encoding="utf-8"?>
-
?
+
<Booking xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="br.xsd">
-
xml version="1.0" encoding="utf
+
  <Request>  
-
-
+
    <GeneralInfo>
-
8"
+
    ...
-
?>
+
    </GeneralInfo>
-
<
+
    <ShipmentDetails>
-
Booking
+
    ...
-
xmlns:xsi
+
    </ShipmentDetails>
-
="http://www.w3.org/2001/XMLSchema
+
  </Request>
-
-
+
</Booking>
-
instance"
+
-
xsi:noNamespaceSchemaLocation
+
-
="br.xsd">
+
-
<
+
-
Request
+
-
>
+
-
<
+
-
GeneralInfo
+
-
>
+
-
<
+
-
TransactionInfo
+
-
>
+
-
<
+
-
BatchNumber
+
-
>
+
-
2147483647
+
-
</
+
-
BatchNumber
+
-
>
+
-
<
+
-
MessageSender
+
-
>
+
-
SINOTR
+
-
ANSGD
+
-
</
+
-
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
+
-
>
+
-
<
+
-
UserReferen
+
-
ces
+
-
>
+
-
<
+
-
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 S
+
-
t.
+
-
</
+
-
Street
+
-
>
+
-
<
+
-
City
+
-
>
+
-
Carson
+
-
</
+
-
City
+
-
>
+
-
<
+
-
CountryCode
+
-
>
+
-
US
+
-
</
+
-
CountryCode
+
-
>
+
-
<
+
-
CountryName
+
-
>
+
-
United State
+
-
</
+
-
CountryName
+
-
>
+
-
<
+
-
PostalCode
+
-
>
+
-
90745
+
-
</
+
-
PostalCode
+
-
>
+
-
</
+
-
PartyLocation
+
-
>
+
-
<
+
-
ContactPerson
+
-
>
+
-
<
+
-
FirstName
+
-
>
+
-
FirstName
+
-
</
+
-
FirstName
+
-
>
+
-
<
+
-
LastName
+
-
>
+
-
L
+
-
astName
+
-
</
+
-
LastName
+
-
>
+
-
<
+
-
Email
+
-
>
+
-
FirstName@yahoo.com
+
-
</
+
-
Email
+
-
>
+
-
Booking Request Implementation Guideline
+
-
(XML Format)
+
-
© CargoSmart Proprietary
+
-
Page
+
-
108
+
-
of
+
-
109
+
-
Last saved:
+
-
1 Jun 2011
+
-
CS
+
-
-
+
-
SYSINT
+
-
-
+
-
STD
+
-
-
+
-
IG
+
-
-
+
-
BR.XML
+
-
</
+
-
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
+
-
>
+
-
<
+
-
RouteInformatio
+
-
n
+
-
>
+
-
<
+
-
IntendedDates
+
-
>
+
-
<
+
-
From
+
-
TimeZone
+
-
="LOCAL">
+
-
20051002000000
+
-
</
+
-
From
+
-
>
+
-
<
+
-
To
+
-
TimeZone
+
-
="LOCAL">
+
-
20051030000000
+
-
</
+
-
To
+
-
>
+
-
<
+
-
Range
+
-
>
+
-
S
+
-
</
+
-
Range
+
-
>
+
-
</
+
-
IntendedDates
+
-
>
+
-
<
+
-
Location
+
-
>
+
-
<
+
-
FunctionCode
+
-
>
+
-
POR
+
-
</
+
-
FunctionCode
+
-
>
+
-
<
+
-
LocationName
+
-
>
+
-
LOS ANGELES
+
-
</
+
-
LocationN
+
-
ame
+
-
>
+
-
<
+
-
LocationDetails
+
-
>
+
-
<
+
-
Street
+
-
>
+
-
102 Road
+
-
</
+
-
Street
+
-
>
+
-
<
+
-
City
+
-
>
+
-
Los Angeles
+
-
</
+
-
City
+
-
>
+
-
<
+
-
CountryCode
+
-
>
+
-
US
+
-
</
+
-
CountryCode
+
-
>
+
-
<
+
-
CountryName
+
-
>
+
-
United State
+
-
</
+
-
CountryName
+
-
>
+
-
<
+
-
LocationCode
+
-
>
+
-
<
+
-
UNLocationCode
+
-
>
+
-
USLAX
+
-
</
+
-
UNLocationCode
+
-
>
+
-
</
+
-
Location
+
-
Code
+
-
>
+
-
</
+
-
LocationDetails
+
-
>
+
-
</
+
-
Location
+
-
>
+
-
<
+
-
Location
+
-
>
+
-
<
+
-
FunctionCode
+
-
>
+
-
FND
+
-
</
+
-
FunctionCode
+
-
>
+
-
<
+
-
LocationName
+
-
>
+
-
Xiamen
+
-
</
+
-
LocationName
+
-
>
+
-
<
+
-
LocationDetails
+
-
>
+
-
<
+
-
Street
+
-
>
+
-
102 Road
+
-
</
+
-
Street
+
-
>
+
-
<
+
-
City
+
-
>
+
-
Xiamen
+
-
</
+
-
City
+
-
>
+
-
<
+
-
CountryName
+
-
>
+
-
China
+
-
</
+
-
CountryNa
+
-
me
+
-
>
+
-
<
+
-
LocationCode
+
-
>
+
-
<
+
-
UNLocationCode
+
-
>
+
-
CNXMN
+
-
</
+
-
UNLocationCode
+
-
>
+
-
</
+
-
LocationCode
+
-
>
+
-
</
+
-
LocationDetails
+
-
>
+
-
</
+
-
Location
+
-
>
+
-
<
+
-
Intermodal
+
-
>
+
-
<
+
-
VesselVoyageInformation
+
-
>
+
-
<
+
-
ServiceName
+
-
>
+
-
NY
+
-
</
+
-
ServiceName
+
-
>
+
-
<
+
-
VoyageNumberDirection
+
-
>
+
-
048E
+
-
</
+
-
Voya
+
-
geNumberDirection
+
-
>
+
-
</
+
-
VesselVoyageInformation
+
-
>
+
-
<
+
-
Location
+
-
>
+
-
<
+
-
FunctionCode
+
-
>
+
-
POL
+
-
</
+
-
FunctionCode
+
-
>
+
-
<
+
-
LocationName
+
-
>
+
-
LOS ANGELES
+
-
</
+
-
LocationName
+
-
>
+
-
<
+
-
LocationDetails
+
-
>
+
-
Booking Request Implementation Guideline
+
-
(XML Format)
+
-
© CargoSmart Proprietary
+
-
Page
+
-
109
+
-
of
+
-
109
+
-
Last saved:
+
-
1 Jun 2011
+
-
CS
+
-
-
+
-
SYSINT
+
-
-
+
-
STD
+
-
-
+
-
IG
+
-
-
+
-
BR.XML
+
-
<
+
-
Street
+
-
>
+
-
102 Road
+
-
</
+
-
Street
+
-
>
+
-
<
+
-
City
+
-
>
+
-
Los Angeles
+
-
</
+
-
City
+
-
>
+
-
<
+
-
Countr
+
-
yCode
+
-
>
+
-
US
+
-
</
+
-
CountryCode
+
-
>
+
-
<
+
-
CountryName
+
-
>
+
-
United Stated
+
-
</
+
-
CountryName
+
-
>
+
-
<
+
-
LocationCode
+
-
>
+
-
<
+
-
UNLocationCode
+
-
>
+
-
USLAX
+
-
</
+
-
UNLocationCode
+
-
>
+
-
</
+
-
LocationCode
+
-
>
+
-
</
+
-
LocationDetails
+
-
>
+
-
</
+
-
Location
+
-
>
+
-
<
+
-
Location
+
-
>
+
-
<
+
-
FunctionCode
+
-
>
+
-
POD
+
-
</
+
-
FunctionCo
+
-
de
+
-
>
+
-
<
+
-
LocationName
+
-
>
+
-
Xiamen
+
-
</
+
-
LocationName
+
-
>
+
-
<
+
-
LocationDetails
+
-
>
+
-
<
+
-
Street
+
-
>
+
-
102 Road
+
-
</
+
-
Street
+
-
>
+
-
<
+
-
City
+
-
>
+
-
Xiamen
+
-
</
+
-
City
+
-
>
+
-
<
+
-
CountryName
+
-
>
+
-
China
+
-
</
+
-
CountryName
+
-
>
+
-
<
+
-
LocationCode
+
-
>
+
-
<
+
-
UNLocationCode
+
-
>
+
-
CNXMN
+
-
</
+
-
UNLocationCode
+
-
>
+
-
</
+
-
Location
+
-
Code
+
-
>
+
-
</
+
-
LocationDetails
+
-
>
+
-
</
+
-
Location
+
-
>
+
-
</
+
-
Intermodal
+
-
>
+
-
</
+
-
RouteInformation
+
-
>
+
-
<
+
-
EquipmentInformation
+
-
>
+
-
<
+
-
Containers
+
-
>
+
-
<
+
-
ContainerType
+
-
>
+
-
4260
+
-
</
+
-
ContainerType
+
-
>
+
-
<
+
-
Quantity
+
-
>
+
-
5
+
-
</
+
-
Quantity
+
-
>
+
-
<
+
-
Weight
+
-
Units
+
-
="KGS"
+
-
Qualifier
+
-
="GROSS">
+
-
1000000
+
-
</
+
-
Wei
+
-
ght
+
-
>
+
-
<
+
-
SOCIndicator
+
-
>
+
-
0
+
-
</
+
-
SOCIndicator
+
-
>
+
-
<
+
-
OutBound
+
-
>
+
-
<
+
-
isMerchantHaulage
+
-
>
+
-
0
+
-
</
+
-
isMerchantHaulage
+
-
>
+
-
</
+
-
OutBound
+
-
>
+
-
<
+
-
InBound
+
-
>
+
-
<
+
-
isMerchantHaulage
+
-
>
+
-
0
+
-
</
+
-
isMerchantHaulage
+
-
>
+
-
</
+
-
InBound
+
-
>
+
-
</
+
-
Containers
+
-
>
+
-
</
+
-
EquipmentInformation
+
-
>
+
-
<
+
-
CargoInf
+
-
ormation
+
-
>
+
-
<
+
-
CargoDetails
+
-
>
+
-
<
+
-
CargoNature
+
-
>
+
-
GC
+
-
</
+
-
CargoNature
+
-
>
+
-
<
+
-
TrafficMode
+
-
>
+
-
<
+
-
OutBound
+
-
>
+
-
FCL
+
-
</
+
-
OutBound
+
-
>
+
-
<
+
-
InBound
+
-
>
+
-
FCL
+
-
</
+
-
InBound
+
-
>
+
-
</
+
-
TrafficMode
+
-
>
+
-
</
+
-
CargoDetails
+
-
>
+
-
</
+
-
CargoInformation
+
-
>
+
-
</
+
-
ShipmentDetails
+
-
>
+
-
</
+
-
Request
+
-
>
+
-
</
+
-
Booking
+
-
>
+
 +
</pre>
 +
 +
== General Info ==
 +
 +
<pre>
 +
 +
<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>
</pre>
</pre>
 +
 +
=== 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
 +
 +
* '''MessageSender''' // AN // 1/15 // M // Trading partner ID for incoming, “CARGOSMART” for outgoing
 +
 +
* '''MessageRecipient''' // AN // 1/15 // M // Trading partner ID for outgoing, “CARGOSMART” for incoming
 +
 +
* '''MessageID''' // AN // 1/15 // M // Type of message, default to BRXML
 +
 +
* DateCreated // N // 0/14 // O // Date the file was created. Format: ccyyMMddHHmmss
 +
 +
* FileName // AN // 0/60 // O // File Name
 +
 +
* '''Version''' // AN // 1/7 // M // schema version used
 +
 +
=== ActionType ===
 +
 +
'''ActionType''' // AN // 1/3 // M // Indicates if new request, Update or Cancellation. Accepted values are NEW, UPD and CAN.
 +
 +
=== CSReferenceNumber ===
 +
 +
* CSReferenceNumber // AN // 0/12 // O // Booking Number generated by CargoSmart
 +
** per Luis we do not need this
 +
 +
=== SCAC ===
 +
 +
* '''SCAC''' // AN // 1/10 // M // Standard Carrier Alpha Code (SCAC) // map to [[Steamshipline#SCACCode]]
 +
 +
=== Requested ===
 +
 +
* By // AN // 0/8 // O // Person/company who makes the request
 +
 +
* '''Date''' // AN // 1/14 // M // Date the request was made Format: ccYYMMDDHHmmSS
 +
** ''attribute'': Timezone // AN // 0/30 // O // Time Zone where the date it describes happened.
 +
 +
== ShipmentDetails ==
 +
 +
<UserReferences>
 +
...
 +
</UserReferences>
 +
 +
<LegalParties>
 +
...
 +
</LegalParties>
 +
 +
<RouteInformation>
 +
...
 +
</RouteInformation>
 +
 +
<EquipmentInformation>
 +
...
 +
<EquipmentInformation>
 +
 +
<CargoInformation>
 +
...
 +
</CargoInformation>
 +
 +
=== UserReferences ===
 +
 +
<pre>
 +
<UserReferences>
 +
  <References>
 +
  <ReferenceType>CR</ReferenceType>   
 +
  <ReferenceNumber>M987645</ReferenceNumber> 
 +
  <ReferenceDescription>Customer Reference Number 
 +
  </ReferenceDescription>
 +
  </References>
 +
</UserReferences>
 +
</pre>
 +
 +
* '''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.
 +
** Use [[Master#Master Number]]
 +
 +
* '''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.
 +
** Use "CR"
 +
 +
=== LegalParties ===
 +
 +
This node holds the legal parties associated to that shipment. Parties included are the shipper, consignee, forwarder, notify and also notify.
 +
 +
<pre>
 +
 +
<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>
 +
 +
</pre>
 +
 +
Map: see [[EDI 300#Parties]]
 +
 +
NOTE:
 +
Per Luis even though Address=Optional in schema pdf
 +
we should send address.
 +
 +
=== RouteInformation ===
 +
 +
This node holds the route information of a particular shipment including the related intermodal and port locations.
 +
 +
==== IntendedDates ====
 +
 +
Intended sailing schedule.
 +
 +
<IntendedDates>
 +
  <From TimeZone="LOCAL">20051002000000</From>
 +
  <To TimeZone="LOCAL">20051030000000</To>
 +
  <Range>S</Range>
 +
</IntendedDates>
 +
 +
* From // O // Sailing schedule intended date range (from).
 +
Format: ccyyMMddHHmmss
 +
 +
* To // O // Sailing schedule intended date range (to).
 +
Format: ccyyMMddHHmmss
 +
 +
* Range // Sailing schedule intended date range.
 +
** S – Sailing Date, A – Arrival Date
 +
 +
==== Location ====
 +
 +
This node holds all the port/location information related to the movement of the cargo in a particular shipment.
 +
 +
<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>
 +
 +
* FunctionCode // M // Identifies the type of function performed in the given location/port, Fucntion code should be either POR or FND
 +
 +
Use Intermodal group to describe location and vessel information.
 +
POR // Place of Receipt
 +
FND // Final Destination
 +
 +
* LocationName // O //  Local Name of a port/location
 +
 +
===== LocationDetails =====
 +
 +
This node holds all the information regarding the details of a certain location.
 +
 +
====== LocationCodes ======
 +
 +
This complex type describes codes of any location or port
 +
 +
* '''UNLocationCode''' // O
 +
** http://www.unece.org/cefact/locode/service/location.html
 +
 +
==== Intermodal ====
 +
 +
This node holds all the port/location and vessel voyage information related to the movement of the cargo in a particular shipment.
 +
 +
<pre>
 +
 +
<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>
 +
 +
</pre>
 +
 +
FunctionCode can be provided by below table:
 +
POL // Port of Load
 +
POD // Port of Discharge
 +
 +
=== EquipmentInformation ===
 +
 +
<pre>
 +
 +
<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>
 +
 +
</pre>
 +
 +
=== CargoInformation ===
 +
 +
This node used to hold commodity/cargo details and information of an specific shipment.
 +
 +
<pre>
 +
 +
<CargoInformation>
 +
  <CargoDetails>
 +
    <CargoNature>GC</CargoNature>
 +
    <TrafficMode>
 +
      <OutBound>FCL</OutBound>
 +
      <InBound>FCL</InBound>
 +
    </TrafficMode>
 +
  </CargoDetails>
 +
</CargoInformation>
 +
 +
</pre>
 +
 +
See [[CSmart#Cargo Nature Codes]]

Current revision as of 00:19, 11 November 2013


Contents

[edit] 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>

[edit] General Info


<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>

[edit] 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
  • MessageSender // AN // 1/15 // M // Trading partner ID for incoming, “CARGOSMART” for outgoing
  • MessageRecipient // AN // 1/15 // M // Trading partner ID for outgoing, “CARGOSMART” for incoming
  • MessageID // AN // 1/15 // M // Type of message, default to BRXML
  • DateCreated // N // 0/14 // O // Date the file was created. Format: ccyyMMddHHmmss
  • FileName // AN // 0/60 // O // File Name
  • Version // AN // 1/7 // M // schema version used

[edit] ActionType

ActionType // AN // 1/3 // M // Indicates if new request, Update or Cancellation. Accepted values are NEW, UPD and CAN.

[edit] CSReferenceNumber

  • CSReferenceNumber // AN // 0/12 // O // Booking Number generated by CargoSmart
    • per Luis we do not need this

[edit] SCAC

[edit] Requested

  • By // AN // 0/8 // O // Person/company who makes the request
  • Date // AN // 1/14 // M // Date the request was made Format: ccYYMMDDHHmmSS
    • attribute: Timezone // AN // 0/30 // O // Time Zone where the date it describes happened.

[edit] ShipmentDetails

<UserReferences>
...
</UserReferences>
<LegalParties>
...
</LegalParties>
<RouteInformation>
...
</RouteInformation>
<EquipmentInformation>
...
<EquipmentInformation>
<CargoInformation>
...
</CargoInformation>

[edit] UserReferences

 <UserReferences>
  <References>
   <ReferenceType>CR</ReferenceType>    
   <ReferenceNumber>M987645</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.
    • Use "CR"

[edit] LegalParties

This node holds the legal parties associated to that shipment. Parties included are the shipper, consignee, forwarder, notify and also notify.


 <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>

Map: see EDI 300#Parties

NOTE:
Per Luis even though Address=Optional in schema pdf 
we should send address.

[edit] RouteInformation

This node holds the route information of a particular shipment including the related intermodal and port locations.

[edit] IntendedDates

Intended sailing schedule.

<IntendedDates>
  <From TimeZone="LOCAL">20051002000000</From> 
  <To TimeZone="LOCAL">20051030000000</To> 
  <Range>S</Range>
</IntendedDates>
  • From // O // Sailing schedule intended date range (from).

Format: ccyyMMddHHmmss

  • To // O // Sailing schedule intended date range (to).

Format: ccyyMMddHHmmss

  • Range // Sailing schedule intended date range.
    • S – Sailing Date, A – Arrival Date

[edit] Location

This node holds all the port/location information related to the movement of the cargo in a particular shipment.

<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>
  • FunctionCode // M // Identifies the type of function performed in the given location/port, Fucntion code should be either POR or FND
Use Intermodal group to describe location and vessel information.
POR // Place of Receipt 
FND // Final Destination
  • LocationName // O // Local Name of a port/location
[edit] LocationDetails

This node holds all the information regarding the details of a certain location.

[edit] LocationCodes

This complex type describes codes of any location or port

[edit] Intermodal

This node holds all the port/location and vessel voyage information related to the movement of the cargo in a particular shipment.


 <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>

FunctionCode can be provided by below table: 
POL // Port of Load
POD // Port of Discharge

[edit] EquipmentInformation

 
 <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>

[edit] CargoInformation

This node used to hold commodity/cargo details and information of an specific shipment.


 <CargoInformation>
   <CargoDetails>
     <CargoNature>GC</CargoNature>
     <TrafficMode>
       <OutBound>FCL</OutBound>
       <InBound>FCL</InBound>
     </TrafficMode>
   </CargoDetails>
 </CargoInformation>

See CSmart#Cargo Nature Codes

Personal tools