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": [ "803effa2-3eab-4061-8a3a-092e31fa41d1", "0f7bba10-c17e-4020-8f6b-6c14edf9309d" ], "Role": "21874288-2886-430c-b955-80285681c281", "Message": "sample string 2", "TermsAndConditions": "ad85bc7c-cb3f-4c69-9d90-9f483bde264a", "UseWebDocument": true, "WebDocument": "35dbd785-d8a1-4341-96f2-f9df0207cecf" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["803effa2-3eab-4061-8a3a-092e31fa41d1","0f7bba10-c17e-4020-8f6b-6c14edf9309d"],"Role":"21874288-2886-430c-b955-80285681c281","Message":"sample string 2","TermsAndConditions":"ad85bc7c-cb3f-4c69-9d90-9f483bde264a","UseWebDocument":true,"WebDocument":"35dbd785-d8a1-4341-96f2-f9df0207cecf"}
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>803effa2-3eab-4061-8a3a-092e31fa41d1</d2p1:guid> <d2p1:guid>0f7bba10-c17e-4020-8f6b-6c14edf9309d</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>21874288-2886-430c-b955-80285681c281</Role> <TermsAndConditions>ad85bc7c-cb3f-4c69-9d90-9f483bde264a</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>35dbd785-d8a1-4341-96f2-f9df0207cecf</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>