Entities are a fancy way of saying “things.” In the ShootProof API all things are entities.
Entities are individual resources that are usually—but not always—part of a collection, and it’s through an entity’s collection resource that you’re able to list and create entities of that type.
Almost all entities in the ShootProof API share the following characteristics:
type property that identifies what kind of entity it is.links property that has self and collection properties as link relations.POST.GET.PUT or PATCH.DELETE.In its simplest form, a ShootProof entity looks like this:
{
"type": "entity-type",
"links": {
"self": {
"href": "https://api.shootproof.com/studio/entity/17df5170-b782-4cab-b5f0-451f7807eeb2"
},
"collection": {
"href": "https://api.shootproof.com/studio/entity"
}
}
}
The ShootProof API has many entity types to play with. Many entity types map directly to a ShootProof link relation of the same name.