The Traveller Map - Poster/POST Example

Explanation

The Poster API supports the HTTP POST method for submitting custom sector data for rendering. Three variations are supported:

Usage:

http://travellermap.com/Poster.aspx?sector=SECTORNAME[&scale=N][&subsector=X][&rotation=R][&options=O]

Parameters:

Notes:

POST text/plain Content

This cannot be done through a Web page except via XMLHttpRequest, which doesn't make a distinct demo than the examples below. However, it is the simplest format for most HTTP clients to work with.

POST File Attachment

  • POST with encoding type "multipart/form-data"
  • Sector data is specified as an attachment named "file"
  • Options specified in the URL query and/or POST variables
  • Content is assumed to be text/plain, but in the future additional content types may be supported (e.g. "x-application/x-traveller-sector-v5")
Sector data:
  • Metadata in XML format may optionally be specified as an attachment named "metadata"
  • For an example, see FarFrontiers.xml; an aggregate of the data may be seen at here (WARNING: large file!)
  • Use the SectorMetaData API to fetch the site's XML metadata for a given sector
XML Metadata:

Additional options:

Scale:
Subsector:
Rotation:
Options:
Hex Numbers:
Style:
Format:

POST Form Data

  • POST with encoding type "application/x-www-form-urlencoded"
  • Sector data is specified as HTML form field "data"
  • Options specified in the URL query and/or POST variables
  • XML Metadata may be specified as an optional "metadata" field
Sector Data:
Metadata:

Additional options:

Scale:
Subsector:
Rotation:
Options:
Hex Numbers:
Style:
Format: