POST api/Tickets/SearchTickets

Searches tickets by posted parameters

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageIndex	Page index	integer	None.
PageSize	Page size	integer	None.
Value	search value	string	None.
IncludeArchived	include archived tickets	boolean	None.
IncludeSpam	include spam	boolean	None.
IncludeForms	include forms	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 0,
  "PageSize": 10,
  "Value": "test",
  "IncludeArchived": true,
  "IncludeSpam": true,
  "IncludeForms": true
}

application/xml, text/xml

Sample:

<SearchTicketsPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <IncludeArchived>true</IncludeArchived>
  <IncludeForms>true</IncludeForms>
  <IncludeSpam>true</IncludeSpam>
  <PageIndex>0</PageIndex>
  <PageSize>10</PageSize>
  <Value>test</Value>
</SearchTicketsPost>

Response Information

Resource Description

SearchTicketsResult

Name	Description	Type	Additional information
Tickets		SearchTicket	None.

Response Formats

application/json, text/json

Sample:

{
  "Tickets": {
    "PageIndex": 0,
    "PageSize": 10,
    "IsNextPage": false,
    "Items": [
      {
        "TicketId": 0,
        "TicketREF": "INC-000010",
        "Archived": false,
        "Closed": false,
        "CreatedUtc": "0001-01-01T00:00:00",
        "CustomerId": null,
        "CustomerName": null,
        "Subject": "I cannot access to the net printer",
        "SubmitterFullName": "Some User",
        "TicketState": 201,
        "TicketSummaryState": 1,
        "ServiceId": 2,
        "ServiceName": "Printers",
        "TicketType": 2,
        "TicketSource": 2
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SearchTicketsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Tickets>
    <IsNextPage>false</IsNextPage>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:SearchTicket>
        <d3p1:Archived>false</d3p1:Archived>
        <d3p1:Closed>false</d3p1:Closed>
        <d3p1:CreatedUtc>0001-01-01T00:00:00</d3p1:CreatedUtc>
        <d3p1:CustomerId i:nil="true" />
        <d3p1:CustomerName i:nil="true" />
        <d3p1:ServiceId>2</d3p1:ServiceId>
        <d3p1:ServiceName>Printers</d3p1:ServiceName>
        <d3p1:Subject>I cannot access to the net printer</d3p1:Subject>
        <d3p1:SubmitterFullName>Some User</d3p1:SubmitterFullName>
        <d3p1:TicketId>0</d3p1:TicketId>
        <d3p1:TicketREF>INC-000010</d3p1:TicketREF>
        <d3p1:TicketSource>Email</d3p1:TicketSource>
        <d3p1:TicketState>IncidentInQueue</d3p1:TicketState>
        <d3p1:TicketSummaryState>Registered</d3p1:TicketSummaryState>
        <d3p1:TicketType>Incident</d3p1:TicketType>
      </d3p1:SearchTicket>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
  </Tickets>
</SearchTicketsResult>