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": [ "9173937e-a0b2-47ef-82c0-1fcf27aafccc", "0590f7c3-1af9-4bda-9b81-15831f233641" ], "Role": "3ff05fae-0350-438d-8c3b-eaa86f01a201", "Message": "sample string 2", "TermsAndConditions": "40117a78-5eba-4001-8635-3d1fbd51d607", "UseWebDocument": true, "WebDocument": "df69edc5-e7be-4abb-af9a-d120868cc7d4" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["9173937e-a0b2-47ef-82c0-1fcf27aafccc","0590f7c3-1af9-4bda-9b81-15831f233641"],"Role":"3ff05fae-0350-438d-8c3b-eaa86f01a201","Message":"sample string 2","TermsAndConditions":"40117a78-5eba-4001-8635-3d1fbd51d607","UseWebDocument":true,"WebDocument":"df69edc5-e7be-4abb-af9a-d120868cc7d4"}
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>9173937e-a0b2-47ef-82c0-1fcf27aafccc</d2p1:guid> <d2p1:guid>0590f7c3-1af9-4bda-9b81-15831f233641</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>3ff05fae-0350-438d-8c3b-eaa86f01a201</Role> <TermsAndConditions>40117a78-5eba-4001-8635-3d1fbd51d607</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>df69edc5-e7be-4abb-af9a-d120868cc7d4</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>