DOCSEARCHbyAlgolia
Submit Docs

ADAM RMS API Documentation

website·Indexed 31 days ago

https://www.adam-rms.com/

API reference for ADAM RMS, providing endpoints for managing user accounts, instance configurations, project types, asset management, and CMS page content. Includes detailed request and response specifications for account security, OAuth linking with Google and Microsoft, and instance-level permission management.

Tokens
87.5K
Snippets
550
Records
928
Agent score
53%

What's inside ADAM RMS

  1. Overview of AdamRMS Rental Management System

    v1
    AdamRMS is a free, open-source advanced Rental Management System specifically designed for the Theatre, AV, and Broadcast industries. It provides a centralized platform to manage equipment (assets), projects, crew, finances, and locations.

  2. Overview of Adam RMS Asset and Project Management Features

    Adam RMS provides a comprehensive suite for managing assets, projects, and personnel. Key capabilities include:

    • Asset Management: Track assets across multiple sites and events to prevent clashing hires.
    • Project Management: Manage crewing, assets, finance, files, and invoices for specific events.
    • Asset Details: Store granular data for assets, including barcodes and purchase receipts.
    • Maintenance & Compliance: Track repair jobs and manage compliance certifications such as PAT and LOLER.
    • Ledger & Invoicing: Manage client payments and generate customizable invoices with part-payment support.
    • Permissions: Granular security controls to restrict staff or freelancer access to specific areas of the instance.
    • Categories & Groups: Organize assets into custom categories and groups with smart email notifications.
    • Training & Certification: Track employee accreditations and manage interactive online, in-person, or hybrid training modules.
    • CMS: Integrated Content Management System with visibility controls and a WYSIWYG page designer.
    • Recruitment: Internal platform for crew self-assignment, role applications via questionnaires, and CV uploads.
    • Public Embeds: Public-facing lists of crew vacancies that allow users to view positions without logging in.

  3. Overview of Custom Dashboards in AdamRMS

    v1
    Custom Dashboards allow administrators to replace the default widget-based dashboard and calendar with a specific CMS page for designated role groups. When a user logs in, the system checks their role group; if a custom dashboard is assigned, the CMS page content is displayed instead of the standard dashboard. Users without an assigned custom dashboard continue to see the default widgets and calendar.

  4. Overview of AdamRMS Rental Management System

    v1
    AdamRMS is a free, open-source advanced Rental Management System specifically designed for the Theatre, AV, and Broadcast industries. The platform provides a centralized system to manage equipment (assets), projects, crew, finances, and locations.

  5. Overview of the AdamRMS website and documentation structure

    v1
    The public marketing site and API documentation for the AdamRMS Rental Management System are built using Docusaurus. The source code for the website is located in the website/ directory of the main adam-rms/adam-rms GitHub repository. This co-location allows developers to include both API/feature changes and corresponding documentation updates within a single Pull Request (PR).

  6. Overview of the AdamRMS website and documentation architecture

    v1
    The public marketing site and API documentation for the AdamRMS Rental Management System are built using Docusaurus. The source code for the website is located in the website/ directory of the main adam-rms/adam-rms GitHub repository. This co-location allows developers to include both API/feature changes and their corresponding documentation updates within a single Pull Request (PR).

  7. Use the Business Calendar

    v1

    The Business Calendar provides an overview of all active (non-archived or non-deleted) projects, color-coded by status. It is accessible via the main Dashboard or the Business Utilities section.

    Key Capabilities:

    • View Modes: Switch between month, week, day, and list views.
    • Navigation: Click any project to go directly to its detail page.
    • Customization: Project statuses are displayed next to names (configurable in Business Settings). Week numbers can be customized using 'Week Labels' in Business Settings.
    • Export: The calendar can be exported to Google Calendar, Apple Calendar, or Outlook via the account page.

  8. Understand the AdamRMS Asset Hierarchy

    v1
    AdamRMS uses a two-level system to track equipment. Asset Types act as a product catalogue, defining the general characteristics of a piece of equipment (e.g., '5m XLR Cable'). Individual Assets are the specific physical units owned by the business, each linked to an Asset Type and identified by a unique asset tag (e.g., 'A-0042').

  9. Manage dashboard statistics widgets

    v1

    Business stats widgets provide a high-level overview of business data and user tasks on the RMS dashboard. Widget selection is personal to each user. Note that if a role group has a Custom Dashboard assigned, the standard dashboard (and these widgets) will be replaced.

    Required Permission: BUSINESS:BUSINESS_STATS:VIEW

    Steps to manage widgets:

    1. Navigate to Business > Stats in the side menu.
    2. Click a widget to add it to your dashboard.
    3. Click an active widget again to remove it from your dashboard.

  10. Manage project basics and asset assignment requirements

    v1
    The project overview page provides basic project information and a comment log for updates (e.g., venue or date changes). To assign assets to a project, the following information must be configured: a Client, a Project Manager, a Venue, and Project Dates (including asset dispatch dates).

    Permissions required for editing project basics:

    • PROJECTS:EDIT:CLIENT
    • PROJECTS:EDIT:LEAD
    • PROJECTS:EDIT:DESCRIPTION_AND_SUB_PROJECTS
    • PROJECTS:EDIT:DATES
    • PROJECTS:EDIT:NAME
    • PROJECTS:EDIT:STATUS
    • PROJECTS:EDIT:ADDRESS

  11. Manage equipment manufacturers in AdamRMS

    v1
    Manufacturers in AdamRMS represent the companies that produce equipment. Every asset type is linked to a manufacturer to enable browsing by brand. The manufacturers page displays the manufacturer's Name, Website (link), and Notes. To view all assets associated with a specific manufacturer (including archived assets), click the eye icon next to the manufacturer entry to trigger a filtered search in the asset search tool.

  12. Track asset maintenance and compliance

    Use the Maintenance module to raise, manage, and track repair jobs and ensure compliance with standards such as PAT and LOLER.