GET v1/kiosks?searchTerm={searchTerm}
Gets the kiosks.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
searchTerm |
The search term. |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
GetKiosksResultName | Description | Type | Additional information |
---|---|---|---|
Kiosks | Collection of KioskListItem |
None. |
|
Errors | Collection of Exception |
None. |
|
IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Kiosks": [ { "FacilityName": "sample string 1", "FacilityId": "ebd66304-b569-422f-9dde-c88a56f45b00", "CisId": 3, "VideoSupported": true, "IpAdminOnline": true, "StatusColor": 6 }, { "FacilityName": "sample string 1", "FacilityId": "ebd66304-b569-422f-9dde-c88a56f45b00", "CisId": 3, "VideoSupported": true, "IpAdminOnline": true, "StatusColor": 6 } ], "Errors": [ { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null }, { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null } ], "IsSuccess": true }
application/xml, text/xml
Sample:
<GetKiosksResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models"> <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels"> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> </Errors> <IsSuccess xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">true</IsSuccess> <Kiosks> <KioskListItem> <CisId>3</CisId> <FacilityId>ebd66304-b569-422f-9dde-c88a56f45b00</FacilityId> <FacilityName>sample string 1</FacilityName> <IpAdminOnline>true</IpAdminOnline> <StatusColor>6</StatusColor> <VideoSupported>true</VideoSupported> </KioskListItem> <KioskListItem> <CisId>3</CisId> <FacilityId>ebd66304-b569-422f-9dde-c88a56f45b00</FacilityId> <FacilityName>sample string 1</FacilityName> <IpAdminOnline>true</IpAdminOnline> <StatusColor>6</StatusColor> <VideoSupported>true</VideoSupported> </KioskListItem> </Kiosks> </GetKiosksResult>