POST api/customer/ContractRenewalOptions

Returns contract renewal options for the given boat

Request Information

URI Parameters

None.

Body Parameters

ContractRenewalOptionsRequestModel
NameDescriptionTypeAdditional information
MaxPointsToUse

If set, the returned maximum redeemable point counts/values will be limited by this.

 integer

None.
accountCode

Fixed length account code

 string

Required

Max length: 10
marinaCode

Optional marina code

 string

Max length: 10
boatNo

Optional boat number

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "MaxPointsToUse": null,
  "accountCode": "HSMM1113",
  "marinaCode": "HSM",
  "boatNo": 65535
}

multipart/form-data

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

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

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

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

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ContractRenewalOptionsListModel
NameDescriptionTypeAdditional information
ContractId

Unique ID of renewal contract

 integer

None.
CustomerHasActiveDD

Indicates if the customer has a current Direct Debit which can be used

 boolean

None.
ContractGroup

Description of group the contract falls into

 string

None.
BoatName

Name of boat contract linked to

 string

None.
MarinaName

Name of marina the contract is for

 string

None.
ValidForOnlineRenewal

Flag to indicate if the contract can be renewed online

 boolean

None.
DepositAmountPaid

How much has been paid towards the deposit.

 decimal number

None.
ContractRenewalOptionsList

List of contract renewal options

 Collection of ContractRenewalOptionsModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "contractId": 1,
  "customerHasActiveDD": true,
  "contractGroup": "sample string 3",
  "boatName": "sample string 4",
  "marinaName": "sample string 5",
  "validForOnlineRenewal": true,
  "depositAmountPaid": 7.0,
  "contractRenewalOptionsList": [
    {
      "contractType": "sample string 1",
      "contractTypeDescription": "sample string 2",
      "contractPackage": "sample string 3",
      "paymentOption": "sample string 4",
      "contractValueGross": 5.0,
      "contractMonthlyValueGross": 6.0,
      "directDebit": true,
      "maxRedeemablePointsCount": 8,
      "maxRedeemablePointsValue": 9.0
    },
    {
      "contractType": "sample string 1",
      "contractTypeDescription": "sample string 2",
      "contractPackage": "sample string 3",
      "paymentOption": "sample string 4",
      "contractValueGross": 5.0,
      "contractMonthlyValueGross": 6.0,
      "directDebit": true,
      "maxRedeemablePointsCount": 8,
      "maxRedeemablePointsValue": 9.0
    }
  ]
}

multipart/form-data

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

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

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

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

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

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

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

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].ContractType"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].ContractTypeDescription"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].ContractPackage"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].PaymentOption"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].ContractValueGross"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].ContractMonthlyValueGross"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].DirectDebit"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].MaxRedeemablePointsCount"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[0].MaxRedeemablePointsValue"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].ContractType"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].ContractTypeDescription"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].ContractPackage"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].PaymentOption"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].ContractValueGross"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].ContractMonthlyValueGross"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].DirectDebit"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].MaxRedeemablePointsCount"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalOptionsList[1].MaxRedeemablePointsValue"

9
--MultipartDataMediaFormatterBoundary1q2w3e--