POST api/v1/get_vocabularyValueslisting?listId={listId}

Name	Type	Additional information
PageNumber	integer	None.
Limit	integer	None.
SearchText	string	None.
SortField	string	None.
SortDirection	string	None.
IsB2C	boolean	None.
SellerId	integer	None.
AdminMemberId	integer	None.
ClientId	integer	None.
Sortorder	integer	None.

Request Formats

application/json, text/json

{
  "PageNumber": 1,
  "Limit": 2,
  "SearchText": "sample string 3",
  "SortField": "sample string 4",
  "SortDirection": "sample string 5",
  "IsB2C": true,
  "SellerId": 7,
  "AdminMemberId": 8,
  "ClientId": 9,
  "Sortorder": 10
}

text/html

{"PageNumber":1,"Limit":2,"SearchText":"sample string 3","SortField":"sample string 4","SortDirection":"sample string 5","IsB2C":true,"SellerId":7,"AdminMemberId":8,"ClientId":9,"Sortorder":10}

application/xml, text/xml

<QueryParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">
  <AdminMemberId>8</AdminMemberId>
  <ClientId>9</ClientId>
  <IsB2C>true</IsB2C>
  <Limit>2</Limit>
  <PageNumber>1</PageNumber>
  <SearchText>sample string 3</SearchText>
  <SellerId>7</SellerId>
  <SortDirection>sample string 5</SortDirection>
  <SortField>sample string 4</SortField>
  <Sortorder>10</Sortorder>
</QueryParameters>

application/x-www-form-urlencoded

Sample not available.

Response Information

Description:

Return type: ListVocabularyValueModel

Response Formats

application/json, text/json

{
  "TotalRecord": 1,
  "TotalPages": 2,
  "Items": [
    {
      "Id": 1,
      "ListId": 2,
      "Value": "sample string 3",
      "ParentId": 1,
      "IsActive": true,
      "IsLogicalDeleted": true,
      "CreatedOn": "2025-06-18T12:54:26.8581998+00:00",
      "CreatedBy": 7,
      "ModifiedOn": "2025-06-18T12:54:26.8581998+00:00",
      "ModifiedBy": 1,
      "SortOrder": 1,
      "BusinessType": 8
    },
    {
      "Id": 1,
      "ListId": 2,
      "Value": "sample string 3",
      "ParentId": 1,
      "IsActive": true,
      "IsLogicalDeleted": true,
      "CreatedOn": "2025-06-18T12:54:26.8581998+00:00",
      "CreatedBy": 7,
      "ModifiedOn": "2025-06-18T12:54:26.8581998+00:00",
      "ModifiedBy": 1,
      "SortOrder": 1,
      "BusinessType": 8
    }
  ]
}

text/html

{"TotalRecord":1,"TotalPages":2,"Items":[{"Id":1,"ListId":2,"Value":"sample string 3","ParentId":1,"IsActive":true,"IsLogicalDeleted":true,"CreatedOn":"2025-06-18T12:54:26.8581998+00:00","CreatedBy":7,"ModifiedOn":"2025-06-18T12:54:26.8581998+00:00","ModifiedBy":1,"SortOrder":1,"BusinessType":8},{"Id":1,"ListId":2,"Value":"sample string 3","ParentId":1,"IsActive":true,"IsLogicalDeleted":true,"CreatedOn":"2025-06-18T12:54:26.8581998+00:00","CreatedBy":7,"ModifiedOn":"2025-06-18T12:54:26.8581998+00:00","ModifiedBy":1,"SortOrder":1,"BusinessType":8}]}

application/xml, text/xml

<ListVocabularyValueModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.CatalogDesign">
  <Items>
    <ListVocabularyItem>
      <BusinessType>8</BusinessType>
      <CreatedBy>7</CreatedBy>
      <CreatedOn>2025-06-18T12:54:26.8581998+00:00</CreatedOn>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <IsLogicalDeleted>true</IsLogicalDeleted>
      <ListId>2</ListId>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2025-06-18T12:54:26.8581998+00:00</ModifiedOn>
      <ParentId>1</ParentId>
      <SortOrder>1</SortOrder>
      <Value>sample string 3</Value>
    </ListVocabularyItem>
    <ListVocabularyItem>
      <BusinessType>8</BusinessType>
      <CreatedBy>7</CreatedBy>
      <CreatedOn>2025-06-18T12:54:26.8581998+00:00</CreatedOn>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <IsLogicalDeleted>true</IsLogicalDeleted>
      <ListId>2</ListId>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2025-06-18T12:54:26.8581998+00:00</ModifiedOn>
      <ParentId>1</ParentId>
      <SortOrder>1</SortOrder>
      <Value>sample string 3</Value>
    </ListVocabularyItem>
  </Items>
  <TotalPages>2</TotalPages>
  <TotalRecord>1</TotalRecord>
</ListVocabularyValueModel>