POST DealSheet/calculate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
entityId	globally unique identifier	None.
trimId	integer	None.
calculationType	integer	None.
stockNo	string	None.
token	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "entityId": "c19bf2d1-905d-41b6-b653-3657b457455a",
  "trimId": 2,
  "calculationType": 3,
  "stockNo": "sample string 4",
  "token": "6dcc49d0-5ffe-40aa-aeed-448ec32e90a0"
}

application/xml, text/xml

Sample:

<CalculateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.DealSheet">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">6dcc49d0-5ffe-40aa-aeed-448ec32e90a0</token>
  <calculationType>3</calculationType>
  <entityId>c19bf2d1-905d-41b6-b653-3657b457455a</entityId>
  <stockNo>sample string 4</stockNo>
  <trimId>2</trimId>
</CalculateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentsList

Name	Type	Additional information
code	integer	None.
error	string	None.
Price	integer	None.
Payments	Collection of Payment	None.
APIVersion	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Price": 1,
  "Payments": [
    {
      "SaleTypeID": 1,
      "TermID": 2,
      "Rate": 3.1,
      "Pmt": 4,
      "Diff": 5,
      "IsOverAllowance": true,
      "IsAlert": true,
      "IsFlexAlert": true
    },
    {
      "SaleTypeID": 1,
      "TermID": 2,
      "Rate": 3.1,
      "Pmt": 4,
      "Diff": 5,
      "IsOverAllowance": true,
      "IsAlert": true,
      "IsFlexAlert": true
    }
  ],
  "APIVersion": 2,
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:

<PaymentsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">2</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <Payments>
    <Payment>
      <Diff>5</Diff>
      <IsAlert>true</IsAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsOverAllowance>true</IsOverAllowance>
      <Pmt>4</Pmt>
      <Rate>3.1</Rate>
      <SaleTypeID>1</SaleTypeID>
      <TermID>2</TermID>
    </Payment>
    <Payment>
      <Diff>5</Diff>
      <IsAlert>true</IsAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsOverAllowance>true</IsOverAllowance>
      <Pmt>4</Pmt>
      <Rate>3.1</Rate>
      <SaleTypeID>1</SaleTypeID>
      <TermID>2</TermID>
    </Payment>
  </Payments>
  <Price>1</Price>
</PaymentsList>