POST V1/ToolsAndLibrary.{ext}/Favourite

Add Favourite

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ext

Which media types are acceptable for the response, such as json/xml

If no matches are found, the content negotiator tries to match on the media type of the request body, if any. For example, if the request contains JSON data, the content negotiator looks for a JSON formatter.

string

Content-Type: application/json OR application/xml

Body Parameters

EMS.Security.Entities.Favourites
NameDescriptionTypeAdditional information
FavouriteId

No description available

integer

None.

FavouriteTitle

No description available

string

None.

UserId

No description available

string

None.

TransactionUserId

No description available

string

None.

TagName

No description available

string

None.

CreatedUser

No description available

string

None.

CreatedDate

No description available

string

None.

FavouriteComments

No description available

string

None.

FavouriteReportCriteria

No description available

string

None.

FilePath

No description available

string

None.

FeatureGuid

No description available

string

None.

NavigationUrl

No description available

string

None.

TabSelected

No description available

string

None.

FeatureId

No description available

string

None.

IsFavouriteEnabled

No description available

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "favouriteId": 1,
  "favouriteTitle": "sample string 2",
  "userId": "sample string 3",
  "transactionUserId": "sample string 4",
  "tagName": "sample string 5",
  "createdUser": "sample string 6",
  "createdDate": "sample string 7",
  "favouriteComments": "sample string 8",
  "favouriteReportCriteria": "sample string 9",
  "filePath": "sample string 10",
  "featureGuid": "sample string 11",
  "navigationUrl": "sample string 12",
  "tabSelected": "sample string 13",
  "featureId": "sample string 14",
  "isFavouriteEnabled": true
}

application/xml, text/xml

Sample:
<Favourites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Security.Entities">
  <CreatedDate>sample string 7</CreatedDate>
  <CreatedUser>sample string 6</CreatedUser>
  <FavouriteComments>sample string 8</FavouriteComments>
  <FavouriteId>1</FavouriteId>
  <FavouriteReportCriteria>sample string 9</FavouriteReportCriteria>
  <FavouriteTitle>sample string 2</FavouriteTitle>
  <FeatureGuid>sample string 11</FeatureGuid>
  <FeatureId>sample string 14</FeatureId>
  <FilePath>sample string 10</FilePath>
  <IsFavouriteEnabled>true</IsFavouriteEnabled>
  <NavigationUrl>sample string 12</NavigationUrl>
  <TabSelected>sample string 13</TabSelected>
  <TagName>sample string 5</TagName>
  <TransactionUserId>sample string 4</TransactionUserId>
  <UserId>sample string 3</UserId>
</Favourites>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

EMSResponseOfEMS.Common.TransactionResult
NameDescriptionTypeAdditional information
ResponseType

No description available

string

None.

Response

No description available

EMS.Common.TransactionResult

None.

Error

No description available

EMS.Common.Error

None.

Response Formats

application/json, text/json

Sample:
{
  "responseType": "TransactionResult",
  "response": {
    "status": "sample string 1",
    "message": "sample string 2",
    "result": "sample string 3"
  },
  "error": {
    "errorCode": "sample string 1",
    "errorDescription": "sample string 2"
  }
}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.