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": [ "b871b5c6-ee08-4a79-a51a-fb82a570c8c8", "a856dc4d-3864-4a9b-8a23-1a8a220f9141" ], "Role": "ea70bccd-9d2d-46f7-a966-ff2c5c1d7e1b", "Message": "sample string 2", "TermsAndConditions": "3ee23e1b-4f6b-4bbc-b341-1c1b9590362a", "UseWebDocument": true, "WebDocument": "74a6f007-6da3-4772-ae45-9db5722f39c8" }
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["b871b5c6-ee08-4a79-a51a-fb82a570c8c8","a856dc4d-3864-4a9b-8a23-1a8a220f9141"],"Role":"ea70bccd-9d2d-46f7-a966-ff2c5c1d7e1b","Message":"sample string 2","TermsAndConditions":"3ee23e1b-4f6b-4bbc-b341-1c1b9590362a","UseWebDocument":true,"WebDocument":"74a6f007-6da3-4772-ae45-9db5722f39c8"}
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>b871b5c6-ee08-4a79-a51a-fb82a570c8c8</d2p1:guid> <d2p1:guid>a856dc4d-3864-4a9b-8a23-1a8a220f9141</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>ea70bccd-9d2d-46f7-a966-ff2c5c1d7e1b</Role> <TermsAndConditions>3ee23e1b-4f6b-4bbc-b341-1c1b9590362a</TermsAndConditions> <UseWebDocument>true</UseWebDocument> <WebDocument>74a6f007-6da3-4772-ae45-9db5722f39c8</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>