POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/MarkFavorite

Toggle entity as favorite

Request Information

URI Parameters

Name	Description	Type	Additional information
businessModuleId		globally unique identifier	Required
entityId		integer	Required

Body Parameters

WorkPoint.Core.Models.Actions.MarkEntityAsFavoriteAction

Name	Type	Additional information
MarkAsFavorite	boolean	None.
UserLoginNames	Collection of string	None.
Id	globally unique identifier	None.
Title	string	None.
Order	integer	None.
Active	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "MarkAsFavorite": true,
  "UserLoginNames": [
    "sample string 1",
    "sample string 2"
  ],
  "Id": "c6d05a45-81c9-4db8-ba57-141a4ee671a2",
  "Title": "sample string 3",
  "Order": 4,
  "Active": true
}

application/xml, text/xml

Sample:

<MarkEntityAsFavoriteAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.Actions">
  <ActionWasSuccessful>true</ActionWasSuccessful>
  <Active>true</Active>
  <CallbackUrl>sample string 8</CallbackUrl>
  <Id>c6d05a45-81c9-4db8-ba57-141a4ee671a2</Id>
  <Order>4</Order>
  <ReturnValue>sample string 6</ReturnValue>
  <Title>sample string 3</Title>
  <MarkAsFavorite>true</MarkAsFavorite>
  <UserLoginNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </UserLoginNames>
</MarkEntityAsFavoriteAction>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.