POST api/Area/AreaUpdate
Request Information
URI Parameters
None.
Body Parameters
AreaDetailRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AlternateTransmitterCode | string |
None. |
|
| AreaDescription | string |
None. |
|
| CloseEventCode | string |
None. |
|
| OpenEventCode | string |
None. |
|
| SchedNum | integer |
None. |
|
| SiteGroupNum | integer |
None. |
|
| SiteGroupSchedNum | integer |
None. |
|
| OldAreaNum | integer |
None. |
|
| AreaNum | integer |
None. |
|
| DevNum | integer |
None. |
|
| SiteFlag | boolean |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AlternateTransmitterCode": "sample string 1",
"AreaDescription": "sample string 2",
"CloseEventCode": "sample string 3",
"OpenEventCode": "sample string 4",
"SchedNum": 1,
"SiteGroupNum": 1,
"SiteGroupSchedNum": 1,
"OldAreaNum": 1,
"AreaNum": 1,
"DevNum": 1,
"SiteFlag": true,
"SessionNum": 5,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 6",
"StagesURL": "sample string 7"
}
application/xml, text/xml
Sample:
<AreaDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 7</StagesURL> <ApplicationCode>sample string 6</ApplicationCode> <SessionNum>5</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <SiteFlag>true</SiteFlag> <AreaNum>1</AreaNum> <AlternateTransmitterCode>sample string 1</AlternateTransmitterCode> <AreaDescription>sample string 2</AreaDescription> <CloseEventCode>sample string 3</CloseEventCode> <OldAreaNum>1</OldAreaNum> <OpenEventCode>sample string 4</OpenEventCode> <SchedNum>1</SchedNum> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSchedNum>1</SiteGroupSchedNum> </AreaDetailRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AreaUpdateQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of AreaUpdateResult |
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": [
{
"AdditionalDataFlag": true,
"AlternateTransmitterCode": "sample string 1",
"AreaDescription": "sample string 2",
"AreaNum": 1,
"CloseEventCode": "sample string 3",
"CloseEventDescription": "sample string 4",
"DevNum": 1,
"OpenEventCode": "sample string 5",
"OpenEventDescription": "sample string 6",
"SchedNum": 1,
"SiteGroupNum": 1,
"SiteGroupSchedDescription": "sample string 7",
"SiteGroupSchedNum": 1,
"TransmitterCode": "sample string 8",
"AdditionalData2Flag": true,
"AdditionalData3Flag": true
},
{
"AdditionalDataFlag": true,
"AlternateTransmitterCode": "sample string 1",
"AreaDescription": "sample string 2",
"AreaNum": 1,
"CloseEventCode": "sample string 3",
"CloseEventDescription": "sample string 4",
"DevNum": 1,
"OpenEventCode": "sample string 5",
"OpenEventDescription": "sample string 6",
"SchedNum": 1,
"SiteGroupNum": 1,
"SiteGroupSchedDescription": "sample string 7",
"SiteGroupSchedNum": 1,
"TransmitterCode": "sample string 8",
"AdditionalData2Flag": true,
"AdditionalData3Flag": true
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<AreaUpdateQueryResult 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>
<AreaUpdateResult>
<AdditionalData2Flag>true</AdditionalData2Flag>
<AdditionalData3Flag>true</AdditionalData3Flag>
<AdditionalDataFlag>true</AdditionalDataFlag>
<AlternateTransmitterCode>sample string 1</AlternateTransmitterCode>
<AreaDescription>sample string 2</AreaDescription>
<AreaNum>1</AreaNum>
<CloseEventCode>sample string 3</CloseEventCode>
<CloseEventDescription>sample string 4</CloseEventDescription>
<DevNum>1</DevNum>
<OpenEventCode>sample string 5</OpenEventCode>
<OpenEventDescription>sample string 6</OpenEventDescription>
<SchedNum>1</SchedNum>
<SiteGroupNum>1</SiteGroupNum>
<SiteGroupSchedDescription>sample string 7</SiteGroupSchedDescription>
<SiteGroupSchedNum>1</SiteGroupSchedNum>
<TransmitterCode>sample string 8</TransmitterCode>
</AreaUpdateResult>
<AreaUpdateResult>
<AdditionalData2Flag>true</AdditionalData2Flag>
<AdditionalData3Flag>true</AdditionalData3Flag>
<AdditionalDataFlag>true</AdditionalDataFlag>
<AlternateTransmitterCode>sample string 1</AlternateTransmitterCode>
<AreaDescription>sample string 2</AreaDescription>
<AreaNum>1</AreaNum>
<CloseEventCode>sample string 3</CloseEventCode>
<CloseEventDescription>sample string 4</CloseEventDescription>
<DevNum>1</DevNum>
<OpenEventCode>sample string 5</OpenEventCode>
<OpenEventDescription>sample string 6</OpenEventDescription>
<SchedNum>1</SchedNum>
<SiteGroupNum>1</SiteGroupNum>
<SiteGroupSchedDescription>sample string 7</SiteGroupSchedDescription>
<SiteGroupSchedNum>1</SiteGroupSchedNum>
<TransmitterCode>sample string 8</TransmitterCode>
</AreaUpdateResult>
</ResultSet>
</AreaUpdateQueryResult>