PUT api/cases/matches

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
StateId	The state to filter results to. TODO: make this a list	globally unique identifier	None.
MatchCount	The number of Cases to return	integer	None.
CueTexts	A string list of Cues (Terms) to match cases by	Collection of string	None.
CueCount	The number of Recommended Cues to return	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "StateId": "a2305f90-fc62-4eea-8e9c-1ea3405d2ef0",
  "MatchCount": 2,
  "CueTexts": [
    "sample string 1",
    "sample string 2"
  ],
  "CueCount": 3
}

application/xml, text/xml

Sample:

<CaseMatchSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.API.Models">
  <CueCount>3</CueCount>
  <CueTexts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CueTexts>
  <MatchCount>2</MatchCount>
  <StateId>a2305f90-fc62-4eea-8e9c-1ea3405d2ef0</StateId>
</CaseMatchSearch>

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 'CaseMatchSearch'.

Response Information

Resource Description

CaseMiningResult

Name	Description	Type	Additional information
CaseMatches	The recommended Cases from the PRE	Collection of ScoredCase	None.
RecommendedCues	Suggested NBQs	Collection of string	None.
RecommendedQuestions	The XCapture Questions where the "Recommended Cues" originate from	Collection of QuestionDetail	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'XCapture.DTO.QuestionDetail'. Path 'RecommendedQuestions[0].Answers[0].SubQuestions'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'XCapture.DTO.QuestionDetail'. Path 'RecommendedQuestions[0].Answers[0].SubQuestions'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[XCapture.DTO.AnswerDetail, XCapture.DTO, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[XCapture.DTO.AnswerDetail, XCapture.DTO, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.