POST api/SiteGroup/SiteGroupNoteList
Request Information
URI Parameters
None.
Body Parameters
SiteGroupNoteRequestName | Description | Type | Additional information |
---|---|---|---|
SeqNum | integer |
None. |
|
HighlightSeqNum | integer |
None. |
|
SiteGroupNum | integer |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "SeqNum": 1, "HighlightSeqNum": 1, "SiteGroupNum": 1, "SessionNum": 1, "SessionPassword": "QEA=", "ApplicationCode": "sample string 2", "StagesURL": "sample string 3" }
application/xml, text/xml
Sample:
<SiteGroupNoteRequest 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> <HighlightSeqNum>1</HighlightSeqNum> <SeqNum>1</SeqNum> </SiteGroupNoteRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteGroupNoteListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of SiteGroupNoteListResult |
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, "EffectiveDateTime": "2025-05-03T22:28:47.232643-07:00", "ExpireDateTime": "2025-05-03T22:28:47.232643-07:00", "HighlightFlag": true, "HighlightSeqNum": 1, "NoteType": "sample string 1", "NoteTypeDescription": "sample string 2", "NoteXml": { "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" } ] } ] }, "SeqNum": 1, "SiteGroupName": "sample string 3", "SiteGroupNum": 1 }, { "ACKFlag": true, "EffectiveDateTime": "2025-05-03T22:28:47.232643-07:00", "ExpireDateTime": "2025-05-03T22:28:47.232643-07:00", "HighlightFlag": true, "HighlightSeqNum": 1, "NoteType": "sample string 1", "NoteTypeDescription": "sample string 2", "NoteXml": { "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" } ] } ] }, "SeqNum": 1, "SiteGroupName": "sample string 3", "SiteGroupNum": 1 } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<SiteGroupNoteListQueryResult 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> <SiteGroupNoteListResult> <ACKFlag>true</ACKFlag> <EffectiveDateTime>2025-05-03T22:28:47.232643-07:00</EffectiveDateTime> <ExpireDateTime>2025-05-03T22:28:47.232643-07:00</ExpireDateTime> <HighlightFlag>true</HighlightFlag> <HighlightSeqNum>1</HighlightSeqNum> <NoteType>sample string 1</NoteType> <NoteTypeDescription>sample string 2</NoteTypeDescription> <NoteXml> <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> </NoteXml> <SeqNum>1</SeqNum> <SiteGroupName>sample string 3</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> </SiteGroupNoteListResult> <SiteGroupNoteListResult> <ACKFlag>true</ACKFlag> <EffectiveDateTime>2025-05-03T22:28:47.232643-07:00</EffectiveDateTime> <ExpireDateTime>2025-05-03T22:28:47.232643-07:00</ExpireDateTime> <HighlightFlag>true</HighlightFlag> <HighlightSeqNum>1</HighlightSeqNum> <NoteType>sample string 1</NoteType> <NoteTypeDescription>sample string 2</NoteTypeDescription> <NoteXml> <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> </NoteXml> <SeqNum>1</SeqNum> <SiteGroupName>sample string 3</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> </SiteGroupNoteListResult> </ResultSet> </SiteGroupNoteListQueryResult>