XML structures


Introduction

Some functions are returning data as an XML String. The data models for each function is detailed below.

XML Data Models

Targeted IBM i Information

ListDataBase

Tag Description
<Databases> Root tag
⯈ <Database> Item tag
⯈ <IBMSN> IBM i serial number
⯈ <Name> Library Name
⯈ <Caption> Library Description

ListTables

Tag Description
<Tables> Root tag
⯈ <Table> Item tag
⯈ <IBMSN> IBM i serial number
⯈ <DatabaseName> Library Name
⯈ <Name> File / Table name
⯈ <Caption> File / Table description

ListField

Tag Description
<Tables> Root tag
⯈ <Table> Field item tag
⯈ <IBMSN> IBM i serial number
⯈ <DatabaseName> Database Name
⯈ <TableName> File / Table name
⯈ <Name> Field name
⯈ <Caption> File / Table description
⯈ <KeyName> Name if key field
⯈ <KeyUnique> Unique Key
⯈ <Size> Table size

ObjectDetail

Tag Description

Programs

ListPgm

Tag Description
<Programs> Root tag
⯈ <Program> Item tag
⯈ <IBMSN> IBM i S/N
⯈ <DatabaseName> Database/Library name
⯈ <Name> Program name
⯈ <Caption> Program description

ListSrc

Tag Description
<Sources> Root tag
⯈ <Source> Item tag
⯈ <IBMSN> IBM i S/N
⯈ <DatabaseName> Database/Library name
⯈ <Name> Source file name
⯈ <Caption> Source file description

ListMbr

Tag Description
<Members> Root tag
⯈ <Member> Item tag
⯈ <IBMSN> IBM i S/N
⯈ <DatabaseName> Database/Library name
⯈ <SourceName> Source file name
⯈ <Name> Source member name
⯈ <Caption> Source member description

Database

GetDataDB2fori

Tag Description
<Data> Root tag
⯈ <Description> Data Description
⯈ <Field> Data description item (Field)
⯈ <Length> Field length
⯈ <LengthByte> Field length in bytes
⯈ <Type> Field type
⯈ <LongName> Field large name
⯈ <Header> Field header
⯈ <Decimals> Decimal places if numeric
⯈ <Caption> Field description
⯈ <Key> Key field name
⯈ <IsUsed> Field used (Y/N)
⯈ <ShortName> Field short name
⯈ <SQLQuery> Submitted SQL Query
⯈ <> self closing, last item tag
⯈ <SQLSample>
⯈ <DataSet> Data Content
⯈ <>
⯈ <>
⯈ <>
⯈ <Record>

UpdateRecord1

Tag Description

CreateRecord1

Tag Description

DeleteRecord1

Tag Description

DisplayRecord

Tag Description

UpdateRecord2XML

Tag Description

CreateRecord2XML

Tag Description

DeleteRecord2XML

Tag Description

CL in .NET

PromptCMD

Tag Description
<CLCmd> Root tag
CmdName=" " CL command name attribute
⯈ <controls> CL command control elements section tag
⯈ <control> Control element tag
⯈ <HdrControl + 4 attributes >
Type=" " ASP control type attribute
Id=" " Identifier attribute
Style=" " Style string attribute
Text=" " Text attribute
⯈ <VoidControl>
⯈ <Prompts> Prompted parameters root tag
⯈ <Prompt> Prompted parameter item
⯈ <Header + 4 attributes > Item header
Type=" " Item header ASP control type
Id=" " Item header Id
Style=" " Item header caption
Text=" " Item header value (caption)
⯈ <Keyword + 4 attributes > Item keyword
Type=" " Item keyword ASP control type
Id=" " Item keyword Id
Style=" " Item keyword style (default)
Text=" " Item keyword name
⯈ <Value + 5 attributes > Item value
Type=" " Item value ASP control type
Id=" " Item value Id
Style=" " Item value style (default)
MaxLength=" " Item value maximum length
Text=" " Item value as text

DoCmdAS400 function

Tag Description
⯈ <>