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": [ "14c5570e-dcc5-4577-ac50-34e6f3c8bc11", "e2c719a0-4235-499b-85ad-37227a372faf" ], "Role": "5112d5c7-3625-442f-b097-18ad2c22b5b3", "Message": "sample string 2", "TermsAndConditions": "7ca4d4ba-cef8-459b-8ea8-43da1cabe7e9", "UseWebDocument": true, "WebDocument": "2dc22b26-b56b-4b15-aaec-93763b5d82c8" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["14c5570e-dcc5-4577-ac50-34e6f3c8bc11","e2c719a0-4235-499b-85ad-37227a372faf"],"Role":"5112d5c7-3625-442f-b097-18ad2c22b5b3","Message":"sample string 2","TermsAndConditions":"7ca4d4ba-cef8-459b-8ea8-43da1cabe7e9","UseWebDocument":true,"WebDocument":"2dc22b26-b56b-4b15-aaec-93763b5d82c8"}
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>14c5570e-dcc5-4577-ac50-34e6f3c8bc11</d2p1:guid> <d2p1:guid>e2c719a0-4235-499b-85ad-37227a372faf</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>5112d5c7-3625-442f-b097-18ad2c22b5b3</Role> <TermsAndConditions>7ca4d4ba-cef8-459b-8ea8-43da1cabe7e9</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>2dc22b26-b56b-4b15-aaec-93763b5d82c8</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>