POST api/MeterMACSGen2/SocketInfo
Returns socket info for specified point
Request Information
URI Parameters
None.
Body Parameters
MMG2PointRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PointCode |
Code of point |
string |
None. |
| MarinaCode |
Code of marina where to turn on the point |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"pointCode": "sample string 1",
"marinaCode": "sample string 2"
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PointCode" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MarinaCode" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
MMG2SocketInfoModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MMLocationName |
MMG2 Location Name |
string |
None. |
| MMLocationId |
MMG2 Location ID |
integer |
None. |
| ParentMMLocationId |
Parent MMG2 Location ID |
integer |
None. |
| SocketStatusId |
MMG2 Socket Status ID |
integer |
None. |
| ErrorMessage |
Current error message for point |
string |
None. |
| AssignedBoatName |
Name of boat assigned to point |
string |
None. |
| AssignedBoatBalance |
MMG2 Balance of boat assigned to point |
decimal number |
None. |
| GatewayMMLocationId |
MMG2 Location ID of the gateway for the socket |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"mmLocationName": "sample string 1",
"mmLocationId": 2,
"parentMMLocationId": 3,
"socketStatusId": 4,
"errorMessage": "sample string 5",
"assignedBoatName": "sample string 6",
"assignedBoatBalance": 7.0,
"gatewayMMLocationId": 8
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MMLocationName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MMLocationId" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ParentMMLocationId" 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SocketStatusId" 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ErrorMessage" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AssignedBoatName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AssignedBoatBalance" 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GatewayMMLocationId" 8 --MultipartDataMediaFormatterBoundary1q2w3e--