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": [ "6c6bfd21-7d40-40b9-9e41-db1edc6703b9", "f60b8557-6d47-459a-8cae-80157efdaf5b" ], "Role": "277c333a-6fc7-4ac7-9f0b-f1778eb6c0d0", "Message": "sample string 2", "TermsAndConditions": "db10e512-6e33-4ad3-b454-fb8cc4ede3f6", "UseWebDocument": true, "WebDocument": "4e49a06c-3495-4689-83cf-838428233ef6" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["6c6bfd21-7d40-40b9-9e41-db1edc6703b9","f60b8557-6d47-459a-8cae-80157efdaf5b"],"Role":"277c333a-6fc7-4ac7-9f0b-f1778eb6c0d0","Message":"sample string 2","TermsAndConditions":"db10e512-6e33-4ad3-b454-fb8cc4ede3f6","UseWebDocument":true,"WebDocument":"4e49a06c-3495-4689-83cf-838428233ef6"}
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>6c6bfd21-7d40-40b9-9e41-db1edc6703b9</d2p1:guid> <d2p1:guid>f60b8557-6d47-459a-8cae-80157efdaf5b</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>277c333a-6fc7-4ac7-9f0b-f1778eb6c0d0</Role> <TermsAndConditions>db10e512-6e33-4ad3-b454-fb8cc4ede3f6</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>4e49a06c-3495-4689-83cf-838428233ef6</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>