XaitCPQ API

POST quote/share/{quote}

Shares a quote.

Request Information

URI

https://ofd-api.blueprintcpq.net/quote/share/{quote}

URI Parameters

NameDescriptionTypeAdditional information
quote

Quote Identifier.

 globally unique identifier

Required

Body Parameters

The share.

ShareQuote
NameDescriptionTypeAdditional information
Contacts

Collection of ShareNewContact

None.
Documents

Collection of OrderedRecord

None.
Role

globally unique identifier

None.
Message

string

None.
TermsAndConditions

globally unique identifier

None.
UseWebDocument

boolean

None.
WebDocument

globally unique identifier

None.
SignatureService

SignatureServices

None.

Request Formats

application/json, text/json

Sample: 
{
  "Contacts": [
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Email": "sample string 3"
    },
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Email": "sample string 3"
    }
  ],
  "Documents": [
    {
      "Id": "10565e7b-5787-4243-8b8f-eafd027693a4",
      "Order": 2
    },
    {
      "Id": "10565e7b-5787-4243-8b8f-eafd027693a4",
      "Order": 2
    }
  ],
  "Role": "5eb29c6f-7a57-4f71-9cba-7cab5043a14e",
  "Message": "sample string 2",
  "TermsAndConditions": "c8f575f7-2d40-49ec-bc45-f32e74c2fecc",
  "UseWebDocument": true,
  "WebDocument": "556719d9-6a33-4612-ae78-0d48287389ae",
  "SignatureService": 0
}

text/html

Sample: 
{"Contacts":[{"FirstName":"sample string 1","LastName":"sample string 2","Email":"sample string 3"},{"FirstName":"sample string 1","LastName":"sample string 2","Email":"sample string 3"}],"Documents":[{"Id":"10565e7b-5787-4243-8b8f-eafd027693a4","Order":2},{"Id":"10565e7b-5787-4243-8b8f-eafd027693a4","Order":2}],"Role":"5eb29c6f-7a57-4f71-9cba-7cab5043a14e","Message":"sample string 2","TermsAndConditions":"c8f575f7-2d40-49ec-bc45-f32e74c2fecc","UseWebDocument":true,"WebDocument":"556719d9-6a33-4612-ae78-0d48287389ae","SignatureService":0}

application/xml, text/xml

Sample: 
<ShareQuote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Contacts>
    <ShareNewContact>
      <Email>sample string 3</Email>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
    </ShareNewContact>
    <ShareNewContact>
      <Email>sample string 3</Email>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
    </ShareNewContact>
  </Contacts>
  <Documents>
    <OrderedRecord>
      <Id>10565e7b-5787-4243-8b8f-eafd027693a4</Id>
      <Order>2</Order>
    </OrderedRecord>
    <OrderedRecord>
      <Id>10565e7b-5787-4243-8b8f-eafd027693a4</Id>
      <Order>2</Order>
    </OrderedRecord>
  </Documents>
  <Message>sample string 2</Message>
  <Role>5eb29c6f-7a57-4f71-9cba-7cab5043a14e</Role>
  <SignatureService>XaitSign</SignatureService>
  <TermsAndConditions>c8f575f7-2d40-49ec-bc45-f32e74c2fecc</TermsAndConditions>
  <UseWebDocument>true</UseWebDocument>
  <WebDocument>556719d9-6a33-4612-ae78-0d48287389ae</WebDocument>
</ShareQuote>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

True if it succeeds, false if it fails.

ShareResult
NameDescriptionTypeAdditional information
Success

boolean

None.
Message

string

None.
Code

ShareStatusCode

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Message": "sample string 2",
  "Code": 0
}

text/html

Sample: 
{"Success":true,"Message":"sample string 2","Code":0}

application/xml, text/xml

Sample: 
<ShareResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Code>OK</Code>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ShareResult>