Using XML to document a request to record a TV program (part 1)
Let's say we have an API that sends requests to record a TV program with XML:
<recordTV>
<date>2015-06-01</date>
<time format="24">18:00</time>
<duration>1.5</duration>
<channel>54</channel>
</recordTV>
We can document this data in a table:
Represents a request to record a television program.
Element | Description | Type | Required | Notes |
---|---|---|---|---|
recordTV | Top level | TV program data | Required | |
date | Date of the program | string | Optional | Format is YYYY-MM-DD HH:MM:SS. Default value is today's date. |
time | Time the program begins | number | Required | Attributes: format has values 24 or 12 for 24 or 12 hour formats. Format is HH:MM, with am or pm afterwards for 12 hour format |
Using XML to document a request to record a TV program (part 2)
Let's say we have a different request to record a TV program. This time the XML has attributes:
<recordTV>
<when date="2015-06-01" time="18:00" format="24"/>
<duration hours="1.5"/>
<station channel="54"/>
</recordTV>
We can also document this data in a table:
Represents a request to record a television program.
Element | Attribute | Description | Type | Required | Notes |
---|---|---|---|---|---|
recordTV | Top level | TV program data | Required | ||
when | Date and time when the program starts | Required | |||
date | Date | string | Optional | Format is YYYY-MM-DD. Default value is today's date. | |
time | Time the program begins | string | Required | Format is HH:MM, with am or pm afterwards for 12 hour format | |
format | Format for the time: either 12 hour or 24 hour | string | Required | Valid values: 24 or 12 |
|
duration | hours | Length of the program | number | Required | In hours |
station | channel | Channel to record | number | Required |
Sources
- Learn API Technical Writing: JSON and XML for Writers by Peter Gruenbaum