AdamRMS API (1.0.0)
AdamRMS is a free, open source advanced Rental Management System for Theatre, AV & Broadcast. This is the API listing for the v1 API, which is currently in Production and active development. You can find out more about AdamRMS at https://adam-rms.com.
Permission Management
Manage user pemissions Requires RMS permission 13
query Parameters
| action required | string DELETE, EDIT or new |
| users_userid required | string The ID of the user |
| userPositions_id required | string The ID of the user's position |
Responses
Response samples
- 200
{- "result": true,
- "message": [ ]
}Instance Permission Editor
Edit the permissions of a position
Requires Instance Permission 12 (Edit roles permissions [SUPER ADMIN])
query Parameters
| position required | number Position id |
| removepermission | number Permission id to remove |
| addpermission | number Permission id to add |
Responses
Response samples
- 200
1AdamRMS Permission Editor
Edit the permissions of an AdamRMS position
Requires RMS Permission 12 (Edit roles permissions [SUPER ADMIN])
query Parameters
| position required | number Position id |
| removepermission | number Permission id to remove |
| addpermission | number Permission id to add |
Responses
Response samples
- 200
1Archive an Asset
Archives an asset
Requires Instance Permission 97 (Archive Asset)
query Parameters
| assets_id required | integer The ID of the asset to archive |
| reason | string The reason for archiving the asset |
| date | string <date> The date the asset was archived, usually today |
Responses
Response samples
- 200
- default
{- "result": true,
- "message": [ ]
}Search for Assets
Performs a deep search for assets
query Parameters
| projectid | integer a project_id to check if assets are available for |
| public | boolean Determines what asset listing should be returns |
| dates | string Two dates to check availability between, separated with a - |
| instance_id required | integer the instance to search in |
| page required | integer The page of results to return |
| page_limit required | number The number of results to return per page |
| sort required | string How to sort the results |
| category | string The Asset Category to filter by |
| keyword | string A keyword to search for |
| manufacturer | string A manufacturer to filter by |
| group | string An Asset Group to filter by |
| showlinked | integer Whether to include linked assets |
| showarchived | integer Whether to include archived assets |
| tags | string Asset Tag(s) to search for |
| html | string Whether to return a HTML card listing or JSON data |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": null
}Edit an Asset Type's Definable Fields
Edits an asset type's definable fields
Requires Instance Permission 58 (Edit Asset Type)
query Parameters
required | object The data to update the asset type's definable fields with |
Responses
Response samples
- 200
- default
{- "result": true,
- "message": [ ]
}Get Asset Type Data
Gets data for an asset type
query Parameters
| term required | integer The ID of the asset type to get data for |
Responses
Response samples
- 200
- default
{- "result": true,
- "assetType": {
- "assetTypes_id": 0,
- "assetTypes_name": "string",
- "assetCategories_id": 0,
- "assetTypes_productLink": "string",
- "manufacturers_id": 0,
- "assetTypes_description": "string",
- "assetTypes_definableFields": "string",
- "assetTypes_mass": 0,
- "assetTypes_inserted": "string",
- "assetTypes_value": "string",
- "assetTypes_dayRate": 0,
- "assetTypes_weekRate": 0
}
}List Assets
Lists assets
query Parameters
| term | string A search term to filter the list by |
| page | integer The page number to get |
| pageLimit | integer The number of items to get per page |
| category | integer The ID of the asset category to filter by |
| manufacturer | integer The ID of the manufacturer to filter by |
| assetTypes_id | integer The ID of the asset type to filter by |
| all | any Whether to get all linked assets |
| abridgedList | boolean Whether to get file and flags & blocks |
Responses
Response samples
- 200
{- "result": true,
- "assets": [
- {
- "assets_id": 0,
- "assets_name": "string",
- "assetTypes_id": 0,
- "assetTypes_name": "string",
- "assetCategories_id": 0,
- "assetCategories_name": "string",
- "manufacturers_id": 0,
- "manufacturers_name": "string",
- "assets_description": "string",
- "assets_serialNumber": "string",
- "assets_barcode": "string",
- "assets_value": "string",
- "assets_dayRate": 0,
- "assets_weekRate": 0,
- "assets_monthRate": 0,
- "assets_yearRate": 0,
- "assets_mass": 0,
- "assets_productLink": "string",
- "assets_inserted": "string",
- "assets_updated": "string",
- "assets_deleted": "string",
- "assets_status": "string",
- "assets_flags": null
}
], - "pagination": 0
}Create Asset From Type
Creates an asset from an asset type Requires Instance Permission 17 (Create Asset)
query Parameters
required | object The data to create the asset from |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": {
- "assets_id": 0,
- "assets_tag": "string",
- "assetTypes_id": 0
}
}Simple Asset Search Deprecated
Searches for assets by tag or name
Deprecated, use /assets/deepSearch.php instead
query Parameters
| term | string The term to search for |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [
- {
- "tag": "string",
- "assets_id": 0,
- "assets_tag": "string",
- "assetTypes_name": "string",
- "assetTypes_id": 0,
- "assetCategories_name": "string",
- "assetCategoriesGroups_name": "string",
- "manufacturers_name": "string"
}
]
}Asset Type Search
Searches for asset types by name or manufacturer
query Parameters
| term | string The term to search for |
| manufacturer | string The manufacturer to search for |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [
- {
- "assetTypes_name": "string",
- "assetTypes_id": 0,
- "assetCategories_name": "string",
- "assetCategoriesGroups_name": "string",
- "manufacturers_name": "string"
}
]
}Get Swappable Assets
Gets a list of assets that can be swapped with the given asset assignment
query Parameters
| assetsAssignments_id required | integer The ID of the asset assignment |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [
- {
- "assets_id": 0,
- "assets_tag": "string",
- "asset_definableFields_1": "string"
}
]
}Assign Barcode
Assign a barcode to an asset
Requires Instance Permission 88 (Associate barcodes with an Asset)
query Parameters
| tag required | string The tag of the Asset to assign a barcode to |
required | number or boolean An ID of an existing barcode or false |
| text | string the value of a new barcode |
| type | string The Barcode type |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": {
- "type": null,
- "properties": null
}
}Barcode Asset Search
Search for an Asset using a barcode
query Parameters
| text required | string The barcode value |
| type required | string The barcode type |
| locationType | string What the location is |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": {
- "asset": { },
- "assetSuggest": { },
- "barcode": "string",
- "location": { }
}
}Remove Asset from Group
Remove an asset from a group
Requires Instance Permission 96 (Add/Remove group members)
query Parameters
| assetGroups_id required | integer The group id |
| assets_id required | integer The asset id |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [ ]
}Add Asset
Add an asset to a maintenance job
Requires Instance Permission 74 (Add Assets to Job)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| maintenanceJobs_assets required | Array of arrays Maintenance Job Assets |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Change Block
Change the block status of a maintenance job
Requires Instance Permission 79 (Make job block asset assignments)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| maintenanceJobs_blockAssets required | boolean Maintenance Job Block |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Change Due Date
Change the due date of a maintenance job
Requires Instance Permission 67 (Change Due Date)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| maintenanceJobs_timestamp_due required | string Maintenance Job Due Date |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Change Job Assigned
Change who a maintenance job is assigned to
Requires Instance Permission 68 (Change Assigned To)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| users_userid required | number Who the maintenance job is assigned to |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Change Job Status
Change the status of a maintenance job
Requires Instance Permission 73 (Change Status)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| maintenanceJobsStatuses_id required | number Maintenance Job Status id |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Change Name
Change the name of a maintenance job
Requires Instance Permission 70 ( Edit Job Name)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| maintenanceJobs_title required | string Maintenance Job Name |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Change Priority
Change the priority of a maintenance job
Requires Instance Permission 77 (Change Priority)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| maintenanceJobs_priority required | number Maintenance Job Priority |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Remove Asset
Remove an asset from a maintenance job
Requires Instance Permission 75 ( Remove Assets from Job)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| assets_id required | number Asset ID |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Send Message
Send a message to a maintenance job
Requires Instance Permission 71 (Add message to job)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| maintenanceJobsMessages_text required | string Message |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Untag User
Untag a user from a maintenance job
Requires Instance Permission 69 (Edit users tagged in job)
query Parameters
| maintenanceJobs_id required | number Maintenance Job ID |
| users_userid required | number User ID |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Change Description
Change the description of a project
Requires Instance Permission 24 (Change Project Description & Sub Projects)
query Parameters
| projects_id required | number Project ID |
| projects_description required | string Project Description |
Responses
Response samples
- 200
nullChange Project Dates
Change the start and end dates of a project
Requires Instance Permission 27 (Change Project Dates)
query Parameters
| projects_id required | number Project ID |
| projects_dates_use_start required | string Start Date/Time |
| projects_dates_use_end required | string End Date/Time |
Responses
Response samples
- 200
nullChange Project Deliver Dates
Change the start and end deliver dates of a project
Requires Instance Permission 27 (Change Project Dates)
query Parameters
| projects_id required | number Project ID |
| projects_dates_deliver_start required | string Start Date/Time |
| projects_dates_deliver_end required | string End Date/Time |
Responses
Response samples
- 200
nullEdit Note
Edit a project note
Requires Instance Permission 44 (Edit Project Notes)
query Parameters
| projects_id required | number Project ID |
| projectsNotes_id required | number Project Note Id |
| projectsNotes_text required | string Project Note Text |
Responses
Response samples
- 200
nullFollow Parent Status
Change whether a project follows the status of its parent project
Requires Instance Permission 21 (Create Project)
query Parameters
| projects_id required | number Project ID |
| follow required | boolean Follow Parent Status |
Responses
Response samples
- 200
nullNew
Create a new project
Requires Instance Permission 21 (Create Project)
query Parameters
| projects_name required | string Project Name |
| projects_manager required | number Project Manager User ID |
| projectsType_id required | number Project Type ID |
| projects_parent_project_id | number Parent Project ID |
Responses
Response samples
- 200
nullAssign Asset to Project
Assign an asset to a project
Requires Instance Permission 31 (Assign/unassign asset to Project)
query Parameters
| projects_id required | number Project ID |
| assetGroups_id | number Asset Group ID |
| assets_id | number Asset ID |
Responses
Response samples
- 200
nullSet Asset Assignment Comment
Set the comment for an asset assignment
Requires Instance Permission 41 (Edit asset assignment comment)
query Parameters
| assetsAssignments required | Array of numbers Asset Assignment IDs |
| assetsAssignments_comment required | string Comment |
Responses
Response samples
- 200
nullSet Asset Assignment Discount
Set the discount for an asset assignment
Requires Instance Permission 43 (Edit asset assignment discount)
query Parameters
| assetsAssignments required | Array of numbers Asset Assignment IDs |
| assetsAssignments_discount required | number Discount amount |
Responses
Response samples
- 200
nullSet Asset Assignment Price
Set the price for an asset assignment
Requires Instance Permission 42 (Edit asset assignment price)
query Parameters
| assetsAssignments required | Array of numbers Asset Assignment IDs |
| assetsAssignments_customPrice required | number Price |
Responses
Response samples
- 200
nullSet Asset Assignment Status
Set the status for an asset assignment
Requires Instance Permission 53 (Change the assignment status for an asset (e.g. mark as packed))
query Parameters
| assetsAssignments_status required | number Status |
| assetsAssignments_id required | number Asset Assignment ID |
| projects_id required | number Project ID |
| status_is_order | boolean Whether the status is an ordering rather than a status |
Responses
Response samples
- 200
nullSet Asset Assignment Status using Barcode
Set the status for an asset assignment using a barcode
Requires Instance Permission 53 (Change the assignment status for an asset (e.g. mark as packed))
query Parameters
| text required | string barcode value |
| type required | string barcode type |
| locationType required | enum Enum: "barcode" "asset" "Custom" location type |
| projects_id required | number Project ID |
| assetsAssignments_status required | number Status ID |
Responses
Response samples
- 200
nullUnassign Asset
Unassign an asset from a project
Requires Instance Permission 31 (Assign/unassign asset to Project)
query Parameters
| assetsAssignments required | Array of numbers Asset Assignment IDs |
| assets_id required | number Asset ID |
| projects_id | number Project ID |
Responses
Response samples
- 200
nullAdd User to Instance
Add a user to an instance
Requires Instance Permission 3 (Add a user to a business by EMail)
query Parameters
| rolegroup required | number The instance position id |
| rolename required | string The role name |
| users required | Array of numbers The user ids |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [ ]
}Edit User
Edit a user's role
Requires Instance Permission 6 (Change the role of a user in a business)
query Parameters
| userinstanceid required | number The userinstance id |
| position required | number The user's position id |
| label required | string The user's role label |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [ ]
}Create Instance
Create a new instance
Requires RMS Permission 8 (Create Instance)
query Parameters
| instances_name required | string The instance name |
| instances_website required | string The instance website |
| instances_email required | string The instance email |
| instances_phone required | string The instance phone number |
| role required | number The user's role id |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": {
- "instanceid": 0
}
}Edit Asset Assignment Status
Edit an asset assignment status
Requires Instance Permission 83 (Edit business settings)
query Parameters
| statusId required | integer The status id |
| statusName required | string The status name |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [ ]
}Create Asset Assignment Status
Create an asset assignment status
Requires Instance Permission 83 (Edit business settings)
query Parameters
| statusName required | string The status name |
| statusOrder required | integer The status order |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [ ]
}Rollback CMS Page Content
Rollback a page content
Requires Instance Permission 126 (Edit Page Content)
query Parameters
| cmsPages_id required | integer The ID of the page |
| change required | string The description of the change |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [ ]
}Edit CMS Page Content
Edit a page content
Requires Instance Permission 126 (Edit Page Content)
query Parameters
| cmsPages_id required | integer The ID of the page |
| pageData required | string The page data |
| changelog required | string The description of the change |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}Set Custom Dashboard
Set a custom dashboard
Requires Instance Permission 126 (Edit Page Data)
query Parameters
| instancePositions_id required | number instance position for the dashboard |
| cmsPages_id required | number The page id |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": [ ]
}Get File
Get a file
query Parameters
| f required | integer The file id |
| s | string | boolean The file size |
| d | boolean should a download be forced or should it be displayed in the browser? (if set it will download) |
| r | boolean should the url be returned by the script as plain text or a redirect triggered? (if set it will redirect) |
| e | boolean when should the link expire? Must be a string describing how long in words basically. If this file type has security features then it will default to 1 minute. |
Responses
Response samples
- 200
- default
{- "result": true,
- "response": { }
}v1 notification endpoints
These endpoints are not accessible from the web, and are instead used internally.
Upload Success
Upload a file to S3
query Parameters
| name required | string File Name |
| size required | number File Size |
| typeid required | number File Type ID |
| subtype | number File Subtype |
| orignalName required | string Original File Name |
| public required | boolean Public File |
Responses
Response samples
- 200
{- "result": true,
- "response": { }
}