GET v1/kiosk/{cisId}/settings

Gets the kiosk specific settings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cisId

The cis identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

KioskSettings
NameDescriptionTypeAdditional information
VendingSettings

VendingSettings

None.

UISettings

UISettings

None.

ReceiptSettings

ReceiptSettings

None.

CaptureSettings

CaptureSettings

None.

New_insomniactype

string

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "VendingSettings": {
    "New_vendprice1": "sample string 1",
    "New_vendprice2": "sample string 2",
    "New_vendprice3": "sample string 3",
    "New_vendprice4": "sample string 4",
    "New_vendid1": "sample string 5",
    "New_vendid2": "sample string 6",
    "New_vendid3": "sample string 7",
    "New_vendid4": "sample string 8",
    "New_autoVendBin": "sample string 9"
  },
  "UISettings": {
    "New_header_background": "sample string 1",
    "New_font_color": "sample string 2",
    "New_idle_timeout": "sample string 3"
  },
  "ReceiptSettings": {
    "New_enableprint": "sample string 1",
    "New_receipt_mode": "sample string 2",
    "New_receiptTagline": "sample string 3",
    "New_showRcptPTD": "sample string 4"
  },
  "CaptureSettings": {
    "New_capture_tenant": "sample string 1",
    "New_capture_screen": "sample string 2"
  },
  "New_insomniactype": "sample string 1",
  "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:
<KioskSettings 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>
  <CaptureSettings>
    <New_capture_screen>sample string 2</New_capture_screen>
    <New_capture_tenant>sample string 1</New_capture_tenant>
  </CaptureSettings>
  <New_insomniactype>sample string 1</New_insomniactype>
  <ReceiptSettings>
    <New_enableprint>sample string 1</New_enableprint>
    <New_receiptTagline>sample string 3</New_receiptTagline>
    <New_receipt_mode>sample string 2</New_receipt_mode>
    <New_showRcptPTD>sample string 4</New_showRcptPTD>
  </ReceiptSettings>
  <UISettings>
    <New_font_color>sample string 2</New_font_color>
    <New_header_background>sample string 1</New_header_background>
    <New_idle_timeout>sample string 3</New_idle_timeout>
  </UISettings>
  <VendingSettings>
    <New_autoVendBin>sample string 9</New_autoVendBin>
    <New_vendid1>sample string 5</New_vendid1>
    <New_vendid2>sample string 6</New_vendid2>
    <New_vendid3>sample string 7</New_vendid3>
    <New_vendid4>sample string 8</New_vendid4>
    <New_vendprice1>sample string 1</New_vendprice1>
    <New_vendprice2>sample string 2</New_vendprice2>
    <New_vendprice3>sample string 3</New_vendprice3>
    <New_vendprice4>sample string 4</New_vendprice4>
  </VendingSettings>
</KioskSettings>