POST api/Events/GetEvents

Gets a list of Events based on advanced filtering.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageIndex	The requested page index	integer	None.
PageSize	The requested page size	integer	None.
EventType	Filter by the type of event, if set	EventTypeEnum	None.
UserProviderKey	Filter by user key, if set	string	None.
TicketId	Filter by ticket id, if set	integer	None.
AddedFromUtc	Filter by date of the addition	date	None.
AddedUntilUtc	Filter by date of the addition	date	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 0,
  "PageSize": 10,
  "EventType": 12,
  "UserProviderKey": null,
  "TicketId": null,
  "AddedFromUtc": null,
  "AddedUntilUtc": null
}

application/xml, text/xml

Sample:

<EventsFilterPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <AddedFromUtc i:nil="true" />
  <AddedUntilUtc i:nil="true" />
  <EventType>ChangeAvailabilityInAutomaticTicketAssignment</EventType>
  <PageIndex>0</PageIndex>
  <PageSize>10</PageSize>
  <TicketId i:nil="true" />
  <UserProviderKey i:nil="true" />
</EventsFilterPost>

Response Information

Resource Description

GetEventsResult

Name	Description	Type	Additional information
PagedEvents	A page with Event rows.	EventRow	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedEvents": {
    "PageIndex": 0,
    "PageSize": 10,
    "TotalItems": 1,
    "TotalPages": 1,
    "Items": [
      {
        "Id": 1,
        "UserProviderKey": "0529ffec-271f-466c-acff-bc6fc9d6933a",
        "FullName": "John Doe",
        "DateAddUtc": "2024-04-28T02:03:39.5436406Z",
        "Type": 12,
        "Ip": null,
        "Os": null,
        "Browser": null,
        "TicketId": null,
        "TicketSubject": null,
        "TicketREF": null,
        "CustomerName": null,
        "CustomerId": null,
        "PriorityName": null,
        "PropertyName": null,
        "OldValue": null,
        "NewValue": null,
        "IsAvailable": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetEventsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedEvents>
    <Items>
      <GetEventsResult.EventRow>
        <Browser i:nil="true" />
        <CustomerId i:nil="true" />
        <CustomerName i:nil="true" />
        <DateAddUtc>2024-04-28T02:03:39.5436406Z</DateAddUtc>
        <FullName>John Doe</FullName>
        <Id>1</Id>
        <Ip i:nil="true" />
        <IsAvailable>true</IsAvailable>
        <NewValue i:nil="true" />
        <OldValue i:nil="true" />
        <Os i:nil="true" />
        <PriorityName i:nil="true" />
        <PropertyName i:nil="true" />
        <TicketId i:nil="true" />
        <TicketREF i:nil="true" />
        <TicketSubject i:nil="true" />
        <Type>ChangeAvailabilityInAutomaticTicketAssignment</Type>
        <UserProviderKey>0529ffec-271f-466c-acff-bc6fc9d6933a</UserProviderKey>
      </GetEventsResult.EventRow>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
    <TotalItems>1</TotalItems>
    <TotalPages>1</TotalPages>
  </PagedEvents>
</GetEventsResult>