POST api/Agency/AgencyAutoComplete
Request Information
URI Parameters
None.
Body Parameters
AgencyFindRequest| Name | Description | 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
AgencyAutoCompleteQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of AgencyAutoCompleteResult |
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": [
{
"AgencySearch": "sample string 1",
"AgencyName": "sample string 2",
"AgencyID": "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"
}
]
}
]
},
"AgencyType": "sample string 4",
"AgencyTypeDescription": "sample string 5",
"PermitRequiredFlag": true,
"Phone": "sample string 6",
"SiteCrossStreetRequiredFlag": true
},
{
"AgencySearch": "sample string 1",
"AgencyName": "sample string 2",
"AgencyID": "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"
}
]
}
]
},
"AgencyType": "sample string 4",
"AgencyTypeDescription": "sample string 5",
"PermitRequiredFlag": true,
"Phone": "sample string 6",
"SiteCrossStreetRequiredFlag": true
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<AgencyAutoCompleteQueryResult 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>
<AgencyAutoCompleteResult>
<AgencyID>sample string 3</AgencyID>
<AgencyName>sample string 2</AgencyName>
<AgencySearch>sample string 1</AgencySearch>
<AgencyType>sample string 4</AgencyType>
<AgencyTypeDescription>sample string 5</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 6</Phone>
<SiteCrossStreetRequiredFlag>true</SiteCrossStreetRequiredFlag>
</AgencyAutoCompleteResult>
<AgencyAutoCompleteResult>
<AgencyID>sample string 3</AgencyID>
<AgencyName>sample string 2</AgencyName>
<AgencySearch>sample string 1</AgencySearch>
<AgencyType>sample string 4</AgencyType>
<AgencyTypeDescription>sample string 5</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 6</Phone>
<SiteCrossStreetRequiredFlag>true</SiteCrossStreetRequiredFlag>
</AgencyAutoCompleteResult>
</ResultSet>
</AgencyAutoCompleteQueryResult>