RESTful API
Liquor
Liquor Alerts Funding News Off-road vehicle map

Premises

Get premises

Returns a set of data items of type premises.

Copy GET /api/liquor/premises
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

LicenseType

System.String

Read only: False

Title

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Address

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

ClientName

System.String

Read only: False

StatusDescription

System.String

Read only: False

Over400sqm

System.Boolean

Read only: False

LicenseReference

System.String

Read only: False

DecisionDescription

System.String

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2024-05-03T10:26:28.326273Z",
    "PublicationDate": "2024-05-03T10:26:28.326273Z",
    "DateCreated": "2024-05-03T10:26:28.326273Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "LicenseType": "sample string 6",
    "Title": "sample string 7",
    "MarkerInformation": "sample string 8",
    "Address": {
      "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
    },
    "ClientName": "sample string 9",
    "StatusDescription": "sample string 10",
    "Over400sqm": true,
    "LicenseReference": "sample string 12",
    "DecisionDescription": "sample string 13",
    "Provider": "sample string 14"
  },
  {
    "LastModified": "2024-05-03T10:26:28.326273Z",
    "PublicationDate": "2024-05-03T10:26:28.326273Z",
    "DateCreated": "2024-05-03T10:26:28.326273Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "LicenseType": "sample string 6",
    "Title": "sample string 7",
    "MarkerInformation": "sample string 8",
    "Address": {
      "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
    },
    "ClientName": "sample string 9",
    "StatusDescription": "sample string 10",
    "Over400sqm": true,
    "LicenseReference": "sample string 12",
    "DecisionDescription": "sample string 13",
    "Provider": "sample string 14"
  }
]

Get premises by key

Gets premises item by id.

Copy GET /api/liquor/premises({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

LicenseType

System.String

Read only: False

Title

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Address

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

ClientName

System.String

Read only: False

StatusDescription

System.String

Read only: False

Over400sqm

System.Boolean

Read only: False

LicenseReference

System.String

Read only: False

DecisionDescription

System.String

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2024-05-03T10:26:28.326273Z",
  "PublicationDate": "2024-05-03T10:26:28.326273Z",
  "DateCreated": "2024-05-03T10:26:28.326273Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "LicenseType": "sample string 6",
  "Title": "sample string 7",
  "MarkerInformation": "sample string 8",
  "Address": {
    "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
  },
  "ClientName": "sample string 9",
  "StatusDescription": "sample string 10",
  "Over400sqm": true,
  "LicenseReference": "sample string 12",
  "DecisionDescription": "sample string 13",
  "Provider": "sample string 14"
}

Get property

Gets Id property from premises item.

Copy GET /api/liquor/premises({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": "717bb848-6f43-4b5d-8e01-26273cd0c699"
}

Post premises

Creates a premises item.

Copy POST /api/liquor/premises
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

LicenseType

System.String

Read only: False

Title

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Address

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

ClientName

System.String

Read only: False

StatusDescription

System.String

Read only: False

Over400sqm

System.Boolean

Read only: False

LicenseReference

System.String

Read only: False

DecisionDescription

System.String

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-05-03T10:26:28.326273Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "LicenseType": "sample string 4",
  "Title": "sample string 5",
  "MarkerInformation": "sample string 6",
  "Address": {
    "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
  },
  "ClientName": "sample string 7",
  "StatusDescription": "sample string 8",
  "Over400sqm": true,
  "LicenseReference": "sample string 10",
  "DecisionDescription": "sample string 11"
}
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

LicenseType

System.String

Read only: False

Title

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Address

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

ClientName

System.String

Read only: False

StatusDescription

System.String

Read only: False

Over400sqm

System.Boolean

Read only: False

LicenseReference

System.String

Read only: False

DecisionDescription

System.String

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2024-05-03T10:26:28.326273Z",
  "PublicationDate": "2024-05-03T10:26:28.326273Z",
  "DateCreated": "2024-05-03T10:26:28.326273Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "LicenseType": "sample string 6",
  "Title": "sample string 7",
  "MarkerInformation": "sample string 8",
  "Address": {
    "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
  },
  "ClientName": "sample string 9",
  "StatusDescription": "sample string 10",
  "Over400sqm": true,
  "LicenseReference": "sample string 12",
  "DecisionDescription": "sample string 13",
  "Provider": "sample string 14"
}

Patch premises by key

Partial update for premises item.

Copy PATCH /api/liquor/premises({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

LicenseType

System.String

Read only: False

Title

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Address

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

ClientName

System.String

Read only: False

StatusDescription

System.String

Read only: False

Over400sqm

System.Boolean

Read only: False

LicenseReference

System.String

Read only: False

DecisionDescription

System.String

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-05-03T10:26:28.326273Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "LicenseType": "sample string 4",
  "Title": "sample string 5",
  "MarkerInformation": "sample string 6",
  "Address": {
    "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
  },
  "ClientName": "sample string 7",
  "StatusDescription": "sample string 8",
  "Over400sqm": true,
  "LicenseReference": "sample string 10",
  "DecisionDescription": "sample string 11"
}
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 premises by key

Full update for premises item.

Copy PUT /api/liquor/premises({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

LicenseType

System.String

Read only: False

Title

System.String

Read only: False

MarkerInformation

System.String

Read only: False

Address

Telerik.Sitefinity.GeoLocations.Model.Address

Read only: False

ClientName

System.String

Read only: False

StatusDescription

System.String

Read only: False

Over400sqm

System.Boolean

Read only: False

LicenseReference

System.String

Read only: False

DecisionDescription

System.String

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-05-03T10:26:28.326273Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "LicenseType": "sample string 4",
  "Title": "sample string 5",
  "MarkerInformation": "sample string 6",
  "Address": {
    "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
  },
  "ClientName": "sample string 7",
  "StatusDescription": "sample string 8",
  "Over400sqm": true,
  "LicenseReference": "sample string 10",
  "DecisionDescription": "sample string 11"
}
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 premises by key

Deletes a premises item by Id.

Copy DELETE /api/liquor/premises({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.