POST api/ReferenceData/CodeValue/Get

Request Information

URI Parameters

None.

Body Parameters

CodeSetQueryModel
NameDescriptionTypeAdditional information
CodeSetIds

Collection of integer

None.

CodeSetNames

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "CodeSetIds": [
    1,
    2
  ],
  "CodeSetNames": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:
{"CodeSetIds":[1,2],"CodeSetNames":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample:
<CodeSetQueryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.WebAPI.Areas.ReferenceData.Endpoints">
  <CodeSetIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CodeSetIds>
  <CodeSetNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CodeSetNames>
</CodeSetQueryModel>

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

Response Information

Resource Description

Collection of CodeSet
NameDescriptionTypeAdditional information
CodeSetId

integer

None.

CodeSetName

string

None.

CodeValues

Collection of Object

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CodeSetId": 1,
    "CodeSetName": "sample string 2",
    "CodeValues": null
  },
  {
    "CodeSetId": 1,
    "CodeSetName": "sample string 2",
    "CodeValues": null
  }
]

text/html

Sample:
[{"CodeSetId":1,"CodeSetName":"sample string 2","CodeValues":null},{"CodeSetId":1,"CodeSetName":"sample string 2","CodeValues":null}]

application/xml, text/xml

Sample:
<ArrayOfCodeSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Library.CodeSets.Storage">
  <CodeSet>
    <CodeSetId>1</CodeSetId>
    <CodeSetName>sample string 2</CodeSetName>
    <CodeValues i:nil="true" />
  </CodeSet>
  <CodeSet>
    <CodeSetId>1</CodeSetId>
    <CodeSetName>sample string 2</CodeSetName>
    <CodeValues i:nil="true" />
  </CodeSet>
</ArrayOfCodeSet>