POST api/Renewals

Queries the database for the Boat Renewal Details and the Customer Details based on the account code supplied and returns them

Request Information

URI Parameters

None.

Body Parameters

Boat number binding model, sent as a model so it can be subject to modelstate checks

BoatNoModel
NameDescriptionTypeAdditional information
boatNo

boat number

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "boatNo": 1
}

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="boatNo"

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

RenewalDetailsBindingModel
NameDescriptionTypeAdditional information
email

As name suggests

 string

None.
telephone

As name suggests

 string

None.
mobile

As name suggests

 string

None.
title

As name suggests

 string

None.
forename

As name suggests

 string

None.
surname

As name suggests

 string

None.
manufacturer

As name suggests

 string

None.
manufacturerID

As name suggests

 integer

None.
model

As name suggests

 string

None.
modelID

As name suggests

 integer

None.
beam

As name suggests

 decimal number

None.
draft

As name suggests

 decimal number

None.
loa

Boat length overall

 decimal number

None.
boatName

As name suggests

 string

None.
type

As name suggests

 string

None.
typeID

As name suggests

 integer

None.
tonnage

Boat tonnage - grt

 decimal number

None.
boatNo

Boat number

 integer

None.
insuranceCompany

As name suggests

 string

None.
insurancePolicyName

As name suggests

 string

None.
insuranceExpiryDate

As name suggests

 string

None.
contractId

Unique contract id number

 integer

None.
contractPaid

Flag to see if contract has already been paid

 boolean

None.
contractTotal

As name suggests

 decimal number

None.
marinaCode

As name suggests

 string

None.
marinaName

As name suggests

 string

None.
startDate

As name suggests

 string

None.
endDate

As name suggests

 string

None.
discountApplied

As name suggests.

 boolean

None.
discountPercentage

As name suggests

 decimal number

None.
discountValue

As name suggests

 decimal number

None.
preDiscountTotal

As name suggests

 decimal number

None.
depositAmount

The deposit value for this contract. May be 0.

 decimal number

None.
depositAmountPaid

How much has been paid towards the deposit.

 decimal number

None.
payByInstalments

Indicates whether the contract is paid by instalments rather than a lump sum.

 boolean

None.
instalmentValue

Instalment value if paid by instalments, null otherwise.

 decimal number

None.
totalDue

The total contract value less the deposit value.

 decimal number

None.
contractGroupId

The contract group ID for the contract, or for the charging rate if the contract has no specific group set.

 integer

None.
contractGroupDescription

The description of the contract group the contract falls under.

 string

None.
contractLoyaltyDiscountPercentage

Loyalty discount percentage

 decimal number

None.
contractLoyaltyDiscountValue

Loyalty discount value

 decimal number

None.
paymentDate

Date contract paid online

 string

None.
adjustment

Value of manual adjustment made to contract

 decimal number

None.
adjustmentApplied

Indicates if an adjustment has already been applied to the contract

 boolean

None.
totalModified

Indicates if either a discount or an adjustment has already been applied to the contract

 boolean

None.
newContract

Indicates that this is a completely new contract, not a renewal.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "email": "example@email.com",
  "telephone": "01234567890",
  "mobile": "01234567890",
  "title": "Dr.",
  "forename": "J",
  "surname": "Doe",
  "manufacturer": "Smith's",
  "manufacturerID": 1,
  "model": "The Smith's Skiff",
  "modelID": 1,
  "beam": 3.0,
  "draft": 1.1,
  "loa": 12.5,
  "boatName": "Swift Skiff",
  "type": "Motor Launch",
  "typeID": 2,
  "tonnage": 0.0,
  "boatNo": 0,
  "insuranceCompany": "Dodgy Dave's Diamond Deals",
  "insurancePolicyName": "Dodgy Dave's Fully Comp",
  "insuranceExpiryDate": "1/1/1999",
  "contractId": 0,
  "contractPaid": false,
  "contractTotal": 1050.49,
  "marinaCode": "PM",
  "marinaName": "PremMarina",
  "startDate": "1/1/1999",
  "endDate": "12/12/9999",
  "discountApplied": false,
  "discountPercentage": 3.0,
  "discountValue": 450.26,
  "preDiscountTotal": 1500.75,
  "depositAmount": 0.0,
  "depositAmountPaid": 0.0,
  "payByInstalments": false,
  "instalmentValue": null,
  "totalDue": 105.49,
  "contractGroupId": 0,
  "contractGroupDescription": null,
  "contractLoyaltyDiscountPercentage": 0.0,
  "contractLoyaltyDiscountValue": 0.0,
  "paymentDate": null,
  "adjustment": 0.0,
  "adjustmentApplied": false,
  "totalModified": false,
  "newContract": true
}

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="email"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="telephone"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="mobile"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="title"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="forename"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="surname"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="manufacturer"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="manufacturerID"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="model"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="modelID"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="beam"

11.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="draft"

12.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="loa"

13.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="boatName"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="type"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="typeID"

16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tonnage"

17.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="boatNo"

18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="insuranceCompany"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="insurancePolicyName"

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="insuranceExpiryDate"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractId"

22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractPaid"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractTotal"

24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="marinaCode"

sample string 25
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="marinaName"

sample string 26
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="startDate"

sample string 27
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="endDate"

sample string 28
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="discountApplied"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="discountPercentage"

30
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="discountValue"

31
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="preDiscountTotal"

32
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="depositAmount"

33
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="depositAmountPaid"

34
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payByInstalments"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="instalmentValue"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="totalDue"

36
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractGroupId"

37
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractGroupDescription"

sample string 38
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractLoyaltyDiscountPercentage"

39
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractLoyaltyDiscountValue"

40
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="paymentDate"

sample string 41
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="adjustment"

42
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="adjustmentApplied"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="totalModified"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="newContract"

True
--MultipartDataMediaFormatterBoundary1q2w3e--