POST api/Zone/PointStatus
Request Information
URI Parameters
None.
Body Parameters
PointStatusRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DispatchingSiteNum | integer |
None. |
|
| DevNum | integer |
None. |
|
| PointsToDisplay | string |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"DispatchingSiteNum": 1,
"DevNum": 1,
"PointsToDisplay": "sample string 1",
"SessionNum": 2,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 3",
"StagesURL": "sample string 4"
}
application/xml, text/xml
Sample:
<PointStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 4</StagesURL> <ApplicationCode>sample string 3</ApplicationCode> <SessionNum>2</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <DispatchingSiteNum>1</DispatchingSiteNum> <PointsToDisplay>sample string 1</PointsToDisplay> </PointStatusRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PointStatusQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of PointStatusResult |
None. |
|
| Success | boolean |
None. |
|
| UserErrorMessage | string |
None. |
|
| ErrorTypeNum | integer |
None. |
|
| SqlConnectionLost | boolean |
None. |
|
| ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ExcludeColumnList": [
"sample string 1",
"sample string 2"
],
"ResultSet": [
{
"AlarmSignalCode": "sample string 1",
"AreaDescription": "sample string 2",
"AreaNum": 1,
"Comment": "sample string 3",
"DevNum": 1,
"EventCode": "sample string 4",
"EventCodeDescription": "sample string 5",
"OffNormalFlag": true,
"Point": "sample string 6",
"PointDescription": "sample string 7",
"PointInt": 1,
"PointStatus": "sample string 8",
"PointStatusDate": "2025-12-14T16:14:30.1939673-05:00",
"PointsToDisplay": "sample string 9",
"ReportsRestoreFlag": true,
"SignalCodeDescription": "sample string 10",
"StyleCode": "sample string 11",
"Title": "sample string 12",
"TransmitterCode": "sample string 13",
"TripCount": 1
},
{
"AlarmSignalCode": "sample string 1",
"AreaDescription": "sample string 2",
"AreaNum": 1,
"Comment": "sample string 3",
"DevNum": 1,
"EventCode": "sample string 4",
"EventCodeDescription": "sample string 5",
"OffNormalFlag": true,
"Point": "sample string 6",
"PointDescription": "sample string 7",
"PointInt": 1,
"PointStatus": "sample string 8",
"PointStatusDate": "2025-12-14T16:14:30.1939673-05:00",
"PointsToDisplay": "sample string 9",
"ReportsRestoreFlag": true,
"SignalCodeDescription": "sample string 10",
"StyleCode": "sample string 11",
"Title": "sample string 12",
"TransmitterCode": "sample string 13",
"TripCount": 1
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<PointStatusQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
<ClientVersion>sample string 5</ClientVersion>
<ErrorTypeNum>3</ErrorTypeNum>
<SqlConnectionLost>true</SqlConnectionLost>
<Success>true</Success>
<UserErrorMessage>sample string 2</UserErrorMessage>
<ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ExcludeColumnList>
<ResultSet>
<PointStatusResult>
<AlarmSignalCode>sample string 1</AlarmSignalCode>
<AreaDescription>sample string 2</AreaDescription>
<AreaNum>1</AreaNum>
<Comment>sample string 3</Comment>
<DevNum>1</DevNum>
<EventCode>sample string 4</EventCode>
<EventCodeDescription>sample string 5</EventCodeDescription>
<OffNormalFlag>true</OffNormalFlag>
<Point>sample string 6</Point>
<PointDescription>sample string 7</PointDescription>
<PointInt>1</PointInt>
<PointStatus>sample string 8</PointStatus>
<PointStatusDate>2025-12-14T16:14:30.1939673-05:00</PointStatusDate>
<PointsToDisplay>sample string 9</PointsToDisplay>
<ReportsRestoreFlag>true</ReportsRestoreFlag>
<SignalCodeDescription>sample string 10</SignalCodeDescription>
<StyleCode>sample string 11</StyleCode>
<Title>sample string 12</Title>
<TransmitterCode>sample string 13</TransmitterCode>
<TripCount>1</TripCount>
</PointStatusResult>
<PointStatusResult>
<AlarmSignalCode>sample string 1</AlarmSignalCode>
<AreaDescription>sample string 2</AreaDescription>
<AreaNum>1</AreaNum>
<Comment>sample string 3</Comment>
<DevNum>1</DevNum>
<EventCode>sample string 4</EventCode>
<EventCodeDescription>sample string 5</EventCodeDescription>
<OffNormalFlag>true</OffNormalFlag>
<Point>sample string 6</Point>
<PointDescription>sample string 7</PointDescription>
<PointInt>1</PointInt>
<PointStatus>sample string 8</PointStatus>
<PointStatusDate>2025-12-14T16:14:30.1939673-05:00</PointStatusDate>
<PointsToDisplay>sample string 9</PointsToDisplay>
<ReportsRestoreFlag>true</ReportsRestoreFlag>
<SignalCodeDescription>sample string 10</SignalCodeDescription>
<StyleCode>sample string 11</StyleCode>
<Title>sample string 12</Title>
<TransmitterCode>sample string 13</TransmitterCode>
<TripCount>1</TripCount>
</PointStatusResult>
</ResultSet>
</PointStatusQueryResult>