POST api/SiteGroup/SiteGroupDetail
Request Information
URI Parameters
None.
Body Parameters
SiteGroupNumRequestName | Description | Type | Additional information |
---|---|---|---|
SiteGroupNum | integer |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "SiteGroupNum": 1, "SessionNum": 1, "SessionPassword": "QEA=", "ApplicationCode": "sample string 2", "StagesURL": "sample string 3" }
application/xml, text/xml
Sample:
<SiteGroupNumRequest 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> <SiteGroupNum>1</SiteGroupNum> </SiteGroupNumRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteGroupDetailQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of SiteGroupDetailResult |
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": [ { "ApplicationNum": 1, "BarcodePrinterFlag": true, "c11": "sample string 1", "c2": "sample string 2", "c9": "sample string 3", "DispatchingSiteFlag": true, "DispatchingSiteNum": 1, "DocumentFlag": true, "ExcludeParentExternalEventCodesFlag": true, "ExcludeParentExternalOOSCategoriesFlag": true, "f11": "sample string 4", "f2": "sample string 5", "f9": "sample string 6", "GuardCompanyFlag": true, "IncludeOOSFlag": true, "RollupSiteGroupName": "sample string 7", "RollupSiteGroupNum": 1, "SiteGroupInfoXml": { "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" } ] } ] }, "SiteGroupName": "sample string 8", "SiteGroupNum": 1, "SiteGroupSummary": { "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" } ] } ] }, "SiteGroupSuspendFlag": "sample string 9", "SiteGroupType": "sample string 10", "SiteGroupTypeDescription": "sample string 11", "SiteName": "sample string 12", "SuppressLDAPFlag": true, "TimeZoneDescription": "sample string 13", "UserGroup": "sample string 14", "AppUserSearch": "sample string 15", "Authority": "sample string 16", "AuthorityDescription": "sample string 17", "AutoNotifyOption": "sample string 18", "AutoNotifyOptionDescription": "sample string 19", "AutoNotifyRecipient": "sample string 20", "BillingID": "sample string 21", "CallbackPhone": "sample string 22", "CommentBig": "sample string 23", "EmailFromName": "sample string 24", "FilePassword": "sample string 25", "IgnoreClearTestRestoresPendingFlag": true, "LogoURL": "sample string 26", "MaxDataLocCallsPerDay": 1, "Name": "sample string 27", "OperatorViewOnlyFlag": true, "RestrictedAccess": "sample string 28", "RestrictedAccessDescription": "sample string 29", "RunawayThreshold": "sample string 30", "RunawayThresholdDescription": "sample string 31", "SiteBoundaryDistance": 1.0, "SiteGroupAlias": "sample string 32", "SMSFromPhone": "sample string 33", "SMSService": "sample string 34", "TimeZoneNum": 1, "VerifyContactForScheduleChange": "sample string 35", "VerifyContactForScheduleChangeDefault": "sample string 36", "VerifyContactForScheduleChangeDescription": "sample string 37", "VerifyContactForTestFlag": true, "EmailFromAddress": "sample string 38", "OnlyDisplaySGLicensesFlag": true, "DefaultAuthority": "sample string 39", "DefaultAuthorityDescription": "sample string 40", "SiteLanguage": "sample string 41", "SiteLanguageDescription": "sample string 42", "IncludeSubSiteGroupCountsFlag": true, "RecentlyOnSiteCutoffPeriod": "sample string 43", "App3ExplicitAccessFlag": true, "CustomStyleSheet": "sample string 44", "ExternalAccessIP": "sample string 45", "ExternalAccessMask": "sample string 46", "ExternalBufferSoundFlag": true, "ExternalDispatchIP": "sample string 47", "ExternalDispatchMask": "sample string 48", "ExternalDispatchOfficeNum": 1, "OfficeDescription": "sample string 49", "XtTestCategory": "sample string 50", "XtTestCategoryDescription": "sample string 51", "ExcludeMsgCtrRecentAlarmsFlag": true, "DoNotValidateSessionIPAddressFlag": true }, { "ApplicationNum": 1, "BarcodePrinterFlag": true, "c11": "sample string 1", "c2": "sample string 2", "c9": "sample string 3", "DispatchingSiteFlag": true, "DispatchingSiteNum": 1, "DocumentFlag": true, "ExcludeParentExternalEventCodesFlag": true, "ExcludeParentExternalOOSCategoriesFlag": true, "f11": "sample string 4", "f2": "sample string 5", "f9": "sample string 6", "GuardCompanyFlag": true, "IncludeOOSFlag": true, "RollupSiteGroupName": "sample string 7", "RollupSiteGroupNum": 1, "SiteGroupInfoXml": { "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" } ] } ] }, "SiteGroupName": "sample string 8", "SiteGroupNum": 1, "SiteGroupSummary": { "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" } ] } ] }, "SiteGroupSuspendFlag": "sample string 9", "SiteGroupType": "sample string 10", "SiteGroupTypeDescription": "sample string 11", "SiteName": "sample string 12", "SuppressLDAPFlag": true, "TimeZoneDescription": "sample string 13", "UserGroup": "sample string 14", "AppUserSearch": "sample string 15", "Authority": "sample string 16", "AuthorityDescription": "sample string 17", "AutoNotifyOption": "sample string 18", "AutoNotifyOptionDescription": "sample string 19", "AutoNotifyRecipient": "sample string 20", "BillingID": "sample string 21", "CallbackPhone": "sample string 22", "CommentBig": "sample string 23", "EmailFromName": "sample string 24", "FilePassword": "sample string 25", "IgnoreClearTestRestoresPendingFlag": true, "LogoURL": "sample string 26", "MaxDataLocCallsPerDay": 1, "Name": "sample string 27", "OperatorViewOnlyFlag": true, "RestrictedAccess": "sample string 28", "RestrictedAccessDescription": "sample string 29", "RunawayThreshold": "sample string 30", "RunawayThresholdDescription": "sample string 31", "SiteBoundaryDistance": 1.0, "SiteGroupAlias": "sample string 32", "SMSFromPhone": "sample string 33", "SMSService": "sample string 34", "TimeZoneNum": 1, "VerifyContactForScheduleChange": "sample string 35", "VerifyContactForScheduleChangeDefault": "sample string 36", "VerifyContactForScheduleChangeDescription": "sample string 37", "VerifyContactForTestFlag": true, "EmailFromAddress": "sample string 38", "OnlyDisplaySGLicensesFlag": true, "DefaultAuthority": "sample string 39", "DefaultAuthorityDescription": "sample string 40", "SiteLanguage": "sample string 41", "SiteLanguageDescription": "sample string 42", "IncludeSubSiteGroupCountsFlag": true, "RecentlyOnSiteCutoffPeriod": "sample string 43", "App3ExplicitAccessFlag": true, "CustomStyleSheet": "sample string 44", "ExternalAccessIP": "sample string 45", "ExternalAccessMask": "sample string 46", "ExternalBufferSoundFlag": true, "ExternalDispatchIP": "sample string 47", "ExternalDispatchMask": "sample string 48", "ExternalDispatchOfficeNum": 1, "OfficeDescription": "sample string 49", "XtTestCategory": "sample string 50", "XtTestCategoryDescription": "sample string 51", "ExcludeMsgCtrRecentAlarmsFlag": true, "DoNotValidateSessionIPAddressFlag": true } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<SiteGroupDetailQueryResult 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> <SiteGroupDetailResult> <App3ExplicitAccessFlag>true</App3ExplicitAccessFlag> <AppUserSearch>sample string 15</AppUserSearch> <ApplicationNum>1</ApplicationNum> <Authority>sample string 16</Authority> <AuthorityDescription>sample string 17</AuthorityDescription> <AutoNotifyOption>sample string 18</AutoNotifyOption> <AutoNotifyOptionDescription>sample string 19</AutoNotifyOptionDescription> <AutoNotifyRecipient>sample string 20</AutoNotifyRecipient> <BarcodePrinterFlag>true</BarcodePrinterFlag> <BillingID>sample string 21</BillingID> <CallbackPhone>sample string 22</CallbackPhone> <CommentBig>sample string 23</CommentBig> <CustomStyleSheet>sample string 44</CustomStyleSheet> <DefaultAuthority>sample string 39</DefaultAuthority> <DefaultAuthorityDescription>sample string 40</DefaultAuthorityDescription> <DispatchingSiteFlag>true</DispatchingSiteFlag> <DispatchingSiteNum>1</DispatchingSiteNum> <DoNotValidateSessionIPAddressFlag>true</DoNotValidateSessionIPAddressFlag> <DocumentFlag>true</DocumentFlag> <EmailFromAddress>sample string 38</EmailFromAddress> <EmailFromName>sample string 24</EmailFromName> <ExcludeMsgCtrRecentAlarmsFlag>true</ExcludeMsgCtrRecentAlarmsFlag> <ExcludeParentExternalEventCodesFlag>true</ExcludeParentExternalEventCodesFlag> <ExcludeParentExternalOOSCategoriesFlag>true</ExcludeParentExternalOOSCategoriesFlag> <ExternalAccessIP>sample string 45</ExternalAccessIP> <ExternalAccessMask>sample string 46</ExternalAccessMask> <ExternalBufferSoundFlag>true</ExternalBufferSoundFlag> <ExternalDispatchIP>sample string 47</ExternalDispatchIP> <ExternalDispatchMask>sample string 48</ExternalDispatchMask> <ExternalDispatchOfficeNum>1</ExternalDispatchOfficeNum> <FilePassword>sample string 25</FilePassword> <GuardCompanyFlag>true</GuardCompanyFlag> <IgnoreClearTestRestoresPendingFlag>true</IgnoreClearTestRestoresPendingFlag> <IncludeOOSFlag>true</IncludeOOSFlag> <IncludeSubSiteGroupCountsFlag>true</IncludeSubSiteGroupCountsFlag> <LogoURL>sample string 26</LogoURL> <MaxDataLocCallsPerDay>1</MaxDataLocCallsPerDay> <Name>sample string 27</Name> <OfficeDescription>sample string 49</OfficeDescription> <OnlyDisplaySGLicensesFlag>true</OnlyDisplaySGLicensesFlag> <OperatorViewOnlyFlag>true</OperatorViewOnlyFlag> <RecentlyOnSiteCutoffPeriod>sample string 43</RecentlyOnSiteCutoffPeriod> <RestrictedAccess>sample string 28</RestrictedAccess> <RestrictedAccessDescription>sample string 29</RestrictedAccessDescription> <RollupSiteGroupName>sample string 7</RollupSiteGroupName> <RollupSiteGroupNum>1</RollupSiteGroupNum> <RunawayThreshold>sample string 30</RunawayThreshold> <RunawayThresholdDescription>sample string 31</RunawayThresholdDescription> <SMSFromPhone>sample string 33</SMSFromPhone> <SMSService>sample string 34</SMSService> <SiteBoundaryDistance>1</SiteBoundaryDistance> <SiteGroupAlias>sample string 32</SiteGroupAlias> <SiteGroupInfoXml> <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> </SiteGroupInfoXml> <SiteGroupName>sample string 8</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSummary> <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> </SiteGroupSummary> <SiteGroupSuspendFlag>sample string 9</SiteGroupSuspendFlag> <SiteGroupType>sample string 10</SiteGroupType> <SiteGroupTypeDescription>sample string 11</SiteGroupTypeDescription> <SiteLanguage>sample string 41</SiteLanguage> <SiteLanguageDescription>sample string 42</SiteLanguageDescription> <SiteName>sample string 12</SiteName> <SuppressLDAPFlag>true</SuppressLDAPFlag> <TimeZoneDescription>sample string 13</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <UserGroup>sample string 14</UserGroup> <VerifyContactForScheduleChange>sample string 35</VerifyContactForScheduleChange> <VerifyContactForScheduleChangeDefault>sample string 36</VerifyContactForScheduleChangeDefault> <VerifyContactForScheduleChangeDescription>sample string 37</VerifyContactForScheduleChangeDescription> <VerifyContactForTestFlag>true</VerifyContactForTestFlag> <XtTestCategory>sample string 50</XtTestCategory> <XtTestCategoryDescription>sample string 51</XtTestCategoryDescription> <c11>sample string 1</c11> <c2>sample string 2</c2> <c9>sample string 3</c9> <f11>sample string 4</f11> <f2>sample string 5</f2> <f9>sample string 6</f9> </SiteGroupDetailResult> <SiteGroupDetailResult> <App3ExplicitAccessFlag>true</App3ExplicitAccessFlag> <AppUserSearch>sample string 15</AppUserSearch> <ApplicationNum>1</ApplicationNum> <Authority>sample string 16</Authority> <AuthorityDescription>sample string 17</AuthorityDescription> <AutoNotifyOption>sample string 18</AutoNotifyOption> <AutoNotifyOptionDescription>sample string 19</AutoNotifyOptionDescription> <AutoNotifyRecipient>sample string 20</AutoNotifyRecipient> <BarcodePrinterFlag>true</BarcodePrinterFlag> <BillingID>sample string 21</BillingID> <CallbackPhone>sample string 22</CallbackPhone> <CommentBig>sample string 23</CommentBig> <CustomStyleSheet>sample string 44</CustomStyleSheet> <DefaultAuthority>sample string 39</DefaultAuthority> <DefaultAuthorityDescription>sample string 40</DefaultAuthorityDescription> <DispatchingSiteFlag>true</DispatchingSiteFlag> <DispatchingSiteNum>1</DispatchingSiteNum> <DoNotValidateSessionIPAddressFlag>true</DoNotValidateSessionIPAddressFlag> <DocumentFlag>true</DocumentFlag> <EmailFromAddress>sample string 38</EmailFromAddress> <EmailFromName>sample string 24</EmailFromName> <ExcludeMsgCtrRecentAlarmsFlag>true</ExcludeMsgCtrRecentAlarmsFlag> <ExcludeParentExternalEventCodesFlag>true</ExcludeParentExternalEventCodesFlag> <ExcludeParentExternalOOSCategoriesFlag>true</ExcludeParentExternalOOSCategoriesFlag> <ExternalAccessIP>sample string 45</ExternalAccessIP> <ExternalAccessMask>sample string 46</ExternalAccessMask> <ExternalBufferSoundFlag>true</ExternalBufferSoundFlag> <ExternalDispatchIP>sample string 47</ExternalDispatchIP> <ExternalDispatchMask>sample string 48</ExternalDispatchMask> <ExternalDispatchOfficeNum>1</ExternalDispatchOfficeNum> <FilePassword>sample string 25</FilePassword> <GuardCompanyFlag>true</GuardCompanyFlag> <IgnoreClearTestRestoresPendingFlag>true</IgnoreClearTestRestoresPendingFlag> <IncludeOOSFlag>true</IncludeOOSFlag> <IncludeSubSiteGroupCountsFlag>true</IncludeSubSiteGroupCountsFlag> <LogoURL>sample string 26</LogoURL> <MaxDataLocCallsPerDay>1</MaxDataLocCallsPerDay> <Name>sample string 27</Name> <OfficeDescription>sample string 49</OfficeDescription> <OnlyDisplaySGLicensesFlag>true</OnlyDisplaySGLicensesFlag> <OperatorViewOnlyFlag>true</OperatorViewOnlyFlag> <RecentlyOnSiteCutoffPeriod>sample string 43</RecentlyOnSiteCutoffPeriod> <RestrictedAccess>sample string 28</RestrictedAccess> <RestrictedAccessDescription>sample string 29</RestrictedAccessDescription> <RollupSiteGroupName>sample string 7</RollupSiteGroupName> <RollupSiteGroupNum>1</RollupSiteGroupNum> <RunawayThreshold>sample string 30</RunawayThreshold> <RunawayThresholdDescription>sample string 31</RunawayThresholdDescription> <SMSFromPhone>sample string 33</SMSFromPhone> <SMSService>sample string 34</SMSService> <SiteBoundaryDistance>1</SiteBoundaryDistance> <SiteGroupAlias>sample string 32</SiteGroupAlias> <SiteGroupInfoXml> <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> </SiteGroupInfoXml> <SiteGroupName>sample string 8</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSummary> <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> </SiteGroupSummary> <SiteGroupSuspendFlag>sample string 9</SiteGroupSuspendFlag> <SiteGroupType>sample string 10</SiteGroupType> <SiteGroupTypeDescription>sample string 11</SiteGroupTypeDescription> <SiteLanguage>sample string 41</SiteLanguage> <SiteLanguageDescription>sample string 42</SiteLanguageDescription> <SiteName>sample string 12</SiteName> <SuppressLDAPFlag>true</SuppressLDAPFlag> <TimeZoneDescription>sample string 13</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <UserGroup>sample string 14</UserGroup> <VerifyContactForScheduleChange>sample string 35</VerifyContactForScheduleChange> <VerifyContactForScheduleChangeDefault>sample string 36</VerifyContactForScheduleChangeDefault> <VerifyContactForScheduleChangeDescription>sample string 37</VerifyContactForScheduleChangeDescription> <VerifyContactForTestFlag>true</VerifyContactForTestFlag> <XtTestCategory>sample string 50</XtTestCategory> <XtTestCategoryDescription>sample string 51</XtTestCategoryDescription> <c11>sample string 1</c11> <c2>sample string 2</c2> <c9>sample string 3</c9> <f11>sample string 4</f11> <f2>sample string 5</f2> <f9>sample string 6</f9> </SiteGroupDetailResult> </ResultSet> </SiteGroupDetailQueryResult>