POST api/DispatchRoveRateCalculator/GetFinalRate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FromState	string	None.
FromCity	string	None.
FromPostal	string	None.
ToState	string	None.
ToCity	string	None.
ToPostal	string	None.
RCSecretKey	string	None.
Type	string	None.
CompanyIdHidden	integer	None.
BoxValues	Collection of BoxValues	None.

Request Formats

application/json, text/json

Sample:

{
  "FromState": "sample string 1",
  "FromCity": "sample string 2",
  "FromPostal": "sample string 3",
  "ToState": "sample string 4",
  "ToCity": "sample string 5",
  "ToPostal": "sample string 6",
  "RCSecretKey": "sample string 7",
  "Type": "sample string 8",
  "CompanyIdHidden": 9,
  "BoxValues": [
    {
      "Length": 1.1,
      "Width": 2.1,
      "Height": 3.1,
      "GrossWeightLBS": 4.1
    },
    {
      "Length": 1.1,
      "Width": 2.1,
      "Height": 3.1,
      "GrossWeightLBS": 4.1
    }
  ]
}

text/html

Sample:

{"FromState":"sample string 1","FromCity":"sample string 2","FromPostal":"sample string 3","ToState":"sample string 4","ToCity":"sample string 5","ToPostal":"sample string 6","RCSecretKey":"sample string 7","Type":"sample string 8","CompanyIdHidden":9,"BoxValues":[{"Length":1.1,"Width":2.1,"Height":3.1,"GrossWeightLBS":4.1},{"Length":1.1,"Width":2.1,"Height":3.1,"GrossWeightLBS":4.1}]}

application/xml, text/xml

Sample:

<RoveRateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dispatch.Models">
  <BoxValues>
    <BoxValues>
      <GrossWeightLBS>4.1</GrossWeightLBS>
      <Height>3.1</Height>
      <Length>1.1</Length>
      <Width>2.1</Width>
    </BoxValues>
    <BoxValues>
      <GrossWeightLBS>4.1</GrossWeightLBS>
      <Height>3.1</Height>
      <Length>1.1</Length>
      <Width>2.1</Width>
    </BoxValues>
  </BoxValues>
  <CompanyIdHidden>9</CompanyIdHidden>
  <FromCity>sample string 2</FromCity>
  <FromPostal>sample string 3</FromPostal>
  <FromState>sample string 1</FromState>
  <RCSecretKey>sample string 7</RCSecretKey>
  <ToCity>sample string 5</ToCity>
  <ToPostal>sample string 6</ToPostal>
  <ToState>sample string 4</ToState>
  <Type>sample string 8</Type>
</RoveRateModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RoveRateModel'.

Response Information

Resource Description

RoveRateResult

Name	Type	Additional information
Status	boolean	None.
Message	string	None.
FinalRate	string	None.
StatusCode	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "Message": "sample string 2",
  "FinalRate": "sample string 3",
  "StatusCode": 4
}

text/html

Sample:

{"Status":true,"Message":"sample string 2","FinalRate":"sample string 3","StatusCode":4}

application/xml, text/xml

Sample:

<RoveRateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dispatch.Models">
  <FinalRate>sample string 3</FinalRate>
  <Message>sample string 2</Message>
  <Status>true</Status>
  <StatusCode>4</StatusCode>
</RoveRateResult>