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": [ "95fa8b8f-e412-4526-86c3-409f8f0c70bd", "ac7653d2-6f7d-43b1-a4a9-4bc28fcdbd4e" ], "Role": "91340186-9b09-430f-b2d9-5b8cee52424f", "Message": "sample string 2", "TermsAndConditions": "145042a9-d473-4724-bb3c-4efc733f6968", "UseWebDocument": true, "WebDocument": "89c6d36d-7e38-46f1-bc8c-6039bb04ab81" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["95fa8b8f-e412-4526-86c3-409f8f0c70bd","ac7653d2-6f7d-43b1-a4a9-4bc28fcdbd4e"],"Role":"91340186-9b09-430f-b2d9-5b8cee52424f","Message":"sample string 2","TermsAndConditions":"145042a9-d473-4724-bb3c-4efc733f6968","UseWebDocument":true,"WebDocument":"89c6d36d-7e38-46f1-bc8c-6039bb04ab81"}
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>95fa8b8f-e412-4526-86c3-409f8f0c70bd</d2p1:guid> <d2p1:guid>ac7653d2-6f7d-43b1-a4a9-4bc28fcdbd4e</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>91340186-9b09-430f-b2d9-5b8cee52424f</Role> <TermsAndConditions>145042a9-d473-4724-bb3c-4efc733f6968</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>89c6d36d-7e38-46f1-bc8c-6039bb04ab81</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>