Facility
Find facilities
Get a list of facilities.
const response = await geocore.Facility.find({
area: {
north: 1,
south: 2,
west: 3,
east: 4,
};
});
Prerequisites
Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.
Parameters
name type data type description area[north] required number Longitude of north west point area[south] required number Latitude of north west point area[west] required number Longitude of north east point area[east] required number Latitude of north east point
Create facility
Create a new facility.
const formData = new FormData();
formData.append('title', title);
formData.append('name', name);
formData.append('description', description);
formData.append('color', color);
formData.append('location[type]', 'Point');
formData.append('location[coordinates]', 12);
formData.append('location[coordinates]', 34);
formData.append('photo', photoFile);
const response = await geocore.Facility.create(formData);
Prerequisites
Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.
Parameters
name type data type description title required string Facility title name required string Facility name description required string Facility description color required string Facility color location[type] required string Value must be "Point" location[coordinates] required array<number> Location of facility photo required string Photo files of facility
Image notes
- Maximum number of photos allowed is 10.
- When uploading a facility photo, that photo will be resized in 2 sizes: small (width 300px) and medium (width 1200px).
- These resized images path will be stored in the database.
- Only photos with width larger than these sizes will be resized.
Update facility
Update a facility.
const formData = new FormData();
formData.append('title', title);
formData.append('name', name);
formData.append('description', description);
formData.append('color', color);
formData.append('location[type]', 'Point');
formData.append('location[coordinates]', 12);
formData.append('location[coordinates]', 34);
formData.append('photo', photoFile);
const response = await geocore.Facility.update(facilityId, formData);
Prerequisites
Successfully get the IdToken with companyAdmin, groupAdmin or user access level from login API.
Parameters
name type data type description facilityId required string Facility ID title required string Facility title name required string Facility name description required string Facility description color required string Facility color location[type] required string Value must be "Point" location[coordinates] required array<number> Location of facility retainedPhotoIds[] required array<string> Photo IDs that user wants to keep photo required string New photo files of facility
Delete facility
Import facilities
Import facilities from a CSV file.
const formData = new FormData();
formData.append('csv', csvFile);
const response = await geocore.Facility.import(formData);
Prerequisites
Successfully get the IdToken with companyAdmin access level from login API.
Parameters
name type data type description csv required string CSV file with facility information