POST api/ChoiceList/BatchGet

Batch get field choice list based on multiple fields id or name

Request Information

URI Parameters

None.

Body Parameters

binder

BatchGetChoiceBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.

Fields

Collection of ParamValueObject

None.

Request Formats

application/json, text/json

Sample:
{
  "ProjectId": 1,
  "Fields": [
    {
      "Value": "sample string 1",
      "Option": 2
    },
    {
      "Value": "sample string 1",
      "Option": 2
    }
  ]
}

application/xml, text/xml

Sample:
<BatchGetChoiceBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <Fields>
    <ParamValueObject>
      <Option>2</Option>
      <Value>sample string 1</Value>
    </ParamValueObject>
    <ParamValueObject>
      <Option>2</Option>
      <Value>sample string 1</Value>
    </ParamValueObject>
  </Fields>
  <ProjectId>1</ProjectId>
</BatchGetChoiceBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Batch get field choice list based on multiple fields id or name

API_Data_ListOfFieldChoiceList
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

Collection of FieldChoiceList

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": [
    {
      "Field": {
        "Id": 1,
        "Name": "sample string 2"
      },
      "Choices": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "IsActive": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "IsActive": true
        }
      ]
    },
    {
      "Field": {
        "Id": 1,
        "Name": "sample string 2"
      },
      "Choices": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "IsActive": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "IsActive": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<API_Data_ArrayOfFieldChoiceList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data>
    <FieldChoiceList>
      <Choices>
        <ChoiceObject>
          <Id>1</Id>
          <IsActive>true</IsActive>
          <Name>sample string 2</Name>
        </ChoiceObject>
        <ChoiceObject>
          <Id>1</Id>
          <IsActive>true</IsActive>
          <Name>sample string 2</Name>
        </ChoiceObject>
      </Choices>
      <Field>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Field>
    </FieldChoiceList>
    <FieldChoiceList>
      <Choices>
        <ChoiceObject>
          <Id>1</Id>
          <IsActive>true</IsActive>
          <Name>sample string 2</Name>
        </ChoiceObject>
        <ChoiceObject>
          <Id>1</Id>
          <IsActive>true</IsActive>
          <Name>sample string 2</Name>
        </ChoiceObject>
      </Choices>
      <Field>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Field>
    </FieldChoiceList>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfFieldChoiceList>