POST api/Agency/AgencyDetail
Request Information
URI Parameters
None.
Body Parameters
AgencyNumRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AgencyNum | 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,
"SessionNum": 1,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 2",
"StagesURL": "sample string 3"
}
application/xml, text/xml
Sample:
<AgencyNumRequest 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> <AgencyNum>1</AgencyNum> </AgencyNumRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AgencyDetailQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of AgencyDetailResult |
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": [
{
"AdditionalDataFlag": true,
"AgencyID": "sample string 1",
"AgencyInstDescription": "sample string 2",
"AgencyInstNum": 1,
"AgencyNum": 1,
"AgencyNumDisplay": 1,
"AgencyType": "sample string 3",
"AgencyTypeDescription": "sample string 4",
"ASAPActiveFlag": true,
"ASAPFlag": true,
"ASAPID": "sample string 5",
"ASAPIDDescription": "sample string 6",
"ASAPName": "sample string 7",
"CallbackPhone": "sample string 8",
"CentralStationLicense": "sample string 9",
"DispatchAgencySearch": "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"
}
]
}
]
},
"Name": "sample string 11",
"Name2": "sample string 12",
"PermitRequiredFlag": true,
"RestrictedUseFlag": true,
"SiteCrossStreetRequiredFlag": true,
"DispatchOpAct": "sample string 13",
"DispatchOpActDescription": "sample string 14",
"RapidSOSFlag": true,
"AgencyCode": "sample string 15",
"AgencyPermitComment": "sample string 16",
"BroadcastAndFileFlag": true,
"ECVOption": "sample string 17",
"FalseAlarmRestriction": "sample string 18",
"MultipleTripsRequirement": "sample string 19",
"OrdinanceURL": "sample string 20",
"PermitResponsible": "sample string 21",
"PermitURL": "sample string 22",
"PrivateResponseOnlyFlag": true,
"SIACP01PanelFlag": true,
"SpecialInstructions": "sample string 23",
"VerifiedResponse": "sample string 24"
},
{
"AdditionalDataFlag": true,
"AgencyID": "sample string 1",
"AgencyInstDescription": "sample string 2",
"AgencyInstNum": 1,
"AgencyNum": 1,
"AgencyNumDisplay": 1,
"AgencyType": "sample string 3",
"AgencyTypeDescription": "sample string 4",
"ASAPActiveFlag": true,
"ASAPFlag": true,
"ASAPID": "sample string 5",
"ASAPIDDescription": "sample string 6",
"ASAPName": "sample string 7",
"CallbackPhone": "sample string 8",
"CentralStationLicense": "sample string 9",
"DispatchAgencySearch": "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"
}
]
}
]
},
"Name": "sample string 11",
"Name2": "sample string 12",
"PermitRequiredFlag": true,
"RestrictedUseFlag": true,
"SiteCrossStreetRequiredFlag": true,
"DispatchOpAct": "sample string 13",
"DispatchOpActDescription": "sample string 14",
"RapidSOSFlag": true,
"AgencyCode": "sample string 15",
"AgencyPermitComment": "sample string 16",
"BroadcastAndFileFlag": true,
"ECVOption": "sample string 17",
"FalseAlarmRestriction": "sample string 18",
"MultipleTripsRequirement": "sample string 19",
"OrdinanceURL": "sample string 20",
"PermitResponsible": "sample string 21",
"PermitURL": "sample string 22",
"PrivateResponseOnlyFlag": true,
"SIACP01PanelFlag": true,
"SpecialInstructions": "sample string 23",
"VerifiedResponse": "sample string 24"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<AgencyDetailQueryResult 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>
<AgencyDetailResult>
<ASAPActiveFlag>true</ASAPActiveFlag>
<ASAPFlag>true</ASAPFlag>
<ASAPID>sample string 5</ASAPID>
<ASAPIDDescription>sample string 6</ASAPIDDescription>
<ASAPName>sample string 7</ASAPName>
<AdditionalDataFlag>true</AdditionalDataFlag>
<AgencyCode>sample string 15</AgencyCode>
<AgencyID>sample string 1</AgencyID>
<AgencyInstDescription>sample string 2</AgencyInstDescription>
<AgencyInstNum>1</AgencyInstNum>
<AgencyNum>1</AgencyNum>
<AgencyNumDisplay>1</AgencyNumDisplay>
<AgencyPermitComment>sample string 16</AgencyPermitComment>
<AgencyType>sample string 3</AgencyType>
<AgencyTypeDescription>sample string 4</AgencyTypeDescription>
<BroadcastAndFileFlag>true</BroadcastAndFileFlag>
<CallbackPhone>sample string 8</CallbackPhone>
<CentralStationLicense>sample string 9</CentralStationLicense>
<DispatchAgencySearch>sample string 10</DispatchAgencySearch>
<DispatchOpAct>sample string 13</DispatchOpAct>
<DispatchOpActDescription>sample string 14</DispatchOpActDescription>
<ECVOption>sample string 17</ECVOption>
<FalseAlarmRestriction>sample string 18</FalseAlarmRestriction>
<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>
<MultipleTripsRequirement>sample string 19</MultipleTripsRequirement>
<Name>sample string 11</Name>
<Name2>sample string 12</Name2>
<OrdinanceURL>sample string 20</OrdinanceURL>
<PermitRequiredFlag>true</PermitRequiredFlag>
<PermitResponsible>sample string 21</PermitResponsible>
<PermitURL>sample string 22</PermitURL>
<PrivateResponseOnlyFlag>true</PrivateResponseOnlyFlag>
<RapidSOSFlag>true</RapidSOSFlag>
<RestrictedUseFlag>true</RestrictedUseFlag>
<SIACP01PanelFlag>true</SIACP01PanelFlag>
<SiteCrossStreetRequiredFlag>true</SiteCrossStreetRequiredFlag>
<SpecialInstructions>sample string 23</SpecialInstructions>
<VerifiedResponse>sample string 24</VerifiedResponse>
</AgencyDetailResult>
<AgencyDetailResult>
<ASAPActiveFlag>true</ASAPActiveFlag>
<ASAPFlag>true</ASAPFlag>
<ASAPID>sample string 5</ASAPID>
<ASAPIDDescription>sample string 6</ASAPIDDescription>
<ASAPName>sample string 7</ASAPName>
<AdditionalDataFlag>true</AdditionalDataFlag>
<AgencyCode>sample string 15</AgencyCode>
<AgencyID>sample string 1</AgencyID>
<AgencyInstDescription>sample string 2</AgencyInstDescription>
<AgencyInstNum>1</AgencyInstNum>
<AgencyNum>1</AgencyNum>
<AgencyNumDisplay>1</AgencyNumDisplay>
<AgencyPermitComment>sample string 16</AgencyPermitComment>
<AgencyType>sample string 3</AgencyType>
<AgencyTypeDescription>sample string 4</AgencyTypeDescription>
<BroadcastAndFileFlag>true</BroadcastAndFileFlag>
<CallbackPhone>sample string 8</CallbackPhone>
<CentralStationLicense>sample string 9</CentralStationLicense>
<DispatchAgencySearch>sample string 10</DispatchAgencySearch>
<DispatchOpAct>sample string 13</DispatchOpAct>
<DispatchOpActDescription>sample string 14</DispatchOpActDescription>
<ECVOption>sample string 17</ECVOption>
<FalseAlarmRestriction>sample string 18</FalseAlarmRestriction>
<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>
<MultipleTripsRequirement>sample string 19</MultipleTripsRequirement>
<Name>sample string 11</Name>
<Name2>sample string 12</Name2>
<OrdinanceURL>sample string 20</OrdinanceURL>
<PermitRequiredFlag>true</PermitRequiredFlag>
<PermitResponsible>sample string 21</PermitResponsible>
<PermitURL>sample string 22</PermitURL>
<PrivateResponseOnlyFlag>true</PrivateResponseOnlyFlag>
<RapidSOSFlag>true</RapidSOSFlag>
<RestrictedUseFlag>true</RestrictedUseFlag>
<SIACP01PanelFlag>true</SIACP01PanelFlag>
<SiteCrossStreetRequiredFlag>true</SiteCrossStreetRequiredFlag>
<SpecialInstructions>sample string 23</SpecialInstructions>
<VerifiedResponse>sample string 24</VerifiedResponse>
</AgencyDetailResult>
</ResultSet>
</AgencyDetailQueryResult>