Skip to main content

GET - Retrieving Resources

At a Glance
  • GET retrieves binary resources.
  • GET delivers icons, photos, and the Air Doctor font.
  • GET does not modify state.
  • Web clients reference resource URLs directly.
  • Native clients use an image or network library.
  • Use skip-font to request icon URLs.
  • Track font-version to apply updated fonts.

Images and icons shape the user interface and influence load speed and layout accuracy. The GET method retrieves binary resources from the Air Doctor platform such as icons, photos, media files, and the Air Doctor font that create this visual layer across client integrations.

Trigger Overview​

TriggerClient Action
Screen needs an image or iconRequest resource URL with GET
Screen needs the Air Doctor fontRequest font URL with GET
Font use disabled (skip-font)Request icon URLs with GET
GET Lifecycle Overview
[Screen loads]
      ↓
[Client reads resource URL]
      ↓
[GET Request]
      ↓
[Binary data arrives]
      ↓
[Client caches and displays asset]
Common Patterns
  • Appointment list uses doctor and clinic photos.
  • Profile cards use avatar images.
  • Icon-heavy layouts use font code points.
  • Brand-specific user interfaces use custom SVG icons with skip-font.

Icons and Photos​

Many screen elements show icons or photos such as doctor avatars or clinic images. In a web context, you do not call an API explicitly; instead you reference the resource URL directly. For example, set the src attribute of an <img> tag or a CSS background-image property to the URL that the server provides. The browser retrieves and caches the image automatically. On native platforms, you may use an image or networking library to fetch the image from its URL and cache control. Proper cache control reduces bandwidth use and latency.

note

Screen construction never depends on the image content. The server includes the aspect ratio in the element properties, so layout changes are not required while an image loads.

Practical Examples​

Image URL
<img src="https://cdn.air-dr.com/photos/doctor-123.jpg" />

Icon URL
https://cdn.air-dr.com/icons/example-stethoscope.svg

Font Code Point
"\uE132"

Font and Icon Handling​

Air Doctor icons arrive through two delivery options:

  1. Font code points - If your client installs the Air Doctor font, the server returns a code point for each icon. Your rendering engine maps this code point to the matching glyph in the font. This option reduces the number of separate image requests and simplifies style control.

  2. Icon references - If your client does not use the font, you can instruct the server to return icon references instead of code points. Add the skip-font directive when you call the server. In this mode, each icon arrives as a url to a GET endpoint.

Icon Selection Guide
  • Use font code points when you need a compact and consistent icon set.
  • Use icon URLs (skip-font) when you need custom artwork or multicolor assets.
  • Use SVG files for full-color or brand-specific icons.

Icon Format Types​

Monochrome vs. multicolor icons. The Air Doctor font contains monochrome glyphs. Multicolor icons always arrive as individual SVG files through their resource URL, independent of font use. If your design requires multicolor assets, reference the provided SVG files.

Custom Icon Substitution​

Replacing icons with your own. The server returns stable code points and does not reuse them. You can map each code point to your own icon set or custom font (never reuses code points). This enables substitution of Air Doctor icons with your own artwork while the data model remains compatible.

important

If your client does not use our font, include the skip-font directive and supply your own icon files.

Font Version Alignment​

Font version control. When you use the font, read the value of the font-version field from PUT responses. This value identifies the current font version in the server definitions.

If the version does not match your cached version, treat the local font as outdated and download the new version through its resource URL. Font updates occur infrequently, but this process keeps icon output consistent with the server definitions.

Do and Do Not

Do

  • Cache fonts and images.
  • Use skip-font when you provide custom icons.
  • Track font-version to detect updates.
  • Read aspect ratios for layout accuracy.

Do Not

  • Tie layout to image content.
  • Replace code points with random values.

Summary​

GET calls retrieve icons, photos, and the Air Doctor font. You can use code points through the Air Doctor font or load icon URLs by setting the skip-font directive. Track the font-version field to apply font updates. Correct cache control improves performance and reduces network use.