Yoobic Geofilters API
provides a mapping between users and the stores they have permission to visit- Each user may have more than one store mapped. If enabled, users could only book missions to the specified stores.- Geographic filters are extremely important in Operations. They are what control which stores a user can or can't see.- Geographic filters are assigned to stores and store types.- There are two types of geographic filters: non-dynamic and dynamic. Non dynamic filters are made by attaching stores to a user, dynamic filters are made by attaching store types to a user.- With the exception of Stores, geographic filters should always be dynamic. This is because it is easier to add a store to a type so that it inherits its geographic filter than it is to add a store to each geographic filter it needs to be in.### Fields| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`geofilter_id` | string | x | x | | Unique geofilter id ||`user_id` | string | x | | x | Unique user id ||`store_ids` | array | | | x | Unique store ids ||`store_client_ids` | array | | | | External unique ids of the stores as it may exists in your Information System||`store_type_names` | array | | | | The names of the store types ||`store_type_ids` | array | | | x | The ids of the store types ||`created_date` | date | | x | | Created Date ||`updated_date` | date | | x | x | Updated Date |One of either fields is required in order to resolve the mapping between a user and store/s:- store_ids- store_client_ids- store_type_ids- store_type_names
Yoobic Geofilters API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Geofilters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 8 operations across 6 paths, and defines 1 schema. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Geofilters API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
provides a mapping between users and the stores they have permission to visit - Each user may have more than one store mapped. If enabled, users could only book missions to the sp…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Default_Header (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.