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": [ "f52f5490-dde6-4b29-ab41-9df64e412cbd", "ac4ba979-5fa2-4b99-b67c-a0e9e4331a52" ], "Role": "cb5b14b8-940d-411e-84de-cb8d22790eb0", "Message": "sample string 2", "TermsAndConditions": "b3832c71-42ca-448d-a3d9-439bd08d4f48", "UseWebDocument": true, "WebDocument": "dccb6163-6256-41c7-9f49-0b10975aa5f2" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["f52f5490-dde6-4b29-ab41-9df64e412cbd","ac4ba979-5fa2-4b99-b67c-a0e9e4331a52"],"Role":"cb5b14b8-940d-411e-84de-cb8d22790eb0","Message":"sample string 2","TermsAndConditions":"b3832c71-42ca-448d-a3d9-439bd08d4f48","UseWebDocument":true,"WebDocument":"dccb6163-6256-41c7-9f49-0b10975aa5f2"}
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>f52f5490-dde6-4b29-ab41-9df64e412cbd</d2p1:guid> <d2p1:guid>ac4ba979-5fa2-4b99-b67c-a0e9e4331a52</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>cb5b14b8-940d-411e-84de-cb8d22790eb0</Role> <TermsAndConditions>b3832c71-42ca-448d-a3d9-439bd08d4f48</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>dccb6163-6256-41c7-9f49-0b10975aa5f2</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>