GET channels/{channelNameFilter}
Gets a list of channels filtered by name.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
channelNameFilter |
Filter the channel's list by name |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseVMOfSiteChannelVMName | Description | Type | Additional information |
---|---|---|---|
Resources | Collection of SiteChannelVM |
None. |
|
ResultCode | FwApiResultCode |
None. |
|
ResultMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Resources": [ { "SiteId": 1, "SiteName": "sample string 2", "ChannelId": 3, "ChannelName": "sample string 4", "UnitName": "sample string 5" }, { "SiteId": 1, "SiteName": "sample string 2", "ChannelId": 3, "ChannelName": "sample string 4", "UnitName": "sample string 5" } ], "ResultCode": 0, "ResultMessage": "sample string 1" }
application/xml, text/xml
Sample:
<ResponseVMOfSiteChannelVMFXJgzlgx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels"> <ResultCode>Ok</ResultCode> <ResultMessage>sample string 1</ResultMessage> <Resources> <SiteChannelVM> <ChannelId>3</ChannelId> <ChannelName>sample string 4</ChannelName> <SiteId>1</SiteId> <SiteName>sample string 2</SiteName> <UnitName>sample string 5</UnitName> </SiteChannelVM> <SiteChannelVM> <ChannelId>3</ChannelId> <ChannelName>sample string 4</ChannelName> <SiteId>1</SiteId> <SiteName>sample string 2</SiteName> <UnitName>sample string 5</UnitName> </SiteChannelVM> </Resources> </ResponseVMOfSiteChannelVMFXJgzlgx>