What are objects and what do they do?

Simply put, objects provide the substance of your API information. All of the endpoints within the Asset Panda API contain operation objects (methods) that are telling the API what to do (GET, PUT, POST, DELETE).

This however, is just the bread for the sandwich. We must add to the bread to actually create the sandwich. Each object adds an extra piece of goodness. Otherwise, you may not want to eat it. Think of the API has the same. You may not find it overly useful without the goodness added to it.

We add the sandwich contents with parameters objects. These objects contain arrays with these properties that are assigned to them within the API.

We've provided some object types below, along with examples of what they do within the Asset Panda application to help you understand what they do.

Action Objects

Asset Panda action objects are objects that pertain specifically to actions within groups. An instance where they would be used within this API is when you're creating actions for a specific group.

Basically, action objects allow you the ability to filter through objects to find where specific actions have been performed.

How would I use it?

Each action contains objects that help users to keep track of what is happening with different assets. Let's say you provide loaner laptops to those employees who have turned in their regular equipment for repair or maintenance. Action objects will allow you to filter through specific actions that have occurred with these laptops.

In this example, you have a Request Asset action (shown below). Within this action, you have objects that allow you to keep track of specific information when (or even before) requesting a specific loaner laptop.

For instance, do you want to create an auto return option? Can users upload attachments with this laptop and so forth.

Examples of updateable action objects are (but not limited to):

name
type
is_returnable
deactivate_depreciation

The New Action screen below will give you a good idea on how these specific object types are used within the Asset Panda application itself, along with what they do.

User Objects

User objects are those fields that pertain specifically to the user and are used in instances such as creating new accounts. They are usually exactly as the name implies.

How would I use it?

Let's say you want to create a new user. You can attempt to create a new account but it's not going to do you much good without specific user information. This is where user objects enter the picture. You are entering objects for a specific user.

Some of these objects are (but not limited to):

first_name
email
password