POST api/customer/Contracts

Returns contract information

Request Information

URI Parameters

None.

Body Parameters

ContractListRequestModel
NameDescriptionTypeAdditional information
MarinaCodes

Comma delimited list of marina codes to return prices for

 string

None.
ChargingRateCodes

Comma delimited list of cahrging rate codes to match contracts against

 string

None.
CurrentOrFuture

Indicates if current or future contracts should be returned

 string

None.
New

Indicates if new or existing contracts should be returned, if not supplied then all confirmed contracts returned

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "marinaCodes": "sample string 1",
  "chargingRateCodes": "sample string 2",
  "currentOrFuture": "sample string 3",
  "new": true
}

multipart/form-data

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

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

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ContractListModel
NameDescriptionTypeAdditional information
Contracts

List of charging rate prices for specified marinas

 Collection of ContractModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "contracts": [
    {
      "contractId": 1,
      "startDate": "sample string 2",
      "endDate": "sample string 3",
      "chargingRate": "sample string 4",
      "marinaCode": "sample string 5",
      "customerName": "sample string 6",
      "accountCode": "sample string 7",
      "boatName": "sample string 8",
      "boatNo": 9,
      "boatLOA": 10.0,
      "homeBerth": "sample string 11",
      "meterMACSPIN": "sample string 12"
    },
    {
      "contractId": 1,
      "startDate": "sample string 2",
      "endDate": "sample string 3",
      "chargingRate": "sample string 4",
      "marinaCode": "sample string 5",
      "customerName": "sample string 6",
      "accountCode": "sample string 7",
      "boatName": "sample string 8",
      "boatNo": 9,
      "boatLOA": 10.0,
      "homeBerth": "sample string 11",
      "meterMACSPIN": "sample string 12"
    }
  ]
}

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].ContractId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].StartDate"

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

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

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].CustomerName"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].AccountCode"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].BoatName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].BoatNo"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].BoatLOA"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].HomeBerth"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[0].MeterMACSPIN"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].ContractId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].StartDate"

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

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

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].CustomerName"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].AccountCode"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].BoatName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].BoatNo"

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

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].HomeBerth"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Contracts[1].MeterMACSPIN"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e--