GET api/communications/sent/dates/{initialDate}/{finalDate}

Returns communications sent between two given dates.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
initialDate

Initial date.

date

Required

finalDate

Final date.

date

Required

Body Parameters

None.

Response Information

Resource Description

List of communications.

Collection of Communication
NameDescriptionTypeAdditional information
Id

Communication identifier.

integer

None.

IdParent

Parent communication identifier.

integer

None.

CreationDate

Date and time when the communication was created.

date

None.

SentDate

Date and time when the communication was sent.

date

None.

ReadDate

Date and time when the communication was read.

date

None.

IdState

Current state of the communication.

TalkState

None.

StateDate

Date and time of the current communication state.

date

None.

UserFrom

Sender user email address.

string

None.

IdUserFrom

Sender user identifier.

integer

None.

IdRecipientType

Type of recipient address.

RecipientTypeId

None.

UserTo

Recipient user email address or phone number.

string

None.

IdUserTo

Recipient user identifier.

integer

None.

Subject

Subject of the communication.

string

None.

Text

Text of the communication.

string

None.

IdTalkModel

Model of communication.

TalkModels

None.

Language

Language used for notifications.

string

None.

UserReferenceId

User-provided reference identifier.

string

None.

CertificateCode

Code of the comunication request certificate.

string

None.

AccessCertificateCode

Code of the access certificate.

string

None.

ContractCertificateCode

Code of the contract signature certificate.

string

None.

EmailCertificateCode

Code of the email delivery certificate.

string

None.

DownloadCertificateCode

Code of the download certificate.

string

None.

ReadCertificateCode

Code of the read certificate.

string

None.

NonDeliveryReason

Email non-delivery reason.

string

None.

EmailErrorCode

Type of email delivery error.

EmailErrorType

None.

RejectionReason

Rejection reason provided by the signer.

string

None.

CompletionNote

Note indicating the reason of the talk completion.

string

None.

ChildTalks

Child communication objects.

Collection of Communication

None.

Documents

Document objects.

Collection of Document

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "IdParent": 1,
    "CreationDate": "2021-06-14T19:09:57.883748+02:00",
    "SentDate": "2021-06-14T19:09:57.883748+02:00",
    "ReadDate": "2021-06-14T19:09:57.883748+02:00",
    "IdState": "Processing",
    "StateDate": "2021-06-14T19:09:57.883748+02:00",
    "UserFrom": "sample string 5",
    "IdUserFrom": 6,
    "IdRecipientType": "To",
    "UserTo": "sample string 7",
    "IdUserTo": 1,
    "Subject": "sample string 8",
    "Text": "sample string 9",
    "IdTalkModel": "None",
    "Language": "sample string 10",
    "UserReferenceId": "sample string 11",
    "CertificateCode": "sample string 12",
    "AccessCertificateCode": "sample string 13",
    "ContractCertificateCode": "sample string 14",
    "EmailCertificateCode": "sample string 15",
    "DownloadCertificateCode": "sample string 16",
    "ReadCertificateCode": "sample string 17",
    "NonDeliveryReason": "sample string 18",
    "EmailErrorCode": "None",
    "RejectionReason": "sample string 19",
    "CompletionNote": "sample string 20",
    "ChildTalks": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ],
    "Documents": [
      {
        "$id": "2",
        "Id": 1,
        "IdTalk": 2,
        "IdOwner": 3,
        "FileName": "sample string 4",
        "Size": 5,
        "PartsNumber": 6,
        "Hash": "sample string 7"
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCommunication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PuntoNeutro.WebApi.Models">
  <Communication z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <AccessCertificateCode>sample string 13</AccessCertificateCode>
    <CertificateCode>sample string 12</CertificateCode>
    <ChildTalks>
      <Communication z:Ref="i1" />
      <Communication z:Ref="i1" />
    </ChildTalks>
    <CompletionNote>sample string 20</CompletionNote>
    <ContractCertificateCode>sample string 14</ContractCertificateCode>
    <CreationDate>2021-06-14T19:09:57.883748+02:00</CreationDate>
    <Documents>
      <Document>
        <FileName>sample string 4</FileName>
        <Hash>sample string 7</Hash>
        <Id>1</Id>
        <IdOwner>3</IdOwner>
        <IdTalk>2</IdTalk>
        <PartsNumber>6</PartsNumber>
        <Size>5</Size>
      </Document>
      <Document>
        <FileName>sample string 4</FileName>
        <Hash>sample string 7</Hash>
        <Id>1</Id>
        <IdOwner>3</IdOwner>
        <IdTalk>2</IdTalk>
        <PartsNumber>6</PartsNumber>
        <Size>5</Size>
      </Document>
    </Documents>
    <DownloadCertificateCode>sample string 16</DownloadCertificateCode>
    <EmailCertificateCode>sample string 15</EmailCertificateCode>
    <EmailErrorCode>None</EmailErrorCode>
    <Id>1</Id>
    <IdParent>1</IdParent>
    <IdRecipientType>To</IdRecipientType>
    <IdState>Processing</IdState>
    <IdTalkModel>None</IdTalkModel>
    <IdUserFrom>6</IdUserFrom>
    <IdUserTo>1</IdUserTo>
    <Language>sample string 10</Language>
    <NonDeliveryReason>sample string 18</NonDeliveryReason>
    <ReadCertificateCode>sample string 17</ReadCertificateCode>
    <ReadDate>2021-06-14T19:09:57.883748+02:00</ReadDate>
    <RejectionReason>sample string 19</RejectionReason>
    <SentDate>2021-06-14T19:09:57.883748+02:00</SentDate>
    <StateDate>2021-06-14T19:09:57.883748+02:00</StateDate>
    <Subject>sample string 8</Subject>
    <Text>sample string 9</Text>
    <UserFrom>sample string 5</UserFrom>
    <UserReferenceId>sample string 11</UserReferenceId>
    <UserTo>sample string 7</UserTo>
  </Communication>
  <Communication z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />
</ArrayOfCommunication>