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:

id:  The id of the resource you are updating.

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
Notes
Field
Description
Notes
idUnique ID of this resource. 
nameName of the resource. 
descriptionDescription of the resource. 
resourceTemplateIdThe id of the resource template. 
resourceTemplateNameThe resource template name. 
createdOnTime the resource was created. 
createdByID of the user who created the resource . 
updatedOnTime the resource was last updated. 
updatedByID of the user who updated the resource. 
fieldsList of fields for this resource template 
fields[x].nameThe name of the field, like 'Language'. 
fields[x].typeThe type of field one of (StringType, StringArrayType, NumberType or NumberArrayType) 
fields[x].stringValueif the type is StringType, then this will hold the value. 
fields[x].stringArrayValueA list of strings, if the type if StringArrayType then this is the value of this field. 
fields[x].numberValueIf the type is NumberType then this is the value. 
fields[x].numberArrayValueList of numbers, if the type is NumberArrayType then this is the value. 
fields[x].minValueMinimum value if the type is NumberType. 
fields[x].maxValueMaximum valid value if the type is NumberType. 
fields[x].hiddenBoolean, true if you want the field hidden otherwise false. Default is false. 
fields[x].fieldOrderOrder you want the fields displayed in. 
resourceCategoryThe category of resource.  One of Personnel, Facilities, Equipment or Other 
resourceUserThe user that's associated with this resource template. 
resourceUser.userFirstNameDefault first name for resources created with this template. 
resourceUser.userLastNameDefault last name for resources created with this template. 
resourceCapacityThe category of resource template.  One of Personnel, Facilities, Equipment or Other. 
resourceCapacity.defaultCapacityDefault capacity for resource created by this resource. 
resourceCapacity.minimumCapacityDefault minimum capacity for resources created by this resource. 
resourceCapacity.maximumCapacityDefault maximum capacity for resources created by this resource. 

Resource Summary Object

Field
Description
Notes
idUnique ID of this resource. 
nameName of the resource. 
descriptionDescription of the resource.