GET api/list/events/filters?context={context}&eventTypes[0]={eventTypes[0]}&eventTypes[1]={eventTypes[1]}&roleTypes[0]={roleTypes[0]}&roleTypes[1]={roleTypes[1]}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
context

ListContext

Required

eventTypes

Collection of string

None.

roleTypes

Collection of string

None.

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfEventListFilterDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of EventListFilterDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "CreatedBy": [
        1,
        2
      ],
      "NegotiatorIds": [
        1,
        1
      ],
      "OwningTeamIds": [
        1,
        1
      ],
      "RoleIds": [
        1,
        2
      ],
      "GroupId": 1,
      "From": "2018-11-16T09:16:07.3750443Z",
      "To": "2018-11-16T09:16:07.3750443Z",
      "CreatedFrom": "2018-11-16T09:16:07.3750443Z",
      "CreatedTo": "2018-11-16T09:16:07.3750443Z",
      "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,
      "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"
      ],
      "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
      ],
      "Name": "sample string 3",
      "CustomFilterConfig": "sample string 4",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 5",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 8,
      "Id": 9
    },
    {
      "CreatedBy": [
        1,
        2
      ],
      "NegotiatorIds": [
        1,
        1
      ],
      "OwningTeamIds": [
        1,
        1
      ],
      "RoleIds": [
        1,
        2
      ],
      "GroupId": 1,
      "From": "2018-11-16T09:16:07.3750443Z",
      "To": "2018-11-16T09:16:07.3750443Z",
      "CreatedFrom": "2018-11-16T09:16:07.3750443Z",
      "CreatedTo": "2018-11-16T09:16:07.3750443Z",
      "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,
      "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"
      ],
      "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
      ],
      "Name": "sample string 3",
      "CustomFilterConfig": "sample string 4",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 5",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 8,
      "Id": 9
    }
  ]
}