Notes | Graniot API

get

Responses

200Success

application/json

get

GET /api/notes/ HTTP/1.1
Host: 
Accept: */*

200Success

[
  {
    "id": 1,
    "user": {
      "id": 1,
      "username": "text",
      "first_name": "text",
      "last_name": "text"
    },
    "attachments": [
      {
        "id": 1,
        "attachment": "https://example.com",
        "created": "2025-07-08T06:35:13.027Z",
        "modified": "2025-07-08T06:35:13.027Z",
        "note": 1
      }
    ],
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "reference_date": "2025-07-08T06:35:13.027Z",
    "note": "text",
    "geom": {
      "type": "GeometryCollection",
      "coordinates": [
        {
          "type": "Point",
          "coordinates": [
            12.9721,
            77.5933
          ]
        }
      ]
    },
    "parameters": null,
    "geometry": null,
    "created": "2025-07-08T06:35:13.027Z",
    "modified": "2025-07-08T06:35:13.027Z",
    "parcel": 1
  }
]

post

Body

idintegerRead-onlyRequired

keystring · uuidRead-onlyRequired

reference_datestring · date-time | nullableOptional

notestring · max: 2048Required

parametersany | nullableOptional

geometryany | nullableOptional

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

parcelintegerRequired

Responses

201Success

application/json

post

POST /api/notes/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "user": {
    "username": "text",
    "first_name": "text",
    "last_name": "text"
  },
  "attachments": [
    {
      "attachment": "https://example.com",
      "note": 1
    }
  ],
  "reference_date": "2025-07-08T06:35:13.027Z",
  "note": "text",
  "geom": {
    "type": "GeometryCollection",
    "coordinates": [
      {
        "type": "Point",
        "coordinates": [
          12.9721,
          77.5933
        ]
      }
    ]
  },
  "parameters": null,
  "geometry": null,
  "parcel": 1
}

201Success

{
  "id": 1,
  "user": {
    "id": 1,
    "username": "text",
    "first_name": "text",
    "last_name": "text"
  },
  "attachments": [
    {
      "id": 1,
      "attachment": "https://example.com",
      "created": "2025-07-08T06:35:13.027Z",
      "modified": "2025-07-08T06:35:13.027Z",
      "note": 1
    }
  ],
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "reference_date": "2025-07-08T06:35:13.027Z",
  "note": "text",
  "geom": {
    "type": "GeometryCollection",
    "coordinates": [
      {
        "type": "Point",
        "coordinates": [
          12.9721,
          77.5933
        ]
      }
    ]
  },
  "parameters": null,
  "geometry": null,
  "created": "2025-07-08T06:35:13.027Z",
  "modified": "2025-07-08T06:35:13.027Z",
  "parcel": 1
}

get

Path parameters

idstringRequired

Responses

200Success

application/json

get

GET /api/notes/{id}/ HTTP/1.1
Host: 
Accept: */*

200Success

{
  "id": 1,
  "user": {
    "id": 1,
    "username": "text",
    "first_name": "text",
    "last_name": "text"
  },
  "attachments": [
    {
      "id": 1,
      "attachment": "https://example.com",
      "created": "2025-07-08T06:35:13.027Z",
      "modified": "2025-07-08T06:35:13.027Z",
      "note": 1
    }
  ],
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "reference_date": "2025-07-08T06:35:13.027Z",
  "note": "text",
  "geom": {
    "type": "GeometryCollection",
    "coordinates": [
      {
        "type": "Point",
        "coordinates": [
          12.9721,
          77.5933
        ]
      }
    ]
  },
  "parameters": null,
  "geometry": null,
  "created": "2025-07-08T06:35:13.027Z",
  "modified": "2025-07-08T06:35:13.027Z",
  "parcel": 1
}

delete

Path parameters

idstringRequired

Responses

204

No response body

delete

DELETE /api/notes/{id}/ HTTP/1.1
Host: 
Accept: */*

204

No response body

No content