POST api/list/events/savefilter

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.Events.Filter.SaveEventListFilterDataContract

Name	Type	Additional information
Context	Dezrez.Core.DataContracts.External.Api.Lists.Events.ListContext	None.
CreatedBy	Collection of integer	None.
NegotiatorIds	Collection of integer	None.
OwningTeamIds	Collection of integer	None.
RoleIds	Collection of integer	None.
GroupId	integer	None.
From	date	None.
To	date	None.
Date	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
UpcomingOnly	boolean	None.
CreatedFrom	date	None.
CreatedTo	date	None.
Created	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
OfferStatuses	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
EventCategories	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
EventTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
EventStatuses	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
IncludeDrafts	boolean	None.
IncludeOnlyOriginalNotes	boolean	None.
ExcludedRevisedOffers	boolean	None.
ExcludedTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
RoleTypes	Collection of string	None.
ExcludeRoleTypes	Collection of string	None.
RoleStatuses	Collection of string	None.
PropertyId	integer	None.
Descriptions	Dictionary of string [key] and string [value]	None.
FeedbackTaken	boolean	None.
FeedbackReported	boolean	None.
MethodsOfContact	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
SortType	Dezrez.Core.DataContracts.External.Api.Lists.Events.EventListSortType	None.
EventIds	Collection of integer	None.
AdditionalIds	Collection of integer	None.
ExcludedIds	Collection of integer	None.
CleanInactiveAppointments	boolean	None.
UseMinimalMapping	boolean	None.
FilterNotes	boolean	None.
Name	string	None.
CustomFilterConfig	string	None.
BranchId	integer	None.
BranchIds	Collection of integer	None.
EventBranchIds	Collection of integer	None.
Order	Dezrez.Core.DataContracts.External.Api.Lists.ListOrder	None.
SearchTerm	string	None.
FilterType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
ShowDeleted	boolean	None.
ShowCancelled	boolean	None.
OwningTeamId	integer	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Context": 0,
  "CreatedBy": [
    1,
    2
  ],
  "NegotiatorIds": [
    1,
    1
  ],
  "OwningTeamIds": [
    1,
    1
  ],
  "RoleIds": [
    1,
    2
  ],
  "GroupId": 1,
  "From": "2024-10-30T15:16:17.6486255Z",
  "To": "2024-10-30T15:16:17.6486255Z",
  "Date": {
    "FromStaticDate": "2024-10-30T15:16:17.6486255Z",
    "ToStaticDate": "2024-10-30T15:16:17.6486255Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "UpcomingOnly": true,
  "CreatedFrom": "2024-10-30T15:16:17.6486255Z",
  "CreatedTo": "2024-10-30T15:16:17.6486255Z",
  "Created": {
    "FromStaticDate": "2024-10-30T15:16:17.6486255Z",
    "ToStaticDate": "2024-10-30T15:16:17.6486255Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "OfferStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventCategories": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IncludeDrafts": true,
  "IncludeOnlyOriginalNotes": true,
  "ExcludedRevisedOffers": true,
  "ExcludedTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeRoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "PropertyId": 1,
  "Descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "FeedbackTaken": true,
  "FeedbackReported": true,
  "MethodsOfContact": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "SortType": 0,
  "EventIds": [
    1,
    2
  ],
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "CleanInactiveAppointments": true,
  "UseMinimalMapping": true,
  "FilterNotes": true,
  "Name": "sample string 8",
  "CustomFilterConfig": "sample string 9",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 10",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 13,
  "Id": 14
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Lists.Events.Filter.EventListFilterDataContract

Name	Type	Additional information
CreatedBy	Collection of integer	None.
NegotiatorIds	Collection of integer	None.
OwningTeamIds	Collection of integer	None.
RoleIds	Collection of integer	None.
GroupId	integer	None.
From	date	None.
To	date	None.
Date	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
UpcomingOnly	boolean	None.
CreatedFrom	date	None.
CreatedTo	date	None.
Created	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
OfferStatuses	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
EventCategories	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
EventTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
EventStatuses	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
IncludeDrafts	boolean	None.
IncludeOnlyOriginalNotes	boolean	None.
ExcludedRevisedOffers	boolean	None.
ExcludedTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
RoleTypes	Collection of string	None.
ExcludeRoleTypes	Collection of string	None.
RoleStatuses	Collection of string	None.
PropertyId	integer	None.
Descriptions	Dictionary of string [key] and string [value]	None.
FeedbackTaken	boolean	None.
FeedbackReported	boolean	None.
MethodsOfContact	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
SortType	Dezrez.Core.DataContracts.External.Api.Lists.Events.EventListSortType	None.
EventIds	Collection of integer	None.
AdditionalIds	Collection of integer	None.
ExcludedIds	Collection of integer	None.
CleanInactiveAppointments	boolean	None.
UseMinimalMapping	boolean	None.
FilterNotes	boolean	None.
Name	string	None.
CustomFilterConfig	string	None.
BranchId	integer	None.
BranchIds	Collection of integer	None.
EventBranchIds	Collection of integer	None.
Order	Dezrez.Core.DataContracts.External.Api.Lists.ListOrder	None.
SearchTerm	string	None.
FilterType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
ShowDeleted	boolean	None.
ShowCancelled	boolean	None.
OwningTeamId	integer	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CreatedBy": [
    1,
    2
  ],
  "NegotiatorIds": [
    1,
    1
  ],
  "OwningTeamIds": [
    1,
    1
  ],
  "RoleIds": [
    1,
    2
  ],
  "GroupId": 1,
  "From": "2024-10-30T15:16:17.6642636Z",
  "To": "2024-10-30T15:16:17.6642636Z",
  "Date": {
    "FromStaticDate": "2024-10-30T15:16:17.6642636Z",
    "ToStaticDate": "2024-10-30T15:16:17.6642636Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "UpcomingOnly": true,
  "CreatedFrom": "2024-10-30T15:16:17.6642636Z",
  "CreatedTo": "2024-10-30T15:16:17.6642636Z",
  "Created": {
    "FromStaticDate": "2024-10-30T15:16:17.6642636Z",
    "ToStaticDate": "2024-10-30T15:16:17.6642636Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "OfferStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventCategories": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IncludeDrafts": true,
  "IncludeOnlyOriginalNotes": true,
  "ExcludedRevisedOffers": true,
  "ExcludedTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeRoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "PropertyId": 1,
  "Descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "FeedbackTaken": true,
  "FeedbackReported": true,
  "MethodsOfContact": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "SortType": 0,
  "EventIds": [
    1,
    2
  ],
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "CleanInactiveAppointments": true,
  "UseMinimalMapping": true,
  "FilterNotes": true,
  "Name": "sample string 8",
  "CustomFilterConfig": "sample string 9",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 10",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 13,
  "Id": 14
}