POST quote/share/{quote}
Shares a quote.
Request Information
URI
https://ofd-api.blueprintcpq.net/quote/share/{quote}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
quote |
Quote Identifier. |
globally unique identifier |
Required |
Body Parameters
The share.
ShareQuoteName | Description | Type | Additional information |
---|---|---|---|
EmailAddresses | Collection of string |
None. |
|
Documents | Collection of globally unique identifier |
None. |
|
Role | globally unique identifier |
None. |
|
Message | string |
None. |
|
TermsAndConditions | globally unique identifier |
None. |
|
UseWebDocument | boolean |
None. |
|
WebDocument | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "EmailAddresses": [ "sample string 1", "sample string 2" ], "Documents": [ "8efb3cef-eac4-4398-8b2a-b71ef66dead5", "8e6e1d86-1238-4439-ac8c-e3b9b3746ce2" ], "Role": "0dfaae95-bdc4-4358-ab52-25398fddf925", "Message": "sample string 2", "TermsAndConditions": "23f7957b-b950-4d79-b4f5-d56231402d51", "UseWebDocument": true, "WebDocument": "548278bf-b78c-4199-88dc-0852c68c2e86" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["8efb3cef-eac4-4398-8b2a-b71ef66dead5","8e6e1d86-1238-4439-ac8c-e3b9b3746ce2"],"Role":"0dfaae95-bdc4-4358-ab52-25398fddf925","Message":"sample string 2","TermsAndConditions":"23f7957b-b950-4d79-b4f5-d56231402d51","UseWebDocument":true,"WebDocument":"548278bf-b78c-4199-88dc-0852c68c2e86"}
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"> <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>8efb3cef-eac4-4398-8b2a-b71ef66dead5</d2p1:guid> <d2p1:guid>8e6e1d86-1238-4439-ac8c-e3b9b3746ce2</d2p1:guid> </Documents> <EmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </EmailAddresses> <Message>sample string 2</Message> <Role>0dfaae95-bdc4-4358-ab52-25398fddf925</Role> <TermsAndConditions>23f7957b-b950-4d79-b4f5-d56231402d51</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>548278bf-b78c-4199-88dc-0852c68c2e86</WebDocument> </ShareQuote>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
True if it succeeds, false if it fails.
booleanResponse Formats
application/json, text/json, text/html
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>