POST api/Favorites/ExistsFavorite

Checks if a favorite exists

Request Information

URI Parameters

None.

Body Parameters

The favorite

WorkPoint365.WebAPI.Model.Favorite
NameDescriptionTypeAdditional information
FavoriteID

Gets or sets the favorite identifier.

integer

None.

Title

Gets or sets the title.

string

None.

ListId

Gets or sets the list identifier.

globally unique identifier

None.

ListName

Gets or sets the name of the list.

string

None.

ItemId

Gets or sets the item identifier.

integer

None.

UserEmail

Gets or sets the user email.

string

None.

FavoriteType

Gets or sets the type of the favorite.

WorkPoint365.WebAPI.Model.FavoriteTypes

None.

SortOrder

Gets or sets the sort order.

integer

None.

JournalId

Gets or sets the journal identifier.

globally unique identifier

None.

RelativeSitePath

Gets or sets the relative site path.

string

None.

RelativeSiteUrl

Gets or sets the relative site URL.

string

None.

RelativeListPath

Gets or sets the relative list path.

string

None.

RelativeFolderPath

Gets or sets the relative folder path.

string

None.

FavoriteListID

Gets or sets the favorite list identifier.

globally unique identifier

None.

FavoriteListName

Gets or sets the name of the favorite list.

string

None.

IsMailList

Gets or sets the is mail list.

boolean

None.

Breadcrumb

Gets or sets the breadcrumb.

string

None.

Name

Gets or sets the name.

string

None.

RelativeUrl

Gets or sets the relative URL.

string

None.

IconUrl

Gets or sets the icon.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FavoriteID": 1,
  "Title": "sample string 2",
  "ListId": "fcb25097-41ba-49d1-8c20-f1e375bd448a",
  "ListName": "sample string 4",
  "ItemId": 5,
  "UserEmail": "sample string 6",
  "FavoriteType": 10,
  "SortOrder": 7,
  "JournalId": "5a7dd959-d640-4c78-b0fe-e1a3ceb8e4b3",
  "RelativeSitePath": "sample string 8",
  "RelativeSiteUrl": "sample string 9",
  "RelativeListPath": "sample string 10",
  "RelativeFolderPath": "sample string 11",
  "FavoriteListID": "dde22a69-d410-4756-8fc2-0d76a4db99e5",
  "FavoriteListName": "sample string 12",
  "IsMailList": true,
  "Breadcrumb": "sample string 13",
  "Name": "sample string 14",
  "RelativeUrl": "sample string 15",
  "IconUrl": "sample string 16"
}

application/xml, text/xml

Sample:
<Favorite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <Breadcrumb>sample string 13</Breadcrumb>
  <FavoriteID>1</FavoriteID>
  <FavoriteListID>dde22a69-d410-4756-8fc2-0d76a4db99e5</FavoriteListID>
  <FavoriteListName>sample string 12</FavoriteListName>
  <FavoriteType>List</FavoriteType>
  <IconUrl>sample string 16</IconUrl>
  <IsMailList>true</IsMailList>
  <ItemId>5</ItemId>
  <JournalId>5a7dd959-d640-4c78-b0fe-e1a3ceb8e4b3</JournalId>
  <ListId>fcb25097-41ba-49d1-8c20-f1e375bd448a</ListId>
  <ListName>sample string 4</ListName>
  <Name>sample string 14</Name>
  <RelativeFolderPath>sample string 11</RelativeFolderPath>
  <RelativeListPath>sample string 10</RelativeListPath>
  <RelativeSitePath>sample string 8</RelativeSitePath>
  <RelativeSiteUrl>sample string 9</RelativeSiteUrl>
  <RelativeUrl>sample string 15</RelativeUrl>
  <SortOrder>7</SortOrder>
  <Title>sample string 2</Title>
  <UserEmail>sample string 6</UserEmail>
</Favorite>

Response Information

Resource Description

Boolean value

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.