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": [ "43c6a2da-425b-46d1-a90f-2bc5670b891d", "1b079dcd-d06f-4af2-a548-806dd0444bce" ], "Role": "63c698e8-3fac-42ea-8c4a-d0d9daa9873c", "Message": "sample string 2", "TermsAndConditions": "3f8f401f-f972-46c6-9fc3-fb8bc94be453", "UseWebDocument": true, "WebDocument": "a5ca8987-5cad-4abd-be11-08b836ae07e9" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["43c6a2da-425b-46d1-a90f-2bc5670b891d","1b079dcd-d06f-4af2-a548-806dd0444bce"],"Role":"63c698e8-3fac-42ea-8c4a-d0d9daa9873c","Message":"sample string 2","TermsAndConditions":"3f8f401f-f972-46c6-9fc3-fb8bc94be453","UseWebDocument":true,"WebDocument":"a5ca8987-5cad-4abd-be11-08b836ae07e9"}
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>43c6a2da-425b-46d1-a90f-2bc5670b891d</d2p1:guid> <d2p1:guid>1b079dcd-d06f-4af2-a548-806dd0444bce</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>63c698e8-3fac-42ea-8c4a-d0d9daa9873c</Role> <TermsAndConditions>3f8f401f-f972-46c6-9fc3-fb8bc94be453</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>a5ca8987-5cad-4abd-be11-08b836ae07e9</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>