POST quote/share/{quote}
Shares a quote.
Request Information
URI
https://highlandfleets-dev-api.xaitcpq.net/quote/share/{quote}
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| quote |
Quote Identifier. |
globally unique identifier |
Required |
Body Parameters
The share.
ShareQuote| Name | 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": [
"68a90306-48c8-41b4-a5b8-cd1276018592",
"526df271-b01c-4393-91bf-1cd012bdddb9"
],
"Role": "3963e7c1-ba9a-4e3e-96b3-a618e356e1fa",
"Message": "sample string 2",
"TermsAndConditions": "72a0c494-f2df-42e4-aad1-4cd88dc45186",
"UseWebDocument": true,
"WebDocument": "7b0261e9-4de3-43f0-adec-c4a1921d6509"
}
text/html
Sample:
{"EmailAddresses":["sample string 1","sample string 2"],"Documents":["68a90306-48c8-41b4-a5b8-cd1276018592","526df271-b01c-4393-91bf-1cd012bdddb9"],"Role":"3963e7c1-ba9a-4e3e-96b3-a618e356e1fa","Message":"sample string 2","TermsAndConditions":"72a0c494-f2df-42e4-aad1-4cd88dc45186","UseWebDocument":true,"WebDocument":"7b0261e9-4de3-43f0-adec-c4a1921d6509"}
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>68a90306-48c8-41b4-a5b8-cd1276018592</d2p1:guid>
<d2p1:guid>526df271-b01c-4393-91bf-1cd012bdddb9</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>3963e7c1-ba9a-4e3e-96b3-a618e356e1fa</Role>
<TermsAndConditions>72a0c494-f2df-42e4-aad1-4cd88dc45186</TermsAndConditions>
<UseWebDocument>true</UseWebDocument>
<WebDocument>7b0261e9-4de3-43f0-adec-c4a1921d6509</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>