POST api/Site/SiteEffectiveActionPlans

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SiteNum	integer	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteNum": 1,
  "SessionNum": 1,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 2",
  "StagesURL": "sample string 3"
}

application/xml, text/xml

Sample:

<SiteNumRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 3</StagesURL>
  <ApplicationCode>sample string 2</ApplicationCode>
  <SessionNum>1</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <SiteNum>1</SiteNum>
</SiteNumRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SiteEffectiveActionPlansQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of SiteEffectiveActionPlansResult	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": [
    {
      "ActionPlanDescription": "sample string 1",
      "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"
              }
            ]
          }
        ]
      },
      "ActionPlanNum": 1,
      "ActionPlanType": "sample string 2",
      "ActionPlanVersionNum": 1,
      "ActPlanMatchBy": "sample string 3",
      "AgencyName": "sample string 4",
      "AgencyNum": 1,
      "Category": "sample string 5",
      "DispatchType": "sample string 6",
      "DispatchTypeDescription": "sample string 7",
      "EffectiveDate": "2025-05-03T23:37:34.9223852-07:00",
      "EventCode": "sample string 8",
      "EventCodeDescription": "sample string 9",
      "EventCodeWithDescr": "sample string 10",
      "ExpireDate": "2025-05-03T23:37:34.9223852-07:00",
      "Point": "sample string 11",
      "ServiceTypeDescription": "sample string 12",
      "ServType": "sample string 13",
      "SignalCode": "sample string 14",
      "SignalStatus": "sample string 15",
      "SiteNum": 1,
      "SiteType": "sample string 16",
      "TitleSiteName": "sample string 17",
      "TransmitterCode": "sample string 18",
      "VariationCondition": "sample string 19"
    },
    {
      "ActionPlanDescription": "sample string 1",
      "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"
              }
            ]
          }
        ]
      },
      "ActionPlanNum": 1,
      "ActionPlanType": "sample string 2",
      "ActionPlanVersionNum": 1,
      "ActPlanMatchBy": "sample string 3",
      "AgencyName": "sample string 4",
      "AgencyNum": 1,
      "Category": "sample string 5",
      "DispatchType": "sample string 6",
      "DispatchTypeDescription": "sample string 7",
      "EffectiveDate": "2025-05-03T23:37:34.9223852-07:00",
      "EventCode": "sample string 8",
      "EventCodeDescription": "sample string 9",
      "EventCodeWithDescr": "sample string 10",
      "ExpireDate": "2025-05-03T23:37:34.9223852-07:00",
      "Point": "sample string 11",
      "ServiceTypeDescription": "sample string 12",
      "ServType": "sample string 13",
      "SignalCode": "sample string 14",
      "SignalStatus": "sample string 15",
      "SiteNum": 1,
      "SiteType": "sample string 16",
      "TitleSiteName": "sample string 17",
      "TransmitterCode": "sample string 18",
      "VariationCondition": "sample string 19"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<SiteEffectiveActionPlansQueryResult 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>
    <SiteEffectiveActionPlansResult>
      <ActPlanMatchBy>sample string 3</ActPlanMatchBy>
      <ActionPlanDescription>sample string 1</ActionPlanDescription>
      <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>
      <ActionPlanType>sample string 2</ActionPlanType>
      <ActionPlanVersionNum>1</ActionPlanVersionNum>
      <AgencyName>sample string 4</AgencyName>
      <AgencyNum>1</AgencyNum>
      <Category>sample string 5</Category>
      <DispatchType>sample string 6</DispatchType>
      <DispatchTypeDescription>sample string 7</DispatchTypeDescription>
      <EffectiveDate>2025-05-03T23:37:34.9223852-07:00</EffectiveDate>
      <EventCode>sample string 8</EventCode>
      <EventCodeDescription>sample string 9</EventCodeDescription>
      <EventCodeWithDescr>sample string 10</EventCodeWithDescr>
      <ExpireDate>2025-05-03T23:37:34.9223852-07:00</ExpireDate>
      <Point>sample string 11</Point>
      <ServType>sample string 13</ServType>
      <ServiceTypeDescription>sample string 12</ServiceTypeDescription>
      <SignalCode>sample string 14</SignalCode>
      <SignalStatus>sample string 15</SignalStatus>
      <SiteNum>1</SiteNum>
      <SiteType>sample string 16</SiteType>
      <TitleSiteName>sample string 17</TitleSiteName>
      <TransmitterCode>sample string 18</TransmitterCode>
      <VariationCondition>sample string 19</VariationCondition>
    </SiteEffectiveActionPlansResult>
    <SiteEffectiveActionPlansResult>
      <ActPlanMatchBy>sample string 3</ActPlanMatchBy>
      <ActionPlanDescription>sample string 1</ActionPlanDescription>
      <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>
      <ActionPlanType>sample string 2</ActionPlanType>
      <ActionPlanVersionNum>1</ActionPlanVersionNum>
      <AgencyName>sample string 4</AgencyName>
      <AgencyNum>1</AgencyNum>
      <Category>sample string 5</Category>
      <DispatchType>sample string 6</DispatchType>
      <DispatchTypeDescription>sample string 7</DispatchTypeDescription>
      <EffectiveDate>2025-05-03T23:37:34.9223852-07:00</EffectiveDate>
      <EventCode>sample string 8</EventCode>
      <EventCodeDescription>sample string 9</EventCodeDescription>
      <EventCodeWithDescr>sample string 10</EventCodeWithDescr>
      <ExpireDate>2025-05-03T23:37:34.9223852-07:00</ExpireDate>
      <Point>sample string 11</Point>
      <ServType>sample string 13</ServType>
      <ServiceTypeDescription>sample string 12</ServiceTypeDescription>
      <SignalCode>sample string 14</SignalCode>
      <SignalStatus>sample string 15</SignalStatus>
      <SiteNum>1</SiteNum>
      <SiteType>sample string 16</SiteType>
      <TitleSiteName>sample string 17</TitleSiteName>
      <TransmitterCode>sample string 18</TransmitterCode>
      <VariationCondition>sample string 19</VariationCondition>
    </SiteEffectiveActionPlansResult>
  </ResultSet>
</SiteEffectiveActionPlansQueryResult>