devicemagic/forms_api_docs

Device Magic API

The API expects all data to be UTF-8 encoded. This is a REST-style API that uses JSON/XML with Basic Authentication. All requests start with the https://api.devicemagic.com/ base URL.

Authentication

https://docs.devicemagic.com/en/articles/392931-authentication

Response Codes

https://docs.devicemagic.com/en/articles/3334936-api-response-codes

2xx Success
- 200 Ok
- 201 Created
- 202 Accepted
- 204 No Content
3xx Redirection
- 304 Not Modified
4xx Client Error
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 422 Unprocessable Entity
5xx Server Error
- 500 Internal Server Error

Endpoints

Destination
- GET View Destinations on a Form
  - GET /api/forms/:form_id/destinations.json
- GET View Destination details
  - GET /api/forms/:form_id/destinations/:destination_id.json
- POST create a destination
  - POST /api/forms/:form_id/destinations.json
- PUT update a destination
  - PUT /api/forms/:form_id/destinations/:destination_id.json
- DELETE Destroying a Destination
  - DELETE /api/forms/:form_id/destinations/:destination_id.json
Device
- GET all organization devices
  - GET /api/v2/organizations/:organization_id/devices.(json|xml)
- GET organization device
  - GET /api/v2/organizations/:organization_id/devices/:device_id.json
- POST approving a device
  - POST /api/organizations/[org_id]/devices
- DELETE removing a device
  - DELETE /api/organizations/[org_id]/devices/:device_id
- PUT update device
  - PUT /api/organizations/[org_id]/devices/:device_id
Dispatch
- GET all dispatch authors
  - GET /api/v3/dispatch_authors.(json|xml)
- GET index of dispatch forms for device or user
  - GET /api/v3/devices/:device_identifier/dispatches.(json|xml)
  - GET /api/v3/users/:user/dispatches.(json|xml)
- GET organization dispatches
  - GET /api/v3/organization_dispatches.(json|xml)
- GET show a dispatch form for device or user
  - GET /api/v3/devices/:device_identifier/dispatches/:dispatch_id.(json|xml)
  - GET /api/v3/users/:user/dispatches/:dispatch_id.(json|xml)
- POST create dispatch form for a device or user
  - POST /api/v3/devices/:device_identifier/dispatches.json
  - POST /api/v3/users/:user/dispatches.json
- PATCH update a dispatch form for a device or user
  - PATCH /api/v3/devices/:device_identifier/dispatches/:dispatch_id.json
  - PATCH /api/v3/users/:user/dispatches/:dispatch_id.json
- DELETE destroy dispatch for a device or user
  - DELETE /api/v3/dispatchs/:dispatch_id.json
  - DELETE /api/v3/dispatchs/:user_id.json
- POST destroy all dispatch forms for a device or user
  - POST /api/v3/devices/:device_identifier/dispatches/destroy_all.json
  - POST /api/v3/users/:user/dispatches/destroy_all.json
Form
- GET list forms
  - GET /organizations/:organization_id/forms.(xml|json)
- GET Form Definition
  - GET /organizations/:organization_id/forms/:form_id.(xml|json)
- POST create form
  - POST /organizations/:organization_id/forms.(xml|json)
- PUT update form
  - PUT /organizations/:organization_id/forms/:form_id.(xml|json)
- DELETE destroy form
  - DELETE /organizations/:organization_id/forms/:form_id
- POST Updating a Form’s Group
  - POST /organizations/:organization_id/forms/:form_id/properties.(xml|json)
- PUT Locking a form
  - PUT api/v3/forms/:form_id/lock
- PUT Unocking a form
  - PUT api/v3/forms/:form_id/unlock
Group
- GET all organization groups
  - GET /api/v2/organizations/:organization_id/groups.(json|xml)
- POST create a group
  - POST /api/organizations/[org_id]/groups
- PUT update a group
  - PUT /api/organizations/[org_id]/groups/:group_id
- DELETE destroy a group
  - DELETE /api/organizations/[org_id]/groups/:group_id
Report
- GET Performance Metric Report
  - GET /api/performance_metric_report
Resource
- GET list resources
  - GET /api/resources
- GET download a resource
  - GET /api/resources/:resource_id
- GET describe a resource
  - GET /api/v3/resources/:resource_id/describe
- POST create a resource
  - POST /api/v3/resources
- PUT update a resource
  - PUT /api/v3/resources/:resource_id
- DELETE destroy a resource
  - DELETE /api/resources/:resource_id
Submission
- GET view submissions in Device Magic Database
  - GET /api/forms/:form_id/device_magic_database.json
- GET all submission authors
  - GET /api/v3/submission_authors.(json|xml)
- GET original submission xml
  - GET /api/v3/submissions/:user_id
- POST create submission from a form for a device or user
  - POST /api/v3/devices/:device_identifier/submissions.json
  - POST /api/v3/users/:user/submissions.json
Submission Image
- POST create submission image
  - POST /api/v3/devices/:device_identifier/submissions_image
  - POST /api/v3/devices/:user/submissions_image
- GET get image md5
  - GET /api/v3/devices/:device_identifier/submission_images/:image_identifier/get_md5
  - GET /api/v3/users/:user_id/submission_images/:image_identifier/get_md5