POST api/GreenShipments

POST Call to calculate the Carbon Emission Amount in Kgs for a given shipment

Request Information

URI Parameters

None.

Body Parameters

JSON Class with following values APIKey: Gets or sets the API key for Greenabl member authentication. MemberCode: Gets or sets the Greenabl member code associated with the shipment. CarrierSCAC:Gets or sets the Standard Carrier Alpha Code (SCAC) of the carrier. APLU, CMDU, COSU, EGLV, SUDU, HLCU, HDMU, MAEU, MATS, MEDU, MSCU, ONEY, OOLU, PABV, SEAU, SMLM, WHLC, YMLU, ZIMU ContainerNo: Gets or sets the container number for the shipment. ContainerSize: Gets or sets the size of the container. [20GP / 40GP / 40HC / 45G1 / 22R1 / 40REHC] Vessel: Gets or sets the vessel name for the shipment. VesselIMO: Gets or sets the International Maritime Organization (IMO) number of the vessel. If the user provides the name of the Vessel, the system will automatically find out the IMO of the vessel. OriginLocCode: Gets or sets the location code of the origin. LoadPortLocCode: Gets or sets the location code of the load port. TransshipPortLocCode: Gets or sets the location code of the transshipment port. DischargePortLocCode: Gets or sets the location code of the discharge port. InlandCYRampCode: Gets or sets the location code of the inland ramp. DestLocCode: Gets or sets the location code of the destination. OriginTranMode": Gets or sets the transportation mode from the origin port/location to Load port/Discharge port. LoadPortTranMode": Gets or sets the transportation mode from the load port to Discharge port/Transshipment port. TransshipmentPortTranMode": Gets or sets the transportation mode from the transshipment port to the Discharge Port. DischargePortTranMode": Gets or sets the transportation mode from the discharge port to inland ramp/final destination. InlandRampTranMode": Gets or sets the transportation mode from the inland ramp to final destination. LoadType: Gets or sets the type of load: FCL/LCL/DMST(for Domestic)/AIR. TotalWeight": Gets or sets the total weight of the shipment. Applicable only for LoadType LCL.

Request Formats

Binary JSON content. See http://bsonspec.org for details.

{
  "APIKey": "sample string 1",
  "MemberCode": 2,
  "CarrierSCAC": "sample string 3",
  "ContainerNo": "sample string 4",
  "ContainerSize": "sample string 5",
  "Vessel": "sample string 6",
  "VesselIMO": "sample string 7",
  "OriginLocCode": "sample string 8",
  "LoadPortLocCode": "sample string 9",
  "TransshipPortLocCode": "sample string 10",
  "DischargePortLocCode": "sample string 11",
  "InlandCYRampCode": "sample string 12",
  "DestLocCode": "sample string 13",
  "OriginTranMode": "sample string 14",
  "LoadPortTranMode": "sample string 15",
  "TransshipmentPortTranMode": "sample string 16",
  "DischargePortTranMode": "sample string 17",
  "InlandRampTranMode": "sample string 18",
  "LoadType": "sample string 19",
  "TotalWeight": 1.0
}

<GreenShipmentForAPI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeminiShippers.Common.RESTfulGreenable">
  <APIKey>sample string 1</APIKey>
  <CarrierSCAC>sample string 3</CarrierSCAC>
  <ContainerNo>sample string 4</ContainerNo>
  <ContainerSize>sample string 5</ContainerSize>
  <DestLocCode>sample string 13</DestLocCode>
  <DischargePortLocCode>sample string 11</DischargePortLocCode>
  <DischargePortTranMode>sample string 17</DischargePortTranMode>
  <InlandCYRampCode>sample string 12</InlandCYRampCode>
  <InlandRampTranMode>sample string 18</InlandRampTranMode>
  <LoadPortLocCode>sample string 9</LoadPortLocCode>
  <LoadPortTranMode>sample string 15</LoadPortTranMode>
  <LoadType>sample string 19</LoadType>
  <MemberCode>2</MemberCode>
  <OriginLocCode>sample string 8</OriginLocCode>
  <OriginTranMode>sample string 14</OriginTranMode>
  <TotalWeight>1</TotalWeight>
  <TransshipPortLocCode>sample string 10</TransshipPortLocCode>
  <TransshipmentPortTranMode>sample string 16</TransshipmentPortTranMode>
  <Vessel>sample string 6</Vessel>
  <VesselIMO>sample string 7</VesselIMO>
</GreenShipmentForAPI>

Response Information

Resource Description

return JSON class ReturnGreenShipment including CO2 in Kgs /// { "MemberCode": 1003, "CarrierSCAC": "ONEY", "ContainerNo": "MYTESTAPI1001", "ContainerSize": "40HC", "Vessel": "ONE COMPETENCE", "VesselIMO": "9339662", "OriginLocCode": "VNHPH", "LoadPortLocCode": "", "TransshipPortLocCode": "", "DischargePortLocCode": "USLAX", "InlandCYRampCode": "", "DestinationLocCode": "USCMH", "OriginToLoadPortTranMode": "sea", "LoadPortToTransPortTranMode": "", "TransPortToDischargePortTranMode": "", "DischargePortToInlandRampTranMode": "rail", "InlandRampToDestTranMode": "", "LoadType": "", "CO2EmissionInGrams": "3738.146", "Emission_Cacl_Basis": "Vessel IMO" }

None.

Response Formats

Binary JSON content. See http://bsonspec.org for details.