POST api/Interests

Returns list of all Interests associated with the CategoryId. Pass 0 to get all values. NOTE: This will return all Tessitura keyword items, some of which may not be valid as interests.

Request Information

URI Parameters

None.

Body Parameters

InterestsRequest
NameDescriptionTypeAdditional information
CategoryId

Pass 0 for all interests

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "CategoryId": 1
}

application/xml, text/xml

Sample:
<InterestsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Reference">
  <CategoryId>1</CategoryId>
</InterestsRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InterestsRequest'.

Response Information

Resource Description

IEnumerable of InterestOption object

ApiSuccessOfIEnumerableOfInterestOption
NameDescriptionTypeAdditional information
Success

boolean
Data

Collection of InterestOption

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": [
    {
      "Id": 1,
      "Description": "sample string 2",
      "CategoryId": 3
    },
    {
      "Id": 1,
      "Description": "sample string 2",
      "CategoryId": 3
    }
  ]
}

application/xml, text/xml

Sample:
<ApiSuccessOfArrayOfInterestOptionjDjzYIbp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Reference">
    <d2p1:InterestOption>
      <d2p1:CategoryId>3</d2p1:CategoryId>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
    </d2p1:InterestOption>
    <d2p1:InterestOption>
      <d2p1:CategoryId>3</d2p1:CategoryId>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
    </d2p1:InterestOption>
  </Data>
</ApiSuccessOfArrayOfInterestOptionjDjzYIbp>