POST api/Site/SiteNoteList
Request Information
URI Parameters
None.
Body Parameters
SiteNoteListRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SeqNum | integer |
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:
{
"SeqNum": 1,
"SiteNum": 1,
"SessionNum": 1,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 2",
"StagesURL": "sample string 3"
}
application/xml, text/xml
Sample:
<SiteNoteListRequest 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> <SiteNum>1</SiteNum> <SeqNum>1</SeqNum> </SiteNoteListRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteNoteListQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of SiteNoteListResult |
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-12-14T17:38:00.0601207-05:00",
"ExpireDateTime": "2025-12-14T17:38:00.0601207-05: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,
"SiteName": "sample string 3",
"SiteNum": 1
},
{
"ACKFlag": true,
"EffectiveDateTime": "2025-12-14T17:38:00.0601207-05:00",
"ExpireDateTime": "2025-12-14T17:38:00.0601207-05: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,
"SiteName": "sample string 3",
"SiteNum": 1
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<SiteNoteListQueryResult 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>
<SiteNoteListResult>
<ACKFlag>true</ACKFlag>
<EffectiveDateTime>2025-12-14T17:38:00.0601207-05:00</EffectiveDateTime>
<ExpireDateTime>2025-12-14T17:38:00.0601207-05: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>
<SiteName>sample string 3</SiteName>
<SiteNum>1</SiteNum>
</SiteNoteListResult>
<SiteNoteListResult>
<ACKFlag>true</ACKFlag>
<EffectiveDateTime>2025-12-14T17:38:00.0601207-05:00</EffectiveDateTime>
<ExpireDateTime>2025-12-14T17:38:00.0601207-05: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>
<SiteName>sample string 3</SiteName>
<SiteNum>1</SiteNum>
</SiteNoteListResult>
</ResultSet>
</SiteNoteListQueryResult>