Hide Comments

There are two types of Example element: example and externalExample. Both types are used to add an example message to the parent element. An example message documents what a legal message would look like.

Syntax

example '''<example-message-text>'''

externalExample "<example-message-file>"

Examples

example ''' <?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>124,000.00</grossIncome>

<taxLiability>45,000.00</taxLiability>

</TaxFiling> '''

externalExample "messages/TaxFiling.xml"

Parameters

Name

Type

Description

<example-message-text>

Free text

Representation of a message that would be valid in this context.

<example-message-file>

File path

Absolute or relative path to a text file containing a representation of a valid message. Relative paths should be interpreted as relative to the referring RAPID Model.

Child Elements

None.

Parent Elements

Collection Resource
Object Resource
Request
Response

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