This action may lead to changes in the database
Do you want to continue?
Data Explorer
Element which contains the data required to share the Bookmark Id (Board)
ShareBookmarkWeb API Query String
Request Information
Share a particular Bookmark with other user Http Delete Verb, remove the share bookmarks If only the bookmarkId is provided, all the bookmarks shared with that ID are going to be deleted
Body Parameters
Element which contains the data required to share the Bookmark Id (Board)
ShareBookmark| Name | Description | Type | Additional information |
|---|---|---|---|
| BookmarkId |
The identifier of the bookmark to share |
integer |
None. |
| InviteUsers |
List of emails to share the bookmark. |
List of BookmarkUserInvitation |
None. |
| UserEmails |
List of user emails. |
List of string |
None. |
| Status |
Invitation status. |
UserProfileShareStatus |
None. |
| PartnerId |
Gets or sets the identifier of the partner. |
integer |
None. |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
{
"Time": "sample string 1",
"Error": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
"ErrorMessage": "sample string 2",
"Status": "sample string 3",
"Server": "sample string 4",
"Count": 1,
"FavoriteCounts": {
"CommCount": 1,
"PlanCount": 2,
"SpecCount": 3
},
"FavoriteFacets": {
"Cities": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"PostalCodes": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"Markets": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
]
},
"Result": [
{
"BookmarkId": 1,
"BookmarkDataId": 1,
"UserEmailInvited": "sample string 1",
"Message": "sample string 2",
"Success": true,
"BookmarkIds": [
1,
2
]
},
{
"BookmarkId": 1,
"BookmarkDataId": 1,
"UserEmailInvited": "sample string 1",
"Message": "sample string 2",
"Success": true,
"BookmarkIds": [
1,
2
]
}
]
}
<Root>
<Time>sample string 1</Time>
<Error>
<ClassName>System.Exception</ClassName>
<Message />
<Data />
<InnerException />
<HelpURL>sample string 1</HelpURL>
<StackTraceString />
<RemoteStackTraceString />
<RemoteStackIndex>0</RemoteStackIndex>
<ExceptionMethod />
<HResult>3</HResult>
<Source>sample string 2</Source>
<WatsonBuckets />
</Error>
<ErrorMessage>sample string 2</ErrorMessage>
<Status>sample string 3</Status>
<Server>sample string 4</Server>
<Count>1</Count>
<FavoriteCounts>
<CommCount>1</CommCount>
<PlanCount>2</PlanCount>
<SpecCount>3</SpecCount>
</FavoriteCounts>
<FavoriteFacets>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
</FavoriteFacets>
<Result>
<BookmarkId>1</BookmarkId>
<BookmarkDataId>1</BookmarkDataId>
<UserEmailInvited>sample string 1</UserEmailInvited>
<Message>sample string 2</Message>
<Success>true</Success>
<BookmarkIds>1</BookmarkIds>
<BookmarkIds>2</BookmarkIds>
</Result>
<Result>
<BookmarkId>1</BookmarkId>
<BookmarkDataId>1</BookmarkDataId>
<UserEmailInvited>sample string 1</UserEmailInvited>
<Message>sample string 2</Message>
<Success>true</Success>
<BookmarkIds>1</BookmarkIds>
<BookmarkIds>2</BookmarkIds>
</Result>
</Root>
Code Generator
Response Information
ApiResultModelOfListOfApiBookmarkData
| Name | Description | Type | Additional information |
|---|---|---|---|
| Time | string |
None. |
|
| Error | Exception |
None. |
|
| ErrorMessage | string |
None. |
|
| Status | string |
None. |
|
| Server | string |
None. |
|
| Count | integer |
None. |
|
| FavoriteCounts | ApiFavoriteCounts |
None. |
|
| FavoriteFacets | ApiFavoriteFacets |
None. |
|
| Result | List of ApiBookmarkData |
None. |
|
| VerboseLogger | List of IVerboseLogger |
None. |
DELETE
api/v2/User/ShareBookmark