POST api/Agency/ValidateAgency

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AgencyNum	integer	None.
AgencySearch	string	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:

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

application/xml, text/xml

Sample:

<AgencyFindRequest 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>
  <AgencyNum>1</AgencyNum>
  <AgencySearch>sample string 1</AgencySearch>
  <SiteNum>1</SiteNum>
</AgencyFindRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ValidateAgencyQueryResult

Name	Type	Additional information
OutputParameter	ValidateAgencyOutput	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OutputParameter": {
    "AgencyName": "sample string 1",
    "AgencyType": "sample string 2",
    "AgencyTypeDescription": "sample string 3",
    "InstructionsXML": {
      "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"
            }
          ]
        }
      ]
    },
    "PermitRequiredFlag": true,
    "AgencyID": "sample string 4",
    "Phone": "sample string 5",
    "SiteCrossStreetRequiredFlag": true
  },
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<ValidateAgencyQueryResult 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>
  <OutputParameter>
    <AgencyID>sample string 4</AgencyID>
    <AgencyName>sample string 1</AgencyName>
    <AgencyType>sample string 2</AgencyType>
    <AgencyTypeDescription>sample string 3</AgencyTypeDescription>
    <InstructionsXML>
      <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>
    </InstructionsXML>
    <PermitRequiredFlag>true</PermitRequiredFlag>
    <Phone>sample string 5</Phone>
    <SiteCrossStreetRequiredFlag>true</SiteCrossStreetRequiredFlag>
  </OutputParameter>
</ValidateAgencyQueryResult>