POST api/contracts

Creates a contract.

Request Information

URI Parameters

None.

Body Parameters

Information needed to create the contract.

ContractData
NameDescriptionTypeAdditional information
TalkModel

Talk model of the contract.

 TalkModels

None.
ContractTemplate

Optional template for the new contract.

 ContractTemplate

None.
Subject

Optional subject if a template was not defined.

 string

None.
Body

Obtional body if a template was not defined.

 string

None.
Clauses

List of contract clauses that substitutes the body.

 Collection of ContractClauseData

None.
UserFrom

Sender of the contract.

 string

None.
UserTo

Recipients of the contract.

 Collection of string

None.
RecipientData

Recipient data.

 Collection of RecipientData

None.
IP

IP address of the user.

 string

None.
Hostname

Machine name of the user.

 string

None.
Language

Language.

 string

None.
SendMail

Send email

 boolean

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.
Attachments

List of attachments of the contract.

 Collection of Attachment

None.
SmsNotification

Send a SMS notifying the recipient.

 boolean

None.
SmsSignature

A PIN code sent via SMS is required to sign the contract.

 boolean

None.
IdSignatureType

Signature type.

 SignatureTypeId

None.
SenderSignatureLocation

Location of the sender's signature.

 PdfPageRectangle

None.
UserReferenceId

User reference.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "TalkModel": "None",
  "ContractTemplate": "None",
  "Subject": "sample string 1",
  "Body": "sample string 2",
  "Clauses": [
    {
      "$id": "2",
      "Title": "sample string 1",
      "ClauseText": "sample string 2",
      "AcceptanceDescription": "sample string 3"
    },
    {
      "$ref": "2"
    }
  ],
  "UserFrom": "sample string 3",
  "UserTo": [
    "sample string 1",
    "sample string 2"
  ],
  "RecipientData": [
    {
      "$id": "3",
      "RecipientName": "sample string 1",
      "RecipientEmail": "sample string 2",
      "RecipientPhoneNumber": "sample string 3",
      "RecipientTypeId": "To",
      "RecipientLanguage": "sample string 4",
      "RecipientSignatureLocation": {
        "$id": "4",
        "Page": 1,
        "Left": 2.1,
        "Top": 3.1,
        "Right": 4.1,
        "Bottom": 5.1
      },
      "RecipientPostalAddress": "sample string 5",
      "RecipientPostalCode": "sample string 6",
      "RecipientCity": "sample string 7",
      "RecipientProvince": "sample string 8",
      "RecipientCountryId": "sample string 9",
      "RecipientIdentityNumber": "sample string 10",
      "RecipientObservations": "sample string 11",
      "RecipientOthers": "sample string 12",
      "RecipientContentCertificate": true
    },
    {
      "$ref": "3"
    }
  ],
  "IP": "sample string 4",
  "Hostname": "sample string 5",
  "Language": "sample string 6",
  "SendMail": true,
  "UrlContractAccepted": "sample string 8",
  "UrlContractRefused": "sample string 9",
  "UrlCallbackContractAccepted": "sample string 10",
  "UrlCallbackContractRefused": "sample string 11",
  "Attachments": [
    {
      "$id": "5",
      "FileId": 1,
      "FileName": "sample string 1",
      "FileSize": 2,
      "Hash": "sample string 3",
      "MetaData": {
        "$id": "6",
        "Title": "sample string 1",
        "Author": "sample string 2",
        "Subject": "sample string 3",
        "Keywords": "sample string 4",
        "Creator": "sample string 5",
        "Producer": "sample string 6",
        "CreationDate": "2025-08-30T03:44:03.0179465+02:00",
        "ModifiedDate": "2025-08-30T03:44:03.0179465+02:00",
        "PageCount": 1,
        "Screenshot": "QEA=",
        "Width": "sample string 7",
        "Height": "sample string 8",
        "Depth": "sample string 9",
        "Description": "sample string 10",
        "GPSLatitude": "sample string 11",
        "GPSLatitudeRef": "sample string 12",
        "GPSLongitude": "sample string 13",
        "GPSLongitudeRef": "sample string 14",
        "FNumber": "sample string 15",
        "ExposureTime": "sample string 16",
        "ISOSpeed": "sample string 17",
        "Make": "sample string 18",
        "Model": "sample string 19",
        "DateTimeDigitized": "2025-08-30T03:44:03.0179465+02:00"
      }
    },
    {
      "$ref": "5"
    }
  ],
  "SmsNotification": true,
  "SmsSignature": true,
  "IdSignatureType": "None",
  "SenderSignatureLocation": {
    "$ref": "4"
  },
  "UserReferenceId": "sample string 14"
}

application/xml, text/xml

Sample: 
<ContractData 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.Core">
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/PuntoNeutro.Core.Talks">
    <d2p1:Attachment z:Id="i2">
      <d2p1:FileId>1</d2p1:FileId>
      <d2p1:FileName>sample string 1</d2p1:FileName>
      <d2p1:FileSize>2</d2p1:FileSize>
      <d2p1:Hash>sample string 3</d2p1:Hash>
      <d2p1:MetaData z:Id="i3">
        <d2p1:Author>sample string 2</d2p1:Author>
        <d2p1:CreationDate>2025-08-30T03:44:03.0179465+02:00</d2p1:CreationDate>
        <d2p1:Creator>sample string 5</d2p1:Creator>
        <d2p1:DateTimeDigitized>2025-08-30T03:44:03.0179465+02:00</d2p1:DateTimeDigitized>
        <d2p1:Depth>sample string 9</d2p1:Depth>
        <d2p1:Description>sample string 10</d2p1:Description>
        <d2p1:ExposureTime>sample string 16</d2p1:ExposureTime>
        <d2p1:FNumber>sample string 15</d2p1:FNumber>
        <d2p1:GPSLatitude>sample string 11</d2p1:GPSLatitude>
        <d2p1:GPSLatitudeRef>sample string 12</d2p1:GPSLatitudeRef>
        <d2p1:GPSLongitude>sample string 13</d2p1:GPSLongitude>
        <d2p1:GPSLongitudeRef>sample string 14</d2p1:GPSLongitudeRef>
        <d2p1:Height>sample string 8</d2p1:Height>
        <d2p1:ISOSpeed>sample string 17</d2p1:ISOSpeed>
        <d2p1:Keywords>sample string 4</d2p1:Keywords>
        <d2p1:Make>sample string 18</d2p1:Make>
        <d2p1:Model>sample string 19</d2p1:Model>
        <d2p1:ModifiedDate>2025-08-30T03:44:03.0179465+02:00</d2p1:ModifiedDate>
        <d2p1:PageCount>1</d2p1:PageCount>
        <d2p1:Producer>sample string 6</d2p1:Producer>
        <d2p1:Screenshot>QEA=</d2p1:Screenshot>
        <d2p1:Subject>sample string 3</d2p1:Subject>
        <d2p1:Title>sample string 1</d2p1:Title>
        <d2p1:Width>sample string 7</d2p1:Width>
      </d2p1:MetaData>
    </d2p1:Attachment>
    <d2p1:Attachment z:Ref="i2" />
  </Attachments>
  <Body>sample string 2</Body>
  <Clauses>
    <ContractClauseData z:Id="i4">
      <AcceptanceDescription>sample string 3</AcceptanceDescription>
      <ClauseText>sample string 2</ClauseText>
      <Title>sample string 1</Title>
    </ContractClauseData>
    <ContractClauseData z:Ref="i4" />
  </Clauses>
  <ContractTemplate>None</ContractTemplate>
  <Hostname>sample string 5</Hostname>
  <IP>sample string 4</IP>
  <IdSignatureType>None</IdSignatureType>
  <Language>sample string 6</Language>
  <RecipientData xmlns:d2p1="http://schemas.datacontract.org/2004/07/PuntoNeutro.Core.Talks">
    <d2p1:RecipientData>
      <d2p1:RecipientCity>sample string 7</d2p1:RecipientCity>
      <d2p1:RecipientContentCertificate>true</d2p1:RecipientContentCertificate>
      <d2p1:RecipientCountryId>sample string 9</d2p1:RecipientCountryId>
      <d2p1:RecipientEmail>sample string 2</d2p1:RecipientEmail>
      <d2p1:RecipientIdentityNumber>sample string 10</d2p1:RecipientIdentityNumber>
      <d2p1:RecipientLanguage>sample string 4</d2p1:RecipientLanguage>
      <d2p1:RecipientName>sample string 1</d2p1:RecipientName>
      <d2p1:RecipientObservations>sample string 11</d2p1:RecipientObservations>
      <d2p1:RecipientOthers>sample string 12</d2p1:RecipientOthers>
      <d2p1:RecipientPhoneNumber>sample string 3</d2p1:RecipientPhoneNumber>
      <d2p1:RecipientPostalAddress>sample string 5</d2p1:RecipientPostalAddress>
      <d2p1:RecipientPostalCode>sample string 6</d2p1:RecipientPostalCode>
      <d2p1:RecipientProvince>sample string 8</d2p1:RecipientProvince>
      <d2p1:RecipientSignatureLocation>
        <d2p1:Bottom>5.1</d2p1:Bottom>
        <d2p1:Left>2.1</d2p1:Left>
        <d2p1:Page>1</d2p1:Page>
        <d2p1:Right>4.1</d2p1:Right>
        <d2p1:Top>3.1</d2p1:Top>
      </d2p1:RecipientSignatureLocation>
      <d2p1:RecipientTypeId>To</d2p1:RecipientTypeId>
    </d2p1:RecipientData>
    <d2p1:RecipientData>
      <d2p1:RecipientCity>sample string 7</d2p1:RecipientCity>
      <d2p1:RecipientContentCertificate>true</d2p1:RecipientContentCertificate>
      <d2p1:RecipientCountryId>sample string 9</d2p1:RecipientCountryId>
      <d2p1:RecipientEmail>sample string 2</d2p1:RecipientEmail>
      <d2p1:RecipientIdentityNumber>sample string 10</d2p1:RecipientIdentityNumber>
      <d2p1:RecipientLanguage>sample string 4</d2p1:RecipientLanguage>
      <d2p1:RecipientName>sample string 1</d2p1:RecipientName>
      <d2p1:RecipientObservations>sample string 11</d2p1:RecipientObservations>
      <d2p1:RecipientOthers>sample string 12</d2p1:RecipientOthers>
      <d2p1:RecipientPhoneNumber>sample string 3</d2p1:RecipientPhoneNumber>
      <d2p1:RecipientPostalAddress>sample string 5</d2p1:RecipientPostalAddress>
      <d2p1:RecipientPostalCode>sample string 6</d2p1:RecipientPostalCode>
      <d2p1:RecipientProvince>sample string 8</d2p1:RecipientProvince>
      <d2p1:RecipientSignatureLocation>
        <d2p1:Bottom>5.1</d2p1:Bottom>
        <d2p1:Left>2.1</d2p1:Left>
        <d2p1:Page>1</d2p1:Page>
        <d2p1:Right>4.1</d2p1:Right>
        <d2p1:Top>3.1</d2p1:Top>
      </d2p1:RecipientSignatureLocation>
      <d2p1:RecipientTypeId>To</d2p1:RecipientTypeId>
    </d2p1:RecipientData>
  </RecipientData>
  <SendMail>true</SendMail>
  <SenderSignatureLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/PuntoNeutro.Core.Talks">
    <d2p1:Bottom>5.1</d2p1:Bottom>
    <d2p1:Left>2.1</d2p1:Left>
    <d2p1:Page>1</d2p1:Page>
    <d2p1:Right>4.1</d2p1:Right>
    <d2p1:Top>3.1</d2p1:Top>
  </SenderSignatureLocation>
  <SmsNotification>true</SmsNotification>
  <SmsSignature>true</SmsSignature>
  <Subject>sample string 1</Subject>
  <TalkModel>None</TalkModel>
  <UrlCallbackContractAccepted>sample string 10</UrlCallbackContractAccepted>
  <UrlCallbackContractRefused>sample string 11</UrlCallbackContractRefused>
  <UrlContractAccepted>sample string 8</UrlContractAccepted>
  <UrlContractRefused>sample string 9</UrlContractRefused>
  <UserFrom>sample string 3</UserFrom>
  <UserReferenceId>sample string 14</UserReferenceId>
  <UserTo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </UserTo>
</ContractData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An object containing the result of the operation.

ContractCreationResult
NameDescriptionTypeAdditional information
Success

Indicates the result of a contract creation operation.

 boolean

None.
ParentTalkId

Identifier of the parent talk.

 integer

None.
ChildIdentifiers

Identifiers of the child contracts.

 Collection of integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "ParentTalkId": 2,
  "ChildIdentifiers": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<ContractCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PuntoNeutro.Core.Contracts">
  <ChildIdentifiers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ChildIdentifiers>
  <ParentTalkId>2</ParentTalkId>
  <Success>true</Success>
</ContractCreationResult>