GET api/subchannels?name={name}&nameContains={nameContains}&parentChannelId={parentChannelId}

Get all SubChannels optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

Optional case-insensitive filter on SubChannels with a name that matches the provided value.

string

None.

nameContains

Optional case-insensitive filter on SubChannels with a name containing the provided value.

string

None.

parentChannelId

Optional filter on SubChannels with a ParentChannelId that matches the provided value.

integer

None.

Body Parameters

None.

Response Information

Resource Description

SubChannelDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database.

integer

None.

Name

string

Required

String length: inclusive between 0 and 100

ParentChannelId

The identifier of the parent Channel associated with the given record.

integer

Required

Range: inclusive between 1 and 99999999

ParentChannelName

The name of the parent Channel associated with the given record.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "ParentChannelId": 3,
  "ParentChannelName": "sample string 4"
}