POST api/Reports/ClientToClientTransferLogSearch

Allows a user to search for client to client transfer logs.

Request Information

URI Parameters

None.

Body Parameters

The client to client transfer log search criteria

ESignSystems.SmartSAFE.Models.Reports.ClientToClientTransferLogSearchCriteria

Name	Description	Type	Additional information
SendingClientId	Gets or sets the sending client identifier.	integer	None.
ReceivingClientId	Gets or sets the receiving client identifier.	integer	None.
ClientToClientTransferStatusTypeId	Gets or sets property to search by client to client transfer status type identifier.	integer	None.
StartDate	Gets or sets property to search for the client to client transfer logs performed after the given date.	date	Required
EndDate	Gets or sets property to search for the client to client transfer logs performed before the given date.	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:

{
  "SendingClientId": 1,
  "ReceivingClientId": 1,
  "ClientToClientTransferStatusTypeId": 1,
  "StartDate": "2024-11-26T16:41:28.902396-05:00",
  "EndDate": "2024-11-26T16:41:28.902396-05:00",
  "PageSize": 1,
  "PageOffset": 1
}

application/xml, text/xml

Sample:

<ClientToClientTransferLogSearchCriteria 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">1</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientToClientTransferStatusTypeId>1</ClientToClientTransferStatusTypeId>
  <EndDate>2024-11-26T16:41:28.902396-05:00</EndDate>
  <ReceivingClientId>1</ReceivingClientId>
  <SendingClientId>1</SendingClientId>
  <StartDate>2024-11-26T16:41:28.902396-05:00</StartDate>
</ClientToClientTransferLogSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of client to client transfer logs resulting from the search.

Collection of ESignSystems.SmartSAFE.Models.Reports.ClientToClientTransferLogModel

Name	Description	Type	Additional information
ClientToClientTransferLogId	The client to client transfer log identifier.	integer	None.
SendingClientName	Gets or sets the sending client's name.	string	None.
ReceivingClientName	Gets or sets the receiving client's name.	string	None.
Status	Gets or sets the status of the upload.	string	None.
StartTime	Gets or sets the start time of the transfer.	date	None.
EndTime	Gets or sets the end time of the transfer.	date	None.
DocumentGuid	Gets or sets the response log document GUID.	string	None.
UpdatedBy	Gets or sets the name of the user that updated the model.	string	None.
UpdatedDate	Gets or sets the date an time that the model was updated.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientToClientTransferLogId": 1,
    "SendingClientName": "sample string 2",
    "ReceivingClientName": "sample string 3",
    "Status": "sample string 4",
    "StartTime": "2024-11-26T16:41:28.9179702-05:00",
    "EndTime": "2024-11-26T16:41:28.9179702-05:00",
    "DocumentGuid": "sample string 5",
    "UpdatedBy": "sample string 6",
    "UpdatedDate": "2024-11-26T16:41:28.9179702-05:00"
  },
  {
    "ClientToClientTransferLogId": 1,
    "SendingClientName": "sample string 2",
    "ReceivingClientName": "sample string 3",
    "Status": "sample string 4",
    "StartTime": "2024-11-26T16:41:28.9179702-05:00",
    "EndTime": "2024-11-26T16:41:28.9179702-05:00",
    "DocumentGuid": "sample string 5",
    "UpdatedBy": "sample string 6",
    "UpdatedDate": "2024-11-26T16:41:28.9179702-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientToClientTransferLogModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports">
  <ClientToClientTransferLogModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 6</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T16:41:28.9179702-05:00</UpdatedDate>
    <ClientToClientTransferLogId>1</ClientToClientTransferLogId>
    <DocumentGuid>sample string 5</DocumentGuid>
    <EndTime>2024-11-26T16:41:28.9179702-05:00</EndTime>
    <ReceivingClientName>sample string 3</ReceivingClientName>
    <SendingClientName>sample string 2</SendingClientName>
    <StartTime>2024-11-26T16:41:28.9179702-05:00</StartTime>
    <Status>sample string 4</Status>
  </ClientToClientTransferLogModel>
  <ClientToClientTransferLogModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 6</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T16:41:28.9179702-05:00</UpdatedDate>
    <ClientToClientTransferLogId>1</ClientToClientTransferLogId>
    <DocumentGuid>sample string 5</DocumentGuid>
    <EndTime>2024-11-26T16:41:28.9179702-05:00</EndTime>
    <ReceivingClientName>sample string 3</ReceivingClientName>
    <SendingClientName>sample string 2</SendingClientName>
    <StartTime>2024-11-26T16:41:28.9179702-05:00</StartTime>
    <Status>sample string 4</Status>
  </ClientToClientTransferLogModel>
</ArrayOfClientToClientTransferLogModel>