POST api/SmartRegistry/Reports/RequestLogs

Performs a request log search based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

ESignSystems.SmartSAFE.Models.SmartRegistry.RequestLogSearchCriteria
NameDescriptionTypeAdditional information
TransactionType

Gets or sets the TransactionType to search by.

string

None.

RequestType

Gets or sets the RequestType to search by.

string

None.

ResponseStatusCode

Gets or sets the ResponseStatusCode to search by.

string

None.

Error

Gets or sets the Error to search by.

boolean

None.

StartRequestDate

Gets or sets the StartRequestDate to search by.

date

Required

EndRequestDate

Gets or sets the EndRequestDate to search by.

date

Required

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:
{
  "TransactionType": "sample string 1",
  "RequestType": "sample string 2",
  "ResponseStatusCode": "sample string 3",
  "Error": true,
  "StartRequestDate": "2024-11-26T17:28:19.6120727-05:00",
  "EndRequestDate": "2024-11-26T17:28:19.6120727-05:00",
  "PageSize": 1,
  "PageOffset": 4
}

application/xml, text/xml

Sample:
<RequestLogSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">4</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <EndRequestDate>2024-11-26T17:28:19.6120727-05:00</EndRequestDate>
  <Error>true</Error>
  <RequestType>sample string 2</RequestType>
  <ResponseStatusCode>sample string 3</ResponseStatusCode>
  <StartRequestDate>2024-11-26T17:28:19.6120727-05:00</StartRequestDate>
  <TransactionType>sample string 1</TransactionType>
</RequestLogSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of request logs meeting the search criteria.

Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.RequestLogModel
NameDescriptionTypeAdditional information
ERegistryRequestLogId

Gets or set the request log identifier

integer

Required

TransactionType

Gets or sets the transaction type of the request

string

None.

RequestType

Gets or set the request type

string

None.

RequestDate

Gets or sets the date the request was made

date

None.

RequestData

Gets or sets the XML of the request

string

None.

ResponseData

Gets or sets the XML of the response

string

None.

ResponseStatusCode

Gets or sets the status code of the response

string

None.

ServiceUrl

Gets or sets the URL the request was sent to

string

None.

Error

Gets or sets whether or not an error occurred in the request

boolean

None.

ErrorMessage

Gets or sets the message of the error

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ERegistryRequestLogId": 1,
    "TransactionType": "sample string 1",
    "RequestType": "sample string 2",
    "RequestDate": "2024-11-26T17:28:19.6120727-05:00",
    "RequestData": "sample string 4",
    "ResponseData": "sample string 5",
    "ResponseStatusCode": "sample string 6",
    "ServiceUrl": "sample string 7",
    "Error": true,
    "ErrorMessage": "sample string 9"
  },
  {
    "ERegistryRequestLogId": 1,
    "TransactionType": "sample string 1",
    "RequestType": "sample string 2",
    "RequestDate": "2024-11-26T17:28:19.6120727-05:00",
    "RequestData": "sample string 4",
    "ResponseData": "sample string 5",
    "ResponseStatusCode": "sample string 6",
    "ServiceUrl": "sample string 7",
    "Error": true,
    "ErrorMessage": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRequestLogModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <RequestLogModel>
    <ERegistryRequestLogId>1</ERegistryRequestLogId>
    <Error>true</Error>
    <ErrorMessage>sample string 9</ErrorMessage>
    <RequestData>sample string 4</RequestData>
    <RequestDate>2024-11-26T17:28:19.6120727-05:00</RequestDate>
    <RequestType>sample string 2</RequestType>
    <ResponseData>sample string 5</ResponseData>
    <ResponseStatusCode>sample string 6</ResponseStatusCode>
    <ServiceUrl>sample string 7</ServiceUrl>
    <TransactionType>sample string 1</TransactionType>
  </RequestLogModel>
  <RequestLogModel>
    <ERegistryRequestLogId>1</ERegistryRequestLogId>
    <Error>true</Error>
    <ErrorMessage>sample string 9</ErrorMessage>
    <RequestData>sample string 4</RequestData>
    <RequestDate>2024-11-26T17:28:19.6120727-05:00</RequestDate>
    <RequestType>sample string 2</RequestType>
    <ResponseData>sample string 5</ResponseData>
    <ResponseStatusCode>sample string 6</ResponseStatusCode>
    <ServiceUrl>sample string 7</ServiceUrl>
    <TransactionType>sample string 1</TransactionType>
  </RequestLogModel>
</ArrayOfRequestLogModel>