POST api/Agency/AgencyFullSearch
Request Information
URI Parameters
None.
Body Parameters
AgencyFullSearchRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AgencyNum | integer |
None. |
|
| AgencyType | string |
None. |
|
| AgencyName | string |
None. |
|
| Instructions | string |
None. |
|
| State | string |
None. |
|
| Address | string |
None. |
|
| Phone | string |
None. |
|
| City | string |
None. |
|
| ZipCode | string |
None. |
|
| StreetName | string |
None. |
|
| CentralStationLicense | string |
None. |
|
| AgencyId | string |
None. |
|
| ASAPID | string |
None. |
|
| County | 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,
"AgencyType": "sample string 1",
"AgencyName": "sample string 2",
"Instructions": "sample string 3",
"State": "sample string 4",
"Address": "sample string 5",
"Phone": "sample string 6",
"City": "sample string 7",
"ZipCode": "sample string 8",
"StreetName": "sample string 9",
"CentralStationLicense": "sample string 10",
"AgencyId": "sample string 11",
"ASAPID": "sample string 12",
"County": "sample string 13",
"SiteNum": 1,
"SessionNum": 14,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 15",
"StagesURL": "sample string 16"
}
application/xml, text/xml
Sample:
<AgencyFullSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 16</StagesURL> <ApplicationCode>sample string 15</ApplicationCode> <SessionNum>14</SessionNum> <SessionPassword>QEA=</SessionPassword> <ASAPID>sample string 12</ASAPID> <Address>sample string 5</Address> <AgencyId>sample string 11</AgencyId> <AgencyName>sample string 2</AgencyName> <AgencyNum>1</AgencyNum> <AgencyType>sample string 1</AgencyType> <CentralStationLicense>sample string 10</CentralStationLicense> <City>sample string 7</City> <County>sample string 13</County> <Instructions>sample string 3</Instructions> <Phone>sample string 6</Phone> <SiteNum>1</SiteNum> <State>sample string 4</State> <StreetName>sample string 9</StreetName> <ZipCode>sample string 8</ZipCode> </AgencyFullSearchRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AgencySearchQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of AgencySearchResult |
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": [
{
"ACKFlag": true,
"Address": "sample string 1",
"AgencyID": "sample string 2",
"AgencyName": "sample string 3",
"AgencyNum": 1,
"AgencyType": "sample string 4",
"AgencyTypeDescription": "sample string 5",
"AgInstructionsXml": {
"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"
}
]
}
]
},
"ASAPID": "sample string 6",
"ASAPIDDescription": "sample string 7",
"CentralStationLicense": "sample string 8",
"City": "sample string 9",
"DialAgencyFlag": true,
"HighlightFlag": true,
"Instructions": "sample string 10",
"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,
"Phone": "sample string 11",
"SiteNum": 1,
"State": "sample string 12",
"StreetName": "sample string 13",
"ZipCode": "sample string 14"
},
{
"ACKFlag": true,
"Address": "sample string 1",
"AgencyID": "sample string 2",
"AgencyName": "sample string 3",
"AgencyNum": 1,
"AgencyType": "sample string 4",
"AgencyTypeDescription": "sample string 5",
"AgInstructionsXml": {
"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"
}
]
}
]
},
"ASAPID": "sample string 6",
"ASAPIDDescription": "sample string 7",
"CentralStationLicense": "sample string 8",
"City": "sample string 9",
"DialAgencyFlag": true,
"HighlightFlag": true,
"Instructions": "sample string 10",
"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,
"Phone": "sample string 11",
"SiteNum": 1,
"State": "sample string 12",
"StreetName": "sample string 13",
"ZipCode": "sample string 14"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<AgencySearchQueryResult 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>
<AgencySearchResult>
<ACKFlag>true</ACKFlag>
<ASAPID>sample string 6</ASAPID>
<ASAPIDDescription>sample string 7</ASAPIDDescription>
<Address>sample string 1</Address>
<AgInstructionsXml>
<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>
</AgInstructionsXml>
<AgencyID>sample string 2</AgencyID>
<AgencyName>sample string 3</AgencyName>
<AgencyNum>1</AgencyNum>
<AgencyType>sample string 4</AgencyType>
<AgencyTypeDescription>sample string 5</AgencyTypeDescription>
<CentralStationLicense>sample string 8</CentralStationLicense>
<City>sample string 9</City>
<DialAgencyFlag>true</DialAgencyFlag>
<HighlightFlag>true</HighlightFlag>
<Instructions>sample string 10</Instructions>
<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 11</Phone>
<SiteNum>1</SiteNum>
<State>sample string 12</State>
<StreetName>sample string 13</StreetName>
<ZipCode>sample string 14</ZipCode>
</AgencySearchResult>
<AgencySearchResult>
<ACKFlag>true</ACKFlag>
<ASAPID>sample string 6</ASAPID>
<ASAPIDDescription>sample string 7</ASAPIDDescription>
<Address>sample string 1</Address>
<AgInstructionsXml>
<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>
</AgInstructionsXml>
<AgencyID>sample string 2</AgencyID>
<AgencyName>sample string 3</AgencyName>
<AgencyNum>1</AgencyNum>
<AgencyType>sample string 4</AgencyType>
<AgencyTypeDescription>sample string 5</AgencyTypeDescription>
<CentralStationLicense>sample string 8</CentralStationLicense>
<City>sample string 9</City>
<DialAgencyFlag>true</DialAgencyFlag>
<HighlightFlag>true</HighlightFlag>
<Instructions>sample string 10</Instructions>
<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 11</Phone>
<SiteNum>1</SiteNum>
<State>sample string 12</State>
<StreetName>sample string 13</StreetName>
<ZipCode>sample string 14</ZipCode>
</AgencySearchResult>
</ResultSet>
</AgencySearchQueryResult>