Resources in ACME are people, places or equipment that are associated with an event.
For example:
- Person: Camp Guide, Educator, Driver, Docents, Tour Guides, etc.
- Places: Conference Rooms, Classrooms, Theaters, Kitchens, etc.
- Equipment : Projectors, Lecterns, Podiums, Chairs, Banquet Tables, etc.
TABLE OF CONTENTS |
List
Get /v1/b2b/resource/instances
Input:
resourceTemplateId: (Optional) The id of the resource template that you want the children of.
category: (Optional) The category of resources you want to list.
ownerID: (Optional) The owner of the resource.
Response:
A list of resources satisfying the given parameters.
Get
Get /v1/b2b/resource/instances/{id}
Input:
id: The id of the resource you are looking for
Response:
the corresponding Resource JSON object
Create
Post /v1/b2b/resource/instances
Body:
A Resource JSON object
Response:
The id of the newly created resource.
Update
Put /v1/b2b/resource/instances/{id}
Body:
A Resource JSON object
input:
Response:
The resulting Resource JSON object.
Delete
Delete /v1/b2b/resource/instances/{id}
input:
id: The id of the Resource you want to delete.
Response:
None
Summary
Put /v1/b2b/resource/instances/summary
input:
searchContent: the start of the name of the resource, this is for autocomplete.
Response:
A list of Resource Summary JSON object corresponding to the search criteria.
Resource JSON Objects
Resource Object
Field | Description |
|---|---|
| id | Unique ID of this resource. |
| name | Name of the resource. |
| description | Description of the resource. |
| resourceTemplateId | The id of the resource template. |
| resourceTemplateName | The resource template name. |
| createdOn | Time the resource was created. |
| createdBy | ID of the user who created the resource. |
| updatedOn | Time the resource was last updated. |
| updatedBy | ID of the user who updated the resource. |
| fields | List of fields for this resource template. |
| fields[x].name | The name of the field, like 'Language'. |
| fields[x].type | The type of field one of (StringType, StringArrayType, NumberType or NumberArrayType) |
| fields[x].stringValue | if the type is StringType, then this will hold the value. |
| fields[x].stringArrayValue | A list of strings, if the type if StringArrayType then this is the value of this field. |
| fields[x].numberValue | If the type is NumberType then this is the value. |
| fields[x].numberArrayValue | List of numbers, if the type is NumberArrayType then this is the value. |
| fields[x].minValue | Minimum value if the type is NumberType. |
| fields[x].maxValue | Maximum valid value if the type is NumberType. |
| fields[x].hidden | Boolean, true if you want the field hidden otherwise false. Default is false. |
| fields[x].fieldOrder | Order you want the fields displayed in. |
| resourceCategory | The category of resource. One of Personnel, Facilities, Equipment or Other |
| resourceUser | The user that's associated with this resource template. |
| resourceUser.userFirstName | Default first name for resources created with this template. |
| resourceUser.userLastName | Default last name for resources created with this template. |
| resourceCapacity | The category of resource template. One of Personnel, Facilities, Equipment or Other. |
| resourceCapacity.defaultCapacity | Default capacity for resource created by this resource. |
| resourceCapacity.minimumCapacity | Default minimum capacity for resources created by this resource. |
| resourceCapacity.maximumCapacity | Default maximum capacity for resources created by this resource. |
Resource Summary Object
Field | Description |
|---|---|
| id | Unique ID of this resource. |
| name | Name of the resource. |
| description | Description of the resource. |