POST api/customer/CommsList

Returns Comms List

Request Information

URI Parameters

None.

Body Parameters

AccountCodeBindingModel
NameDescriptionTypeAdditional information
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:
{
  "accountCode": "HSMM1113",
  "marinaCode": null,
  "boatNo": null
}

multipart/form-data

Sample:
--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

CommsListBindingModel
NameDescriptionTypeAdditional information
commsList

binding model for list of Comms Details

Collection of CommsBindingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "commsList": [
    {
      "accountCode": "AJ56",
      "commsTypeId": 1,
      "contactCommsId": 6556,
      "commsValue": "012554554545",
      "internalUse": false,
      "ImportantInformation": false,
      "newsletter": false,
      "events": false,
      "offers": true,
      "thirdParty": false,
      "insurance": false
    }
  ]
}

multipart/form-data

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

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

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="commsList[0].contactCommsId"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="commsList[0].commsValue"

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

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

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

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

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

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

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

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

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

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="commsList[1].contactCommsId"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="commsList[1].commsValue"

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

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

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

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

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

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--