POST 17.0/database/homepagereminders/list

Description

Retrieve a list of Home Page Reminders

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of HomePageRemindersUpdate
Name Description Type Additional information
GroupID

integer

None.
ReminderID

integer

None.
RecordID

integer

None.
SiteID

integer

None.
UserID

integer

None.
UpdatedDate

date

None.
Description

string

String length: inclusive between 0 and 100
Val

integer

None.
Icon16

string

String length: inclusive between 0 and 50
Icon32

string

String length: inclusive between 0 and 50
SQLWhere

string

String length: inclusive between 0 and 1024
SQLJoin

string

String length: inclusive between 0 and 512
UserPermissionGroupID

string

String length: inclusive between 0 and 50
UserPermissionItemID

string

String length: inclusive between 0 and 50
DisplayOrder

integer

None.

application/json, text/json
Sample: 
[
  {
    "groupID": 1,
    "reminderID": 1,
    "recordID": 1,
    "siteID": 1,
    "userID": 1,
    "updatedDate": "2025-01-09T20:38",
    "description": "sample string 1",
    "val": 1,
    "icon16": "sample string 2",
    "icon32": "sample string 3",
    "sqlWhere": "sample string 4",
    "sqlJoin": "sample string 5",
    "userPermissionGroupID": "sample string 6",
    "userPermissionItemID": "sample string 7",
    "displayOrder": 1
  },
  {
    "groupID": 1,
    "reminderID": 1,
    "recordID": 1,
    "siteID": 1,
    "userID": 1,
    "updatedDate": "2025-01-09T20:38",
    "description": "sample string 1",
    "val": 1,
    "icon16": "sample string 2",
    "icon32": "sample string 3",
    "sqlWhere": "sample string 4",
    "sqlJoin": "sample string 5",
    "userPermissionGroupID": "sample string 6",
    "userPermissionItemID": "sample string 7",
    "displayOrder": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfHomePageRemindersUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <HomePageRemindersUpdate>
    <GroupID>1</GroupID>
    <ReminderID>1</ReminderID>
    <RecordID>1</RecordID>
    <SiteID>1</SiteID>
    <UserID>1</UserID>
    <UpdatedDate>2025-01-09T20:38:52.1117216+00:00</UpdatedDate>
    <Description>sample string 1</Description>
    <Val>1</Val>
    <Icon16>sample string 2</Icon16>
    <Icon32>sample string 3</Icon32>
    <SQLWhere>sample string 4</SQLWhere>
    <SQLJoin>sample string 5</SQLJoin>
    <UserPermissionGroupID>sample string 6</UserPermissionGroupID>
    <UserPermissionItemID>sample string 7</UserPermissionItemID>
    <DisplayOrder>1</DisplayOrder>
  </HomePageRemindersUpdate>
  <HomePageRemindersUpdate>
    <GroupID>1</GroupID>
    <ReminderID>1</ReminderID>
    <RecordID>1</RecordID>
    <SiteID>1</SiteID>
    <UserID>1</UserID>
    <UpdatedDate>2025-01-09T20:38:52.1117216+00:00</UpdatedDate>
    <Description>sample string 1</Description>
    <Val>1</Val>
    <Icon16>sample string 2</Icon16>
    <Icon32>sample string 3</Icon32>
    <SQLWhere>sample string 4</SQLWhere>
    <SQLJoin>sample string 5</SQLJoin>
    <UserPermissionGroupID>sample string 6</UserPermissionGroupID>
    <UserPermissionItemID>sample string 7</UserPermissionItemID>
    <DisplayOrder>1</DisplayOrder>
  </HomePageRemindersUpdate>
</ArrayOfHomePageRemindersUpdate>