RESTful API

Off road areas

Get offroadareas

Returns a set of data items of type offroadareas.

Copy GET /api/off-road-vehicle-map/offroadareas
Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

Email

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

URL

System.String

Read only: False

Gazetted

System.Boolean

Read only: False

Area

System.String

Read only: False

Year

System.String

Read only: False

Locality

System.String

Read only: False

ObjectCoordinates

System.String

Read only: False

Title

System.String

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2022-08-09T14:28:42.8902328Z",
    "PublicationDate": "2022-08-09T14:28:42.8902328Z",
    "DateCreated": "2022-08-09T14:28:42.8902328Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "Email": "sample string 6",
    "MarkerInformation": "sample string 7",
    "Location": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "CountryCode": "sample string 2",
      "StateCode": "sample string 3",
      "City": "sample string 4",
      "Zip": "sample string 5",
      "Street": "sample string 6",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "MapZoomLevel": 1
    },
    "URL": "sample string 8",
    "Gazetted": true,
    "Area": "sample string 10",
    "Year": "sample string 11",
    "Locality": "sample string 12",
    "ObjectCoordinates": "sample string 13",
    "Title": "sample string 14",
    "Provider": "sample string 15"
  },
  {
    "LastModified": "2022-08-09T14:28:42.8902328Z",
    "PublicationDate": "2022-08-09T14:28:42.8902328Z",
    "DateCreated": "2022-08-09T14:28:42.8902328Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "Email": "sample string 6",
    "MarkerInformation": "sample string 7",
    "Location": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "CountryCode": "sample string 2",
      "StateCode": "sample string 3",
      "City": "sample string 4",
      "Zip": "sample string 5",
      "Street": "sample string 6",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "MapZoomLevel": 1
    },
    "URL": "sample string 8",
    "Gazetted": true,
    "Area": "sample string 10",
    "Year": "sample string 11",
    "Locality": "sample string 12",
    "ObjectCoordinates": "sample string 13",
    "Title": "sample string 14",
    "Provider": "sample string 15"
  }
]

Get offroadareas by key

Gets offroadareas item by id.

Copy GET /api/off-road-vehicle-map/offroadareas({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

Email

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

URL

System.String

Read only: False

Gazetted

System.Boolean

Read only: False

Area

System.String

Read only: False

Year

System.String

Read only: False

Locality

System.String

Read only: False

ObjectCoordinates

System.String

Read only: False

Title

System.String

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2022-08-09T14:28:42.9058269Z",
  "PublicationDate": "2022-08-09T14:28:42.9058269Z",
  "DateCreated": "2022-08-09T14:28:42.9058269Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "Email": "sample string 6",
  "MarkerInformation": "sample string 7",
  "Location": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "CountryCode": "sample string 2",
    "StateCode": "sample string 3",
    "City": "sample string 4",
    "Zip": "sample string 5",
    "Street": "sample string 6",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "MapZoomLevel": 1
  },
  "URL": "sample string 8",
  "Gazetted": true,
  "Area": "sample string 10",
  "Year": "sample string 11",
  "Locality": "sample string 12",
  "ObjectCoordinates": "sample string 13",
  "Title": "sample string 14",
  "Provider": "sample string 15"
}

Get property

Gets Id property from offroadareas item.

Copy GET /api/off-road-vehicle-map/offroadareas({key})/property
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

property

System.String

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Id

System.Guid

Read only: False

Resource Format

Response Formats
Copy
application/json
{
  "Id": "599d00f3-07d0-4cc8-96b4-91685c2454e9"
}

Post offroadareas

Creates a offroadareas item.

Copy POST /api/off-road-vehicle-map/offroadareas
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

Email

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

URL

System.String

Read only: False

Gazetted

System.Boolean

Read only: False

Area

System.String

Read only: False

Year

System.String

Read only: False

Locality

System.String

Read only: False

ObjectCoordinates

System.String

Read only: False

Title

System.String

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2022-08-09T14:28:42.9214809Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "Email": "sample string 4",
  "MarkerInformation": "sample string 5",
  "Location": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "CountryCode": "sample string 2",
    "StateCode": "sample string 3",
    "City": "sample string 4",
    "Zip": "sample string 5",
    "Street": "sample string 6",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "MapZoomLevel": 1
  },
  "URL": "sample string 6",
  "Gazetted": true,
  "Area": "sample string 8",
  "Year": "sample string 9",
  "Locality": "sample string 10",
  "ObjectCoordinates": "sample string 11",
  "Title": "sample string 12"
}
Response Informaion

Resource Description

Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

Email

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

URL

System.String

Read only: False

Gazetted

System.Boolean

Read only: False

Area

System.String

Read only: False

Year

System.String

Read only: False

Locality

System.String

Read only: False

ObjectCoordinates

System.String

Read only: False

Title

System.String

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2022-08-09T14:28:42.9214809Z",
  "PublicationDate": "2022-08-09T14:28:42.9214809Z",
  "DateCreated": "2022-08-09T14:28:42.9214809Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "Email": "sample string 6",
  "MarkerInformation": "sample string 7",
  "Location": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "CountryCode": "sample string 2",
    "StateCode": "sample string 3",
    "City": "sample string 4",
    "Zip": "sample string 5",
    "Street": "sample string 6",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "MapZoomLevel": 1
  },
  "URL": "sample string 8",
  "Gazetted": true,
  "Area": "sample string 10",
  "Year": "sample string 11",
  "Locality": "sample string 12",
  "ObjectCoordinates": "sample string 13",
  "Title": "sample string 14",
  "Provider": "sample string 15"
}

Patch offroadareas by key

Partial update for offroadareas item.

Copy PATCH /api/off-road-vehicle-map/offroadareas({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

Email

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

URL

System.String

Read only: False

Gazetted

System.Boolean

Read only: False

Area

System.String

Read only: False

Year

System.String

Read only: False

Locality

System.String

Read only: False

ObjectCoordinates

System.String

Read only: False

Title

System.String

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2022-08-09T14:28:42.9214809Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "Email": "sample string 4",
  "MarkerInformation": "sample string 5",
  "Location": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "CountryCode": "sample string 2",
    "StateCode": "sample string 3",
    "City": "sample string 4",
    "Zip": "sample string 5",
    "Street": "sample string 6",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "MapZoomLevel": 1
  },
  "URL": "sample string 6",
  "Gazetted": true,
  "Area": "sample string 8",
  "Year": "sample string 9",
  "Locality": "sample string 10",
  "ObjectCoordinates": "sample string 11",
  "Title": "sample string 12"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put offroadareas by key

Full update for offroadareas item.

Copy PUT /api/off-road-vehicle-map/offroadareas({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

Email

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

URL

System.String

Read only: False

Gazetted

System.Boolean

Read only: False

Area

System.String

Read only: False

Year

System.String

Read only: False

Locality

System.String

Read only: False

ObjectCoordinates

System.String

Read only: False

Title

System.String

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2022-08-09T14:28:42.9214809Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "Email": "sample string 4",
  "MarkerInformation": "sample string 5",
  "Location": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "CountryCode": "sample string 2",
    "StateCode": "sample string 3",
    "City": "sample string 4",
    "Zip": "sample string 5",
    "Street": "sample string 6",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "MapZoomLevel": 1
  },
  "URL": "sample string 6",
  "Gazetted": true,
  "Area": "sample string 8",
  "Year": "sample string 9",
  "Locality": "sample string 10",
  "ObjectCoordinates": "sample string 11",
  "Title": "sample string 12"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete offroadareas by key

Deletes a offroadareas item by Id.

Copy DELETE /api/off-road-vehicle-map/offroadareas({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.