Hide Comments

The structure element defines a canonical Data Structure, which may be realized in Resource Definitions, Request and Response Messages.

Syntax

structure <structure-name>

[<property>]...

[<data-example>]...

Examples

structure TaxFiling

filingID : string

taxpayer : reference to Person

jurisdiction : string

year : gYear

period : int

currency : string

grossIncome : decimal

taxLiability : decimal

dataExample ''' <?xml version="1.0" encoding="UTF-8"?>

<TaxFiling version="1.0">

<filingID>#123456</filingID>

<taxpayer>ssn-xx-xxxx</taxpayer>

<jurisdiction>PA0010000</jurisdiction>

<year>2014</year>

<period></period>

<currency>USD</currency>

<grossIncome>32,000.00</grossIncome>

<taxLiability>9,600.00</taxLiability>

</TaxFiling> '''

Parameters

Field Name

Type

Description

<structure-name>

Name

The Name assigned to this Data Structure, which MUST be unique within the containing Data Model.

Child Elements

Name

Topic

Description

<property>

Primitive Property or Reference Property

A property definition.

<data-example>

Data Example

An example of what this structure would look like rendered in a particular media type.

Parent Elements

Data Model

Created with Help & Manual 6 and styled with Premium Pack Version 2.51 © by EC Software