GET api/contracts/{id}

Returns information about a contract.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Communication identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Contract information.

Contract
NameDescriptionTypeAdditional information
Id

Contract identifier.

integer

None.

IdTalk

Communication identifier.

integer

None.

IdUserFrom

Sender user identifier.

integer

None.

IdUserTo

Recipient user identifier.

integer

None.

PhoneNumber

Phone number associated with the contract.

string

None.

Date

Date and time of the contract.

date

None.

SignatureDate

Date and time of the signature.

date

None.

UrlContractAccepted

URL to be redirected when the contract is accepted.

string

None.

UrlContractRefused

URL to be redirected when the contract is refused.

string

None.

UrlCallbackContractAccepted

Callback URL to be called when the contract is accepted.

string

None.

UrlCallbackContractRefused

Callback URL to be called when the contract is refused.

string

None.

Communication

Communication object.

Communication

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "IdTalk": 2,
  "IdUserFrom": 3,
  "IdUserTo": 4,
  "PhoneNumber": "sample string 5",
  "Date": "2021-06-14T20:47:24.6821916+02:00",
  "SignatureDate": "2021-06-14T20:47:24.6821916+02:00",
  "UrlContractAccepted": "sample string 7",
  "UrlContractRefused": "sample string 8",
  "UrlCallbackContractAccepted": "sample string 9",
  "UrlCallbackContractRefused": "sample string 10",
  "Communication": {
    "$id": "2",
    "Id": 1,
    "IdParent": 1,
    "CreationDate": "2021-06-14T20:47:24.6821916+02:00",
    "SentDate": "2021-06-14T20:47:24.6821916+02:00",
    "ReadDate": "2021-06-14T20:47:24.6821916+02:00",
    "IdState": "Processing",
    "StateDate": "2021-06-14T20:47:24.6821916+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": "2"
      },
      {
        "$ref": "2"
      }
    ],
    "Documents": [
      {
        "$id": "3",
        "Id": 1,
        "IdTalk": 2,
        "IdOwner": 3,
        "FileName": "sample string 4",
        "Size": 5,
        "PartsNumber": 6,
        "Hash": "sample string 7"
      },
      {
        "$ref": "3"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<Contract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://schemas.datacontract.org/2004/07/PuntoNeutro.WebApi.Models">
  <Communication z:Id="i2">
    <AccessCertificateCode>sample string 13</AccessCertificateCode>
    <CertificateCode>sample string 12</CertificateCode>
    <ChildTalks>
      <Communication z:Ref="i2" />
      <Communication z:Ref="i2" />
    </ChildTalks>
    <CompletionNote>sample string 20</CompletionNote>
    <ContractCertificateCode>sample string 14</ContractCertificateCode>
    <CreationDate>2021-06-14T20:47:24.6821916+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-14T20:47:24.6821916+02:00</ReadDate>
    <RejectionReason>sample string 19</RejectionReason>
    <SentDate>2021-06-14T20:47:24.6821916+02:00</SentDate>
    <StateDate>2021-06-14T20:47:24.6821916+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>
  <Date>2021-06-14T20:47:24.6821916+02:00</Date>
  <Id>1</Id>
  <IdTalk>2</IdTalk>
  <IdUserFrom>3</IdUserFrom>
  <IdUserTo>4</IdUserTo>
  <PhoneNumber>sample string 5</PhoneNumber>
  <SignatureDate>2021-06-14T20:47:24.6821916+02:00</SignatureDate>
  <UrlCallbackContractAccepted>sample string 9</UrlCallbackContractAccepted>
  <UrlCallbackContractRefused>sample string 10</UrlCallbackContractRefused>
  <UrlContractAccepted>sample string 7</UrlContractAccepted>
  <UrlContractRefused>sample string 8</UrlContractRefused>
</Contract>