POST api/book

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Origin	integer	Required
Destination	integer	Required
Sender	DNGBookCreateSenderDTO	Required
Recipient	DNGBookCreateRecipientDTO	Required
Summary	DNGBookCreateSummaryDTO	Required
IsPickUp	boolean	Required
PickUp	DNGBookCreatePickUpLocationDTO	None.
IsDeliveryAtHome	boolean	Required
Delivery	DNGBookCreateDeliveryDTO	None.
Items	Collection of DNGBookItemsDTO	Required

Request Formats

application/json, text/json

Sample:

{
  "Origin": 1,
  "Destination": 2,
  "Sender": {
    "Sender": "sample string 1",
    "SenderLastname": "sample string 2",
    "SenderEmail": "sample string 3",
    "SenderContactNo": "sample string 4"
  },
  "Recipient": {
    "Recipient": "sample string 1",
    "RecipientContactNo": "sample string 2"
  },
  "Summary": {
    "PaymentMethod": "sample string 1",
    "PickUpCharge": 2.0,
    "TotalAmountCharged": 3.0,
    "HandlingFee": 4.0,
    "DocStamp": 5.0
  },
  "IsPickUp": true,
  "PickUp": {
    "PickUpLocation": "sample string 1",
    "LocationRemarks": "sample string 2",
    "Lat": 3.1,
    "Lon": 4.1,
    "PickUpRateReference": "sample string 5",
    "VehicleId": 6,
    "PartnerId": 7,
    "TotalKm": 8.1
  },
  "IsDeliveryAtHome": true,
  "Delivery": {
    "DeliveryAddress": "sample string 1",
    "BrgyId": "sample string 2",
    "DeliveryCharge": 3.0,
    "DeliveryVehicleId": "sample string 4",
    "Lat": 5.1,
    "Lon": 6.1,
    "PartnerId": 7,
    "DeliveryRateReference": "sample string 8",
    "TotalKm": 9.1
  },
  "Items": [
    {
      "Description": "sample string 1",
      "Quantity": 2,
      "DeclaredValue": 3.0,
      "DeclaredValueCharge": 4.0,
      "Weight": 5.0,
      "WeightCharge": 6.0,
      "FreightCharge": 7.0,
      "BoxTypeId": "sample string 8",
      "CategoryId": 9,
      "SubCategoryId": 10,
      "SubCategoryOthers": "sample string 11",
      "Dimensions": "sample string 12",
      "DimensionCharge": 13.0,
      "DimensionWeight": 14.0
    },
    {
      "Description": "sample string 1",
      "Quantity": 2,
      "DeclaredValue": 3.0,
      "DeclaredValueCharge": 4.0,
      "Weight": 5.0,
      "WeightCharge": 6.0,
      "FreightCharge": 7.0,
      "BoxTypeId": "sample string 8",
      "CategoryId": 9,
      "SubCategoryId": 10,
      "SubCategoryOthers": "sample string 11",
      "Dimensions": "sample string 12",
      "DimensionCharge": 13.0,
      "DimensionWeight": 14.0
    }
  ]
}

application/xml, text/xml

Sample:

<DNGBookHeaderCreateDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shipping_API.Models.DTO">
  <Delivery>
    <BrgyId>sample string 2</BrgyId>
    <DeliveryAddress>sample string 1</DeliveryAddress>
    <DeliveryCharge>3</DeliveryCharge>
    <DeliveryRateReference>sample string 8</DeliveryRateReference>
    <DeliveryVehicleId>sample string 4</DeliveryVehicleId>
    <Lat>5.1</Lat>
    <Lon>6.1</Lon>
    <PartnerId>7</PartnerId>
    <TotalKm>9.1</TotalKm>
  </Delivery>
  <Destination>2</Destination>
  <IsDeliveryAtHome>true</IsDeliveryAtHome>
  <IsPickUp>true</IsPickUp>
  <Items>
    <DNGBookItemsDTO>
      <BoxTypeId>sample string 8</BoxTypeId>
      <CategoryId>9</CategoryId>
      <DeclaredValue>3</DeclaredValue>
      <DeclaredValueCharge>4</DeclaredValueCharge>
      <Description>sample string 1</Description>
      <DimensionCharge>13</DimensionCharge>
      <DimensionWeight>14</DimensionWeight>
      <Dimensions>sample string 12</Dimensions>
      <FreightCharge>7</FreightCharge>
      <Quantity>2</Quantity>
      <SubCategoryId>10</SubCategoryId>
      <SubCategoryOthers>sample string 11</SubCategoryOthers>
      <Weight>5</Weight>
      <WeightCharge>6</WeightCharge>
    </DNGBookItemsDTO>
    <DNGBookItemsDTO>
      <BoxTypeId>sample string 8</BoxTypeId>
      <CategoryId>9</CategoryId>
      <DeclaredValue>3</DeclaredValue>
      <DeclaredValueCharge>4</DeclaredValueCharge>
      <Description>sample string 1</Description>
      <DimensionCharge>13</DimensionCharge>
      <DimensionWeight>14</DimensionWeight>
      <Dimensions>sample string 12</Dimensions>
      <FreightCharge>7</FreightCharge>
      <Quantity>2</Quantity>
      <SubCategoryId>10</SubCategoryId>
      <SubCategoryOthers>sample string 11</SubCategoryOthers>
      <Weight>5</Weight>
      <WeightCharge>6</WeightCharge>
    </DNGBookItemsDTO>
  </Items>
  <Origin>1</Origin>
  <PickUp>
    <Lat>3.1</Lat>
    <LocationRemarks>sample string 2</LocationRemarks>
    <Lon>4.1</Lon>
    <PartnerId>7</PartnerId>
    <PickUpLocation>sample string 1</PickUpLocation>
    <PickUpRateReference>sample string 5</PickUpRateReference>
    <TotalKm>8.1</TotalKm>
    <VehicleId>6</VehicleId>
  </PickUp>
  <Recipient>
    <Recipient>sample string 1</Recipient>
    <RecipientContactNo>sample string 2</RecipientContactNo>
  </Recipient>
  <Sender>
    <Sender>sample string 1</Sender>
    <SenderContactNo>sample string 4</SenderContactNo>
    <SenderEmail>sample string 3</SenderEmail>
    <SenderLastname>sample string 2</SenderLastname>
  </Sender>
  <Summary>
    <DocStamp>5</DocStamp>
    <HandlingFee>4</HandlingFee>
    <PaymentMethod>sample string 1</PaymentMethod>
    <PickUpCharge>2</PickUpCharge>
    <TotalAmountCharged>3</TotalAmountCharged>
  </Summary>
</DNGBookHeaderCreateDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.