CLI Reference Guide

5 Appendix I: API settings reference

The following completes the information provided in the API XSD documents that are more related to the

structure and content type. Depending on the device model, some parameters may vary, and are subject to

device specific capabilities outlined in the specifications.

5.1 Navigation settings

NAME TYPE DEFAULT REQUIRED (PUT)

LabelA string “Default Name” TRUE

LabelB string

FALSE

JobDescription string Null FALSE

Permanent boolean — TRUE

HideDeleteButton boolean false FALSE

HideFileName boolean false FALSE

OneButton boolean false FALSE

ShowSummaryScreen boolean true FALSE

5.2 Scan settings

NAME TYPE DEFAULT REQUIRED (PUT)

Type string — TRUE

Color string — TRUE

Resolution string — TRUE

Duplex boolean — TRUE

Source string

TRUE

MediaSize string

TRUE

PageContent string Null FALSE

QualityMode string Null FALSE

Sharpness integer –1 FALSE

Darkness integer –1 FALSE

BackgroundRemoval integer –1 FALSE

Orientation string Null FALSE

Multipage boolean false FALSE

NumOfPages integer –1 FALSE

38 Chapter 5 Appendix I: API settings reference