BrightSign Network Web API Reference Manual v.3.8 - Manual (Page 14)

2
Methods
The BSN Web API provides different methods to perform similar operations. It is possible, for example, to retrieve/update
either all or a specified subgroup of properties. This allows you to choose which methods suit your deployment best in
terms of usability, responsiveness, etc.
Entity Retrieval Methods
Currently, there are four types of entity retrieval method:
Get{EntityName(s)}
Methods of this type retrieve all entities of the corresponding type and return paged results with initialized parent
dependencies and/or usage indicators. For performance reasons, they do not return child entities. The page size is limited
to a certain number depending on the method.
The BrightSign Network Web API implements a markers-based approach similar to the Amazon REST 3 API: The client
specifies the marker (entity ID) of the starting element in the list, as well as the number of entities to receive. The server
will indicate whether the response is truncated (i.e. there are more elements that can be retrieved by the next request)
and provide the marker for the next object instance.
Note: If a client has retrieved a first page and is in the process of retrieving the second while another client adds, updates,
or removes two objects on different pages, the first client may receive an inconsistent state.
GetSpecified{EntityName(s)}
Methods of this type retrieve entities with specified keys. The results will not be paged; as a result, there is a limit on the
number of entities that can be requested. This type of method will initialize only parent dependencies.