POST api/Site/ActionPlanSearch
Request Information
URI Parameters
None.
Body Parameters
ActionPlanSearchRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchString | string |
None. |
|
| DevNum | integer |
None. |
|
| SiteGroupNum | integer |
None. |
|
| AlarmNum | integer |
None. |
|
| SiteNum | integer |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SearchString": "sample string 1",
"DevNum": 1,
"SiteGroupNum": 1,
"AlarmNum": 1,
"SiteNum": 1,
"SessionNum": 2,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 3",
"StagesURL": "sample string 4"
}
application/xml, text/xml
Sample:
<ActionPlanSearchRequest 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> <SiteNum>1</SiteNum> <AlarmNum>1</AlarmNum> <DevNum>1</DevNum> <SearchString>sample string 1</SearchString> <SiteGroupNum>1</SiteGroupNum> </ActionPlanSearchRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ActionPlanSearchQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of ActionPlanSearchResult |
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": [
{
"ActionPlanNum": 1,
"ActionPlanVersionNum": 1,
"ActPlanDescription": "sample string 1",
"ApplicationNum": 1,
"Category": "sample string 2",
"DevNum": 1,
"HighlightFlag": true,
"Instructions": "sample string 3",
"NotesXml": {
"SectionList": [
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
"Option": "sample string 4",
"SearchString": "sample string 5",
"SiteGroupNum": 1,
"SiteNum": 1,
"Title": "sample string 6",
"TitleSiteName": "sample string 7",
"ActionPlanNotesXml": {
"SectionList": [
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
"AlarmNum": 1,
"VariationNum": 1
},
{
"ActionPlanNum": 1,
"ActionPlanVersionNum": 1,
"ActPlanDescription": "sample string 1",
"ApplicationNum": 1,
"Category": "sample string 2",
"DevNum": 1,
"HighlightFlag": true,
"Instructions": "sample string 3",
"NotesXml": {
"SectionList": [
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
"Option": "sample string 4",
"SearchString": "sample string 5",
"SiteGroupNum": 1,
"SiteNum": 1,
"Title": "sample string 6",
"TitleSiteName": "sample string 7",
"ActionPlanNotesXml": {
"SectionList": [
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Value": "sample string 1",
"BrFlag": true,
"StyleList": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
"AlarmNum": 1,
"VariationNum": 1
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<ActionPlanSearchQueryResult 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>
<ActionPlanSearchResult>
<ActPlanDescription>sample string 1</ActPlanDescription>
<ActionPlanNotesXml>
<SectionList>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
</SectionList>
</ActionPlanNotesXml>
<ActionPlanNum>1</ActionPlanNum>
<ActionPlanVersionNum>1</ActionPlanVersionNum>
<AlarmNum>1</AlarmNum>
<ApplicationNum>1</ApplicationNum>
<Category>sample string 2</Category>
<DevNum>1</DevNum>
<HighlightFlag>true</HighlightFlag>
<Instructions>sample string 3</Instructions>
<NotesXml>
<SectionList>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
</SectionList>
</NotesXml>
<Option>sample string 4</Option>
<SearchString>sample string 5</SearchString>
<SiteGroupNum>1</SiteGroupNum>
<SiteNum>1</SiteNum>
<Title>sample string 6</Title>
<TitleSiteName>sample string 7</TitleSiteName>
<VariationNum>1</VariationNum>
</ActionPlanSearchResult>
<ActionPlanSearchResult>
<ActPlanDescription>sample string 1</ActPlanDescription>
<ActionPlanNotesXml>
<SectionList>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
</SectionList>
</ActionPlanNotesXml>
<ActionPlanNum>1</ActionPlanNum>
<ActionPlanVersionNum>1</ActionPlanVersionNum>
<AlarmNum>1</AlarmNum>
<ApplicationNum>1</ApplicationNum>
<Category>sample string 2</Category>
<DevNum>1</DevNum>
<HighlightFlag>true</HighlightFlag>
<Instructions>sample string 3</Instructions>
<NotesXml>
<SectionList>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
<Section>
<BrFlag>true</BrFlag>
<StyleList>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
<Style>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Style>
</StyleList>
<Value>sample string 1</Value>
</Section>
</SectionList>
</NotesXml>
<Option>sample string 4</Option>
<SearchString>sample string 5</SearchString>
<SiteGroupNum>1</SiteGroupNum>
<SiteNum>1</SiteNum>
<Title>sample string 6</Title>
<TitleSiteName>sample string 7</TitleSiteName>
<VariationNum>1</VariationNum>
</ActionPlanSearchResult>
</ResultSet>
</ActionPlanSearchQueryResult>