POST api/Consolidation/Save

Request Information

URI Parameters

None.

Body Parameters

SaveConsolidationInputModel
NameDescriptionTypeAdditional information
Direction_ID

integer

None.

TransportationMode_ID

integer

None.

Shipment_Count

integer

None.

Consolidation_ID

globally unique identifier

None.

Consolidation_NO

string

None.

ExecutedPlace

string

None.

Status_ID

integer

None.

MasterBill_NO

string

None.

Carrier_ID

integer

None.

Booking_NO

string

None.

VesselName

string

None.

Voyage

string

None.

OceanRoutingDetail_ID

integer

None.

ClientName

string

None.

POC_ID

integer

None.

DescriptionOfGoods

string

None.

LocationTypes

Collection of ConsolidationLocationTypeInputModel

None.

AWB_ID

integer

None.

BillToCompany_ID

integer

None.

BillToCarrier_ID

integer

None.

CustomFieldsWithValues

Collection of CustomFieldOutputModel

None.

Request Formats

application/json, text/json

Sample:
{
  "Direction_ID": 1,
  "TransportationMode_ID": 2,
  "Shipment_Count": 1,
  "Consolidation_ID": "59d12a65-e845-4705-ae66-eedb086fc0c8",
  "Consolidation_NO": "sample string 3",
  "ExecutedPlace": "sample string 4",
  "Status_ID": 5,
  "MasterBill_NO": "sample string 6",
  "Carrier_ID": 1,
  "Booking_NO": "sample string 7",
  "VesselName": "sample string 8",
  "Voyage": "sample string 9",
  "OceanRoutingDetail_ID": 1,
  "ClientName": "sample string 10",
  "POC_ID": 1,
  "DescriptionOfGoods": "sample string 11",
  "LocationTypes": [
    {
      "Location_ID": 1,
      "Company_ID": 1,
      "IFS_LocationType_ID": 1,
      "LocationType_ID": 2,
      "Site_ID": 1,
      "POC_ID": 1,
      "Tenant_ID": 3,
      "Branch_ID": 4
    },
    {
      "Location_ID": 1,
      "Company_ID": 1,
      "IFS_LocationType_ID": 1,
      "LocationType_ID": 2,
      "Site_ID": 1,
      "POC_ID": 1,
      "Tenant_ID": 3,
      "Branch_ID": 4
    }
  ],
  "AWB_ID": 1,
  "BillToCompany_ID": 1,
  "BillToCarrier_ID": 1,
  "CustomFieldsWithValues": [
    {
      "FormFieldId": 1,
      "FormFieldName": "sample string 2",
      "FormFieldDisplayName": "sample string 3",
      "FormFieldTypeId": 4,
      "FormFieldAttributeId": 1,
      "FormFieldAttributeValue": "sample string 5"
    },
    {
      "FormFieldId": 1,
      "FormFieldName": "sample string 2",
      "FormFieldDisplayName": "sample string 3",
      "FormFieldTypeId": 4,
      "FormFieldAttributeId": 1,
      "FormFieldAttributeValue": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<SaveConsolidationInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyzerg.Model.WMS.InputOutputModels">
  <AWB_ID>1</AWB_ID>
  <BillToCarrier_ID>1</BillToCarrier_ID>
  <BillToCompany_ID>1</BillToCompany_ID>
  <Booking_NO>sample string 7</Booking_NO>
  <Carrier_ID>1</Carrier_ID>
  <ClientName>sample string 10</ClientName>
  <Consolidation_ID>59d12a65-e845-4705-ae66-eedb086fc0c8</Consolidation_ID>
  <Consolidation_NO>sample string 3</Consolidation_NO>
  <CustomFieldsWithValues>
    <CustomFieldOutputModel>
      <FormFieldAttributeId>1</FormFieldAttributeId>
      <FormFieldAttributeValue>sample string 5</FormFieldAttributeValue>
      <FormFieldDisplayName>sample string 3</FormFieldDisplayName>
      <FormFieldId>1</FormFieldId>
      <FormFieldName>sample string 2</FormFieldName>
      <FormFieldTypeId>4</FormFieldTypeId>
    </CustomFieldOutputModel>
    <CustomFieldOutputModel>
      <FormFieldAttributeId>1</FormFieldAttributeId>
      <FormFieldAttributeValue>sample string 5</FormFieldAttributeValue>
      <FormFieldDisplayName>sample string 3</FormFieldDisplayName>
      <FormFieldId>1</FormFieldId>
      <FormFieldName>sample string 2</FormFieldName>
      <FormFieldTypeId>4</FormFieldTypeId>
    </CustomFieldOutputModel>
  </CustomFieldsWithValues>
  <DescriptionOfGoods>sample string 11</DescriptionOfGoods>
  <Direction_ID>1</Direction_ID>
  <ExecutedPlace>sample string 4</ExecutedPlace>
  <LocationTypes>
    <ConsolidationLocationTypeInputModel>
      <Branch_ID>4</Branch_ID>
      <Company_ID>1</Company_ID>
      <IFS_LocationType_ID>1</IFS_LocationType_ID>
      <LocationType_ID>2</LocationType_ID>
      <Location_ID>1</Location_ID>
      <POC_ID>1</POC_ID>
      <Site_ID>1</Site_ID>
      <Tenant_ID>3</Tenant_ID>
    </ConsolidationLocationTypeInputModel>
    <ConsolidationLocationTypeInputModel>
      <Branch_ID>4</Branch_ID>
      <Company_ID>1</Company_ID>
      <IFS_LocationType_ID>1</IFS_LocationType_ID>
      <LocationType_ID>2</LocationType_ID>
      <Location_ID>1</Location_ID>
      <POC_ID>1</POC_ID>
      <Site_ID>1</Site_ID>
      <Tenant_ID>3</Tenant_ID>
    </ConsolidationLocationTypeInputModel>
  </LocationTypes>
  <MasterBill_NO>sample string 6</MasterBill_NO>
  <OceanRoutingDetail_ID>1</OceanRoutingDetail_ID>
  <POC_ID>1</POC_ID>
  <Shipment_Count>1</Shipment_Count>
  <Status_ID>5</Status_ID>
  <TransportationMode_ID>2</TransportationMode_ID>
  <VesselName>sample string 8</VesselName>
  <Voyage>sample string 9</Voyage>
</SaveConsolidationInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"Direction_ID":1,"TransportationMode_ID":2,"Shipment_Count":1,"Consolidation_ID":"59d12a65-e845-4705-ae66-eedb086fc0c8","Consolidation_NO":"sample string 3","ExecutedPlace":"sample string 4","Status_ID":5,"MasterBill_NO":"sample string 6","Carrier_ID":1,"Booking_NO":"sample string 7","VesselName":"sample string 8","Voyage":"sample string 9","OceanRoutingDetail_ID":1,"ClientName":"sample string 10","POC_ID":1,"DescriptionOfGoods":"sample string 11","LocationTypes":[{"Location_ID":1,"Company_ID":1,"IFS_LocationType_ID":1,"LocationType_ID":2,"Site_ID":1,"POC_ID":1,"Tenant_ID":3,"Branch_ID":4},{"Location_ID":1,"Company_ID":1,"IFS_LocationType_ID":1,"LocationType_ID":2,"Site_ID":1,"POC_ID":1,"Tenant_ID":3,"Branch_ID":4}],"AWB_ID":1,"BillToCompany_ID":1,"BillToCarrier_ID":1,"CustomFieldsWithValues":[{"FormFieldId":1,"FormFieldName":"sample string 2","FormFieldDisplayName":"sample string 3","FormFieldTypeId":4,"FormFieldAttributeId":1,"FormFieldAttributeValue":"sample string 5"},{"FormFieldId":1,"FormFieldName":"sample string 2","FormFieldDisplayName":"sample string 3","FormFieldTypeId":4,"FormFieldAttributeId":1,"FormFieldAttributeValue":"sample string 5"}]}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, text/html

Sample:

Sample not available.