POST api/Reports/WebServiceLog

Allows a SAFEAdmin to search for web service logs.

Request Information

URI Parameters

None.

Body Parameters

The web service log search criteria.

ESignSystems.SmartSAFE.Models.Logging.WebServiceLogSearchCriteria

Name	Description	Type	Additional information
OrganizationId	Gets or sets property to search by organization identifier.	integer	None.
ClientId	Gets or sets property to search by client identifier.	integer	None.
SigningRoomName	Gets or sets property to search by SigningRoom name.	string	Max length: 256
ControllerName	Gets or sets property to search by controller name.	string	Max length: 256
Route	Gets or sets property to search by the service route.	string	Max length: 256
Server	Gets or sets the property for searching the server.	string	Max length: 256
StartDate	Gets or sets property to search for web service calls created on or after the given date.	date	Required
EndDate	Gets or sets property to search for web service calls created before the given date.	date	Required
Success	Gets or sets a property to search by whether or not the web service call was successful.	boolean	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:

{
  "OrganizationId": 1,
  "ClientId": 1,
  "SigningRoomName": "sample string 1",
  "ControllerName": "sample string 2",
  "Route": "sample string 3",
  "Server": "sample string 4",
  "StartDate": "2024-11-26T17:28:13.0962765-05:00",
  "EndDate": "2024-11-26T17:28:13.0962765-05:00",
  "Success": true,
  "PageSize": 1,
  "PageOffset": 5
}

application/xml, text/xml

Sample:

<WebServiceLogSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Logging">
  <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>
  <ClientId>1</ClientId>
  <ControllerName>sample string 2</ControllerName>
  <EndDate>2024-11-26T17:28:13.0962765-05:00</EndDate>
  <OrganizationId>1</OrganizationId>
  <Route>sample string 3</Route>
  <Server>sample string 4</Server>
  <SigningRoomName>sample string 1</SigningRoomName>
  <StartDate>2024-11-26T17:28:13.0962765-05:00</StartDate>
  <Success>true</Success>
</WebServiceLogSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of web service logs resulting from the search.

Collection of ESignSystems.SmartSAFE.Models.Logging.WebServiceLogModel

Name	Description	Type	Additional information
WebServiceLogId	Gets or sets the create web service log identifier.	integer	None.
OrganizationId	Gets or sets the organization identifier.	integer	None.
OrganizationName	Gets or sets the organization name.	string	None.
ClientId	Gets or sets the client identifier.	integer	None.
ClientName	Gets or sets the client name.	string	None.
SigningRoomId	Gets or sets the SigningRoom identifier.	integer	None.
SigningRoomName	Gets or sets the SigningRoom name.	string	None.
UserId	Gets or sets the user identifier.	integer	None.
CreatedBy	Gets or sets the name of the user who created the SigningRoom.	string	None.
CreatedDate	Gets or sets the date and time that the SigningRoom was created.	date	None.
Success	Gets or sets a value indicating whether or not the SigningRoom was successfully created.	boolean	None.
RequestType	Gets the type of request that was made to the service.	string	None.
ParameterData	Gets or sets the parameter data.	string	None.
RequestData	Gets or sets the data representing the SigningRoom to create.	string	None.
ResponseData	Gets or sets the data representing the results of the creation.	string	None.
Route	Gets or sets the route of the web service call.	string	None.
ControllerName	Gets or sets the name of the controller that handled the web service call.	string	None.
Server	Gets or sets the server that the service call was made on.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "WebServiceLogId": 1,
    "OrganizationId": 1,
    "OrganizationName": "sample string 1",
    "ClientId": 1,
    "ClientName": "sample string 2",
    "SigningRoomId": 1,
    "SigningRoomName": "sample string 3",
    "UserId": 1,
    "CreatedBy": "sample string 4",
    "CreatedDate": "2024-11-26T17:28:13.1118983-05:00",
    "Success": true,
    "RequestType": "sample string 6",
    "ParameterData": "sample string 7",
    "RequestData": "sample string 8",
    "ResponseData": "sample string 9",
    "Route": "sample string 10",
    "ControllerName": "sample string 11",
    "Server": "sample string 12"
  },
  {
    "WebServiceLogId": 1,
    "OrganizationId": 1,
    "OrganizationName": "sample string 1",
    "ClientId": 1,
    "ClientName": "sample string 2",
    "SigningRoomId": 1,
    "SigningRoomName": "sample string 3",
    "UserId": 1,
    "CreatedBy": "sample string 4",
    "CreatedDate": "2024-11-26T17:28:13.1118983-05:00",
    "Success": true,
    "RequestType": "sample string 6",
    "ParameterData": "sample string 7",
    "RequestData": "sample string 8",
    "ResponseData": "sample string 9",
    "Route": "sample string 10",
    "ControllerName": "sample string 11",
    "Server": "sample string 12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfWebServiceLogModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Logging">
  <WebServiceLogModel>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <ControllerName>sample string 11</ControllerName>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDate>2024-11-26T17:28:13.1118983-05:00</CreatedDate>
    <OrganizationId>1</OrganizationId>
    <OrganizationName>sample string 1</OrganizationName>
    <ParameterData>sample string 7</ParameterData>
    <RequestData>sample string 8</RequestData>
    <RequestType>sample string 6</RequestType>
    <ResponseData>sample string 9</ResponseData>
    <Route>sample string 10</Route>
    <Server>sample string 12</Server>
    <SigningRoomId>1</SigningRoomId>
    <SigningRoomName>sample string 3</SigningRoomName>
    <Success>true</Success>
    <UserId>1</UserId>
    <WebServiceLogId>1</WebServiceLogId>
  </WebServiceLogModel>
  <WebServiceLogModel>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <ControllerName>sample string 11</ControllerName>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDate>2024-11-26T17:28:13.1118983-05:00</CreatedDate>
    <OrganizationId>1</OrganizationId>
    <OrganizationName>sample string 1</OrganizationName>
    <ParameterData>sample string 7</ParameterData>
    <RequestData>sample string 8</RequestData>
    <RequestType>sample string 6</RequestType>
    <ResponseData>sample string 9</ResponseData>
    <Route>sample string 10</Route>
    <Server>sample string 12</Server>
    <SigningRoomId>1</SigningRoomId>
    <SigningRoomName>sample string 3</SigningRoomName>
    <Success>true</Success>
    <UserId>1</UserId>
    <WebServiceLogId>1</WebServiceLogId>
  </WebServiceLogModel>
</ArrayOfWebServiceLogModel>