About Us
Use the About Us screen to present Air Doctor mission and global service coverage.
The screen provides static company information and contains no input fields.
Screen contents:
- A title bar with About Us and a back control.
- A mission statement that describes the Air Doctor service purpose.
- A heading for service coverage.
- Three informational cards:
- 20,000 trusted doctors.
- Coverage in 75 countries.
- 3 visit types: clinic, home, or video.
When This Screen Appears
The screen appears when the host app or the Air Doctor module requests informational company content.
The screen does not participate in any clinical or appointment flow and does not access or modify user data.
Integration Level Behavior
| Level | Behavior |
|---|---|
| 1–2 | Air Doctor controls navigation. The screen appears inside the Air Doctor App shell. |
| 3–4 | The host app opens the screen through an Air Doctor navigation entry point. |
| 5–6 | The host app retrieves /api/v3/about-us and renders the content with its own UI. |
Workflow
This sequence describes the flow that loads and displays the About Us content.
- The host app or module requests the page.
- The SDK requests
/api/v3/about-us. - The SDK validates the page structure.
- The app displays the mission text and informational cards.
- The user selects the back control to exit the screen.
The workflow does not start authentication events and does not rely on appointment or profile context.
Validations
These scenarios describe how the app validates the About Us content.
| Scenario | App Behavior | SDK Output |
|---|---|---|
| The endpoint returns a valid page object. | The app displays all fields. | Returns a structured page object. |
| The endpoint returns partial content. | The app displays only valid fields. | Returns a partial page object. |
| The response does not match schema rules. | The app displays an error page. | Returns a schema validation error. |
| An authenticated session is required and does not exist. | The app displays the authentication entry point. | Returns an authentication error. |
Actions
These scenarios describe how the app uses the About Us screen.
| Scenario | App Behavior | SDK Output | Integration Notes |
|---|---|---|---|
| The host app or module opens the screen. | The app loads the page content. | Returns the page object. | Levels 1–2: Air Doctor controls navigation. Levels 3–6: The host app triggers the screen. |
| The user selects the back control. | The app exits the screen. | Emits a navigation event, if enabled. | Levels 3–6: Partners receive the event. |
| The endpoint contains updated values. | The app displays the updated values. | Returns an updated page object. | Partners do not store static content. |
| The request fails because the device is offline. | The app displays an offline or error page. | Returns a network error. | Levels 5–6: The host app manages offline behavior. |
Endpoint Resources
Use this endpoint to retrieve the About Us page content.
Update About Us Content
PUT
/api/v3/about-us
This endpoint updates the page content for the About Us screen. The response always includes a complete page object that follows the internal page layout rules.