POST api/Admin/ExceptionLog/Search

Allows a SAFEAdmin to search the exception logs.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

ESignSystems.SmartSAFE.Models.Reports.ExceptionLogSearch

Name	Description	Type	Additional information
Application	Gets or sets property to search by application that caused the exception.	string	Max length: 256
Message	Gets or sets property to search by exception message.	string	Max length: 256
MethodName	Gets or sets property to search by name of the method that caused the exception.	string	Max length: 256
UserName	Gets or sets property to search by name of the user that caused the exception.	string	Max length: 256
CreatedFromDate	Gets or sets property to search for exception logs created after the given date.	date	None.
CreatedToDate	Gets or sets property to search for exception logs created before the given date.	date	None.
PageSize	Gets or sets the number of rows in the page.	integer	Range: inclusive between 1 and 2147483647
PageOffset	Gets or sets the offset page to return.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Application": "sample string 1",
  "Message": "sample string 2",
  "MethodName": "sample string 3",
  "UserName": "sample string 4",
  "CreatedFromDate": "2024-11-26T17:30:19.2081773-05:00",
  "CreatedToDate": "2024-11-26T17:30:19.2081773-05:00",
  "PageSize": 1,
  "PageOffset": 5
}

application/xml, text/xml

Sample:

<ExceptionLogSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports">
  <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">5</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <Application>sample string 1</Application>
  <CreatedFromDate>2024-11-26T17:30:19.2081773-05:00</CreatedFromDate>
  <CreatedToDate>2024-11-26T17:30:19.2081773-05:00</CreatedToDate>
  <Message>sample string 2</Message>
  <MethodName>sample string 3</MethodName>
  <UserName>sample string 4</UserName>
</ExceptionLogSearch>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of exception log reports that results from the search.

Collection of ESignSystems.SmartSAFE.Models.Reports.ExceptionLogEntry

Name	Description	Type	Additional information
ExceptionLogId	Gets or sets the exception log identifier.	integer	None.
Application	Gets or sets the application that caused the exception.	string	None.
MethodName	Gets or sets the name of the method that caused the exception.	string	None.
Message	Gets or sets the exception message.	string	None.
StackTrace	Gets or sets the stack trace of the exception.	string	None.
Severity	Gets or sets the severity of the exception.	integer	None.
Server	Gets or sets the server where the exception occurred.	string	None.
UserName	Gets or sets the name of the user that caused the exception.	string	None.
CreatedDate	Gets or sets the date that the exception was created.	date	None.
RequestData	Gets or sets the request data of the exception.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ExceptionLogId": 1,
    "Application": "sample string 2",
    "MethodName": "sample string 3",
    "Message": "sample string 4",
    "StackTrace": "sample string 5",
    "Severity": 6,
    "Server": "sample string 7",
    "UserName": "sample string 8",
    "CreatedDate": "2024-11-26T17:30:19.2081773-05:00",
    "RequestData": "sample string 10"
  },
  {
    "ExceptionLogId": 1,
    "Application": "sample string 2",
    "MethodName": "sample string 3",
    "Message": "sample string 4",
    "StackTrace": "sample string 5",
    "Severity": 6,
    "Server": "sample string 7",
    "UserName": "sample string 8",
    "CreatedDate": "2024-11-26T17:30:19.2081773-05:00",
    "RequestData": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfExceptionLogEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports">
  <ExceptionLogEntry>
    <Application>sample string 2</Application>
    <CreatedDate>2024-11-26T17:30:19.2081773-05:00</CreatedDate>
    <ExceptionLogId>1</ExceptionLogId>
    <Message>sample string 4</Message>
    <MethodName>sample string 3</MethodName>
    <RequestData>sample string 10</RequestData>
    <Server>sample string 7</Server>
    <Severity>6</Severity>
    <StackTrace>sample string 5</StackTrace>
    <UserName>sample string 8</UserName>
  </ExceptionLogEntry>
  <ExceptionLogEntry>
    <Application>sample string 2</Application>
    <CreatedDate>2024-11-26T17:30:19.2081773-05:00</CreatedDate>
    <ExceptionLogId>1</ExceptionLogId>
    <Message>sample string 4</Message>
    <MethodName>sample string 3</MethodName>
    <RequestData>sample string 10</RequestData>
    <Server>sample string 7</Server>
    <Severity>6</Severity>
    <StackTrace>sample string 5</StackTrace>
    <UserName>sample string 8</UserName>
  </ExceptionLogEntry>
</ArrayOfExceptionLogEntry>