GET example/api/mailmessage/{mailMessageId}/htmlcontent/links
https://app.bwz.se/bedrock/example/api/mailmessage/{mailMessageId}/htmlcontent/links
Gets all links in the content of a mail message
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
mailMessageId |
Id of the mail message to get links from |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of LinkInContentModelName | Description | Type | Additional information |
---|---|---|---|
LinkUrl |
Url of the link |
string |
None. |
LinkName |
Name of the link set by user |
string |
None. |
LinkValue |
Value of the link |
integer |
None. |
LinkCategoryId |
Id of the the set link category |
integer |
None. |
BiaEnabled |
Is clicks on the link reported to associated bia integrators |
boolean |
None. |
LinkType |
Type of link |
LinkType |
None. |
LinkCategoryName |
Name of the set link category |
string |
None. |
LinkTypeName |
Text representation of the link type |
string |
None. |
IsTrackable |
The link will be tracked in mail statistics |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "LinkUrl": "sample string 1", "LinkName": "sample string 2", "LinkValue": 3, "LinkCategoryId": 1, "BiaEnabled": true, "LinkType": 1, "LinkCategoryName": "sample string 5", "LinkTypeName": "sample string 6", "IsTrackable": true }, { "LinkUrl": "sample string 1", "LinkName": "sample string 2", "LinkValue": 3, "LinkCategoryId": 1, "BiaEnabled": true, "LinkType": 1, "LinkCategoryName": "sample string 5", "LinkTypeName": "sample string 6", "IsTrackable": true } ]
application/xml, text/xml
Sample:
<ArrayOfLinkInContentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models"> <LinkInContentModel> <BiaEnabled>true</BiaEnabled> <IsTrackable>true</IsTrackable> <LinkCategoryId>1</LinkCategoryId> <LinkCategoryName>sample string 5</LinkCategoryName> <LinkName>sample string 2</LinkName> <LinkType>External</LinkType> <LinkTypeName>sample string 6</LinkTypeName> <LinkUrl>sample string 1</LinkUrl> <LinkValue>3</LinkValue> </LinkInContentModel> <LinkInContentModel> <BiaEnabled>true</BiaEnabled> <IsTrackable>true</IsTrackable> <LinkCategoryId>1</LinkCategoryId> <LinkCategoryName>sample string 5</LinkCategoryName> <LinkName>sample string 2</LinkName> <LinkType>External</LinkType> <LinkTypeName>sample string 6</LinkTypeName> <LinkUrl>sample string 1</LinkUrl> <LinkValue>3</LinkValue> </LinkInContentModel> </ArrayOfLinkInContentModel>