Admin Comment

---

Find admin comments

Get a list of admin comments.

const response = await geocore.AdminComment.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 admin comment

Create a new admin comment.

const response = await geocore.AdminComment.create({
  title: 'title',
  comment: 'comment',
  location: {
    type: 'Point',
    coordinates: [12, 34],
  },
});

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
title	required	string	Admin comment title
comment	required	string	Comment content
location[type]	required	string	Value must be "Point"
location[coordinates]	required	array<number>	Location of comment

Update admin comment

Update a admin comment.

const response = await geocore.AdminComment.update(
  adminCommentId,
  {
    title: 'title',
    comment: 'comment',
    location: {
      type: 'Point',
      coordinates: [12, 34],
    },
  },
);

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
adminCommentId	required	string	Admin comment ID
title	required	string	Admin comment title
comment	required	string	Comment content
location[type]	required	string	Value must be "Point"
location[coordinates]	required	array<number>	Location of comment

Delete admin comment

Delete a admin comment.

const response = await geocore.AdminComment.delete(adminCommentId);

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
adminCommentId	required	string	Admin comment ID

Import admin comments

Import admin comments from a CSV file.

const formData = new FormData();
formData.append('csv', csvFile);

const response = await geocore.AdminComment.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 admin comment information

Export admin comments

Export admin comments to a CSV file.

const response = await geocore.AdminComment.export(query);

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
query	required	string	Same as get admin comment query params