GET category/fields?categoryId={categoryId}

Request Information

URI Parameters

Name	Description	Type	Additional information
categoryId		integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CategoryField

Name	Type	Additional information
id	globally unique identifier	None.
categoryId	integer	None.
name	string	None.
icon	string	None.
type	integer	None.
combos	Collection of CategoryFieldCombo	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": "41572ee4-74fa-4f46-85ed-1dfa09e1bdf9",
    "categoryId": 1,
    "name": "sample string 1",
    "icon": "sample string 2",
    "type": 3,
    "combos": [
      {
        "id": "a5da584c-aa03-45ee-a9e8-daeb07fa6f58",
        "fieldId": "7849fe60-97b8-46db-b1e6-aa952c23e79c",
        "name": "sample string 1",
        "note": "sample string 2"
      },
      {
        "id": "a5da584c-aa03-45ee-a9e8-daeb07fa6f58",
        "fieldId": "7849fe60-97b8-46db-b1e6-aa952c23e79c",
        "name": "sample string 1",
        "note": "sample string 2"
      }
    ]
  },
  {
    "id": "41572ee4-74fa-4f46-85ed-1dfa09e1bdf9",
    "categoryId": 1,
    "name": "sample string 1",
    "icon": "sample string 2",
    "type": 3,
    "combos": [
      {
        "id": "a5da584c-aa03-45ee-a9e8-daeb07fa6f58",
        "fieldId": "7849fe60-97b8-46db-b1e6-aa952c23e79c",
        "name": "sample string 1",
        "note": "sample string 2"
      },
      {
        "id": "a5da584c-aa03-45ee-a9e8-daeb07fa6f58",
        "fieldId": "7849fe60-97b8-46db-b1e6-aa952c23e79c",
        "name": "sample string 1",
        "note": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCategoryField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Careby.Api.Models">
  <CategoryField>
    <categoryId>1</categoryId>
    <combos>
      <CategoryFieldCombo>
        <fieldId>7849fe60-97b8-46db-b1e6-aa952c23e79c</fieldId>
        <id>a5da584c-aa03-45ee-a9e8-daeb07fa6f58</id>
        <name>sample string 1</name>
        <note>sample string 2</note>
      </CategoryFieldCombo>
      <CategoryFieldCombo>
        <fieldId>7849fe60-97b8-46db-b1e6-aa952c23e79c</fieldId>
        <id>a5da584c-aa03-45ee-a9e8-daeb07fa6f58</id>
        <name>sample string 1</name>
        <note>sample string 2</note>
      </CategoryFieldCombo>
    </combos>
    <icon>sample string 2</icon>
    <id>41572ee4-74fa-4f46-85ed-1dfa09e1bdf9</id>
    <name>sample string 1</name>
    <type>3</type>
  </CategoryField>
  <CategoryField>
    <categoryId>1</categoryId>
    <combos>
      <CategoryFieldCombo>
        <fieldId>7849fe60-97b8-46db-b1e6-aa952c23e79c</fieldId>
        <id>a5da584c-aa03-45ee-a9e8-daeb07fa6f58</id>
        <name>sample string 1</name>
        <note>sample string 2</note>
      </CategoryFieldCombo>
      <CategoryFieldCombo>
        <fieldId>7849fe60-97b8-46db-b1e6-aa952c23e79c</fieldId>
        <id>a5da584c-aa03-45ee-a9e8-daeb07fa6f58</id>
        <name>sample string 1</name>
        <note>sample string 2</note>
      </CategoryFieldCombo>
    </combos>
    <icon>sample string 2</icon>
    <id>41572ee4-74fa-4f46-85ed-1dfa09e1bdf9</id>
    <name>sample string 1</name>
    <type>3</type>
  </CategoryField>
</ArrayOfCategoryField>