POST api/MeterMACSGen2/GetAlertInfo

Returns information alerts for given customer

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

MMG2AlertInfoModel
NameDescriptionTypeAdditional information
AccountCode

Code of account to update alert info for

 string

None.
BoatNo

ID of boat

 integer

None.
ReceiveUnpluggedAlerts

Indicates if unplugged alerts should be sent to customer

 boolean

None.
ReceiveLowBalanceAlerts

Indicates if low balance alerts should be sent to customer

 boolean

None.
ReceiveCriticalBalanceAlerts

Indicates if critical balance alerts should be sent to customer

 boolean

None.
ReceiveAlertsByEmail

Indicates if alerts should be sent by email

 boolean

None.
ReceiveAlertsBySMS

Indicates if alerts should be sent by SMS

 boolean

None.
LowBalanceThresholdValue

Low balance alerts sent when balance reaches this value

 decimal number

None.
LowBalanceThresholdPercentage

Low balance alerts sent when balance reaches the value calculated as a percentage of the most recent top up

 decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "accountCode": "sample string 1",
  "boatNo": 1,
  "receiveUnpluggedAlerts": true,
  "receiveLowBalanceAlerts": true,
  "receiveCriticalBalanceAlerts": true,
  "receiveAlertsByEmail": true,
  "receiveAlertsBySMS": true,
  "lowBalanceThresholdValue": 7.0,
  "lowBalanceThresholdPercentage": 8.0
}

multipart/form-data

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

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

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

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

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

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

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

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

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LowBalanceThresholdPercentage"

8
--MultipartDataMediaFormatterBoundary1q2w3e--