GET api/communications/userReference/{userReference}/info

Returns information about a communication, including sender, recipients and documents, from the authenticated user that matches a user reference id.

Request Information

URI Parameters

Name	Description	Type	Additional information
userReference	User reference.	string	Required

Body Parameters

None.

Response Information

Resource Description

An object containing the result of the operation.

TalkInfo

Name	Description	Type	Additional information
Recipients	Recipients of a communication.	Collection of RecipientInfo	None.
Documents	Documents in a communication.	Collection of DocumentInfo	None.
TalkId	Talk identifier.	integer	None.
CreationDate	Date and time the communication was created.	date	None.
StateDate	Date and time of the last state of the communication.	date	None.
SentDate	Date and time the communication was sent.	date	None.
TalkState	State of the talk.	TalkState	None.
TalkModel	Type of communication.	TalkModels	None.
TalkModelFamily	Family to which the talk model belongs.	TalkModelFamily	None.
SenderAddress	Email address of the sender.	string	None.
SenderName	Name of the sender.	string	None.
TalkUrl	URL of the talk.	string	None.
CommunicationRequestCertificateUrl	URL to view the communication request certificate.	string	None.
ComplianceCertificateUrl	URL to view the compliance certificate.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Recipients": [
    {
      "$id": "2",
      "TalkId": 1,
      "StateDate": "2024-12-03T13:37:33.9406665+01:00",
      "RecipientAddress": "sample string 3",
      "RecipientName": "sample string 4",
      "TalkState": "Processing",
      "TalkUrl": "sample string 5",
      "AcceptanceCertificateUrl": "sample string 6",
      "ContractCertificateUrl": "sample string 7",
      "EmailCertificateUrl": "sample string 8",
      "AccessCertificateUrl": "sample string 9",
      "DownloadCertificateUrl": "sample string 10",
      "ReadCertificateUrl": "sample string 11"
    },
    {
      "$ref": "2"
    }
  ],
  "Documents": [
    {
      "$id": "3",
      "DocumentId": 1,
      "DocumentName": "sample string 2",
      "DocumentSize": 3,
      "DocumentHash": "sample string 4",
      "DownloadUrl": "sample string 5",
      "DocumentState": "NotComplete"
    },
    {
      "$ref": "3"
    }
  ],
  "TalkId": 1,
  "CreationDate": "2024-12-03T13:37:33.9406665+01:00",
  "StateDate": "2024-12-03T13:37:33.9406665+01:00",
  "SentDate": "2024-12-03T13:37:33.9406665+01:00",
  "TalkState": "Processing",
  "TalkModel": "None",
  "TalkModelFamily": "None",
  "SenderAddress": "sample string 5",
  "SenderName": "sample string 6",
  "TalkUrl": "sample string 7",
  "CommunicationRequestCertificateUrl": "sample string 8",
  "ComplianceCertificateUrl": "sample string 9"
}

application/xml, text/xml

Sample:

<TalkInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PuntoNeutro.Core.Talks">
  <CommunicationRequestCertificateUrl>sample string 8</CommunicationRequestCertificateUrl>
  <ComplianceCertificateUrl>sample string 9</ComplianceCertificateUrl>
  <CreationDate>2024-12-03T13:37:33.9406665+01:00</CreationDate>
  <Documents>
    <DocumentInfo>
      <DocumentHash>sample string 4</DocumentHash>
      <DocumentId>1</DocumentId>
      <DocumentName>sample string 2</DocumentName>
      <DocumentSize>3</DocumentSize>
      <DocumentState>NotComplete</DocumentState>
      <DownloadUrl>sample string 5</DownloadUrl>
    </DocumentInfo>
    <DocumentInfo>
      <DocumentHash>sample string 4</DocumentHash>
      <DocumentId>1</DocumentId>
      <DocumentName>sample string 2</DocumentName>
      <DocumentSize>3</DocumentSize>
      <DocumentState>NotComplete</DocumentState>
      <DownloadUrl>sample string 5</DownloadUrl>
    </DocumentInfo>
  </Documents>
  <Recipients>
    <RecipientInfo>
      <AcceptanceCertificateUrl>sample string 6</AcceptanceCertificateUrl>
      <AccessCertificateUrl>sample string 9</AccessCertificateUrl>
      <ContractCertificateUrl>sample string 7</ContractCertificateUrl>
      <DownloadCertificateUrl>sample string 10</DownloadCertificateUrl>
      <EmailCertificateUrl>sample string 8</EmailCertificateUrl>
      <ReadCertificateUrl>sample string 11</ReadCertificateUrl>
      <RecipientAddress>sample string 3</RecipientAddress>
      <RecipientName>sample string 4</RecipientName>
      <StateDate>2024-12-03T13:37:33.9406665+01:00</StateDate>
      <TalkId>1</TalkId>
      <TalkState>Processing</TalkState>
      <TalkUrl>sample string 5</TalkUrl>
    </RecipientInfo>
    <RecipientInfo>
      <AcceptanceCertificateUrl>sample string 6</AcceptanceCertificateUrl>
      <AccessCertificateUrl>sample string 9</AccessCertificateUrl>
      <ContractCertificateUrl>sample string 7</ContractCertificateUrl>
      <DownloadCertificateUrl>sample string 10</DownloadCertificateUrl>
      <EmailCertificateUrl>sample string 8</EmailCertificateUrl>
      <ReadCertificateUrl>sample string 11</ReadCertificateUrl>
      <RecipientAddress>sample string 3</RecipientAddress>
      <RecipientName>sample string 4</RecipientName>
      <StateDate>2024-12-03T13:37:33.9406665+01:00</StateDate>
      <TalkId>1</TalkId>
      <TalkState>Processing</TalkState>
      <TalkUrl>sample string 5</TalkUrl>
    </RecipientInfo>
  </Recipients>
  <SenderAddress>sample string 5</SenderAddress>
  <SenderName>sample string 6</SenderName>
  <SentDate>2024-12-03T13:37:33.9406665+01:00</SentDate>
  <StateDate>2024-12-03T13:37:33.9406665+01:00</StateDate>
  <TalkId>1</TalkId>
  <TalkModel>None</TalkModel>
  <TalkModelFamily>None</TalkModelFamily>
  <TalkState>Processing</TalkState>
  <TalkUrl>sample string 7</TalkUrl>
</TalkInfo>