RESTful API

Restrictions

Get restrictions

Returns a set of data items of type restrictions.

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

Section

System.String

Read only: False

RegionalArea

System.String

Read only: False

MarkerInfo

System.String

Read only: False

Year

System.String

Read only: False

ExpiryDate

System.DateTimeOffset

Read only: False

Description

System.String

Read only: False

Region

System.String

Read only: False

Title

System.String

Read only: False

LegislationLink

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

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",
    "Section": "sample string 6",
    "RegionalArea": "sample string 7",
    "MarkerInfo": "sample string 8",
    "Year": "sample string 9",
    "ExpiryDate": "2024-05-03T10:26:28.326273Z",
    "Description": "sample string 11",
    "Region": "sample string 12",
    "Title": "sample string 13",
    "LegislationLink": "sample string 14",
    "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
    },
    "Provider": "sample string 15"
  },
  {
    "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",
    "Section": "sample string 6",
    "RegionalArea": "sample string 7",
    "MarkerInfo": "sample string 8",
    "Year": "sample string 9",
    "ExpiryDate": "2024-05-03T10:26:28.326273Z",
    "Description": "sample string 11",
    "Region": "sample string 12",
    "Title": "sample string 13",
    "LegislationLink": "sample string 14",
    "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
    },
    "Provider": "sample string 15"
  }
]

Get restrictions by key

Gets restrictions item by id.

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

Section

System.String

Read only: False

RegionalArea

System.String

Read only: False

MarkerInfo

System.String

Read only: False

Year

System.String

Read only: False

ExpiryDate

System.DateTimeOffset

Read only: False

Description

System.String

Read only: False

Region

System.String

Read only: False

Title

System.String

Read only: False

LegislationLink

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

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",
  "Section": "sample string 6",
  "RegionalArea": "sample string 7",
  "MarkerInfo": "sample string 8",
  "Year": "sample string 9",
  "ExpiryDate": "2024-05-03T10:26:28.326273Z",
  "Description": "sample string 11",
  "Region": "sample string 12",
  "Title": "sample string 13",
  "LegislationLink": "sample string 14",
  "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
  },
  "Provider": "sample string 15"
}

Get property

Gets Id property from restrictions item.

Copy GET /api/liquor/restrictions({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": "70bfc2e5-2662-43e5-b487-30485792cb06"
}

Post restrictions

Creates a restrictions item.

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

Section

System.String

Read only: False

RegionalArea

System.String

Read only: False

MarkerInfo

System.String

Read only: False

Year

System.String

Read only: False

ExpiryDate

System.DateTimeOffset

Read only: False

Description

System.String

Read only: False

Region

System.String

Read only: False

Title

System.String

Read only: False

LegislationLink

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

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",
  "Section": "sample string 4",
  "RegionalArea": "sample string 5",
  "MarkerInfo": "sample string 6",
  "Year": "sample string 7",
  "ExpiryDate": "2024-05-03T10:26:28.326273Z",
  "Description": "sample string 9",
  "Region": "sample string 10",
  "Title": "sample string 11",
  "LegislationLink": "sample string 12",
  "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
  }
}
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

Section

System.String

Read only: False

RegionalArea

System.String

Read only: False

MarkerInfo

System.String

Read only: False

Year

System.String

Read only: False

ExpiryDate

System.DateTimeOffset

Read only: False

Description

System.String

Read only: False

Region

System.String

Read only: False

Title

System.String

Read only: False

LegislationLink

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

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",
  "Section": "sample string 6",
  "RegionalArea": "sample string 7",
  "MarkerInfo": "sample string 8",
  "Year": "sample string 9",
  "ExpiryDate": "2024-05-03T10:26:28.326273Z",
  "Description": "sample string 11",
  "Region": "sample string 12",
  "Title": "sample string 13",
  "LegislationLink": "sample string 14",
  "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
  },
  "Provider": "sample string 15"
}

Patch restrictions by key

Partial update for restrictions item.

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

Section

System.String

Read only: False

RegionalArea

System.String

Read only: False

MarkerInfo

System.String

Read only: False

Year

System.String

Read only: False

ExpiryDate

System.DateTimeOffset

Read only: False

Description

System.String

Read only: False

Region

System.String

Read only: False

Title

System.String

Read only: False

LegislationLink

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

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",
  "Section": "sample string 4",
  "RegionalArea": "sample string 5",
  "MarkerInfo": "sample string 6",
  "Year": "sample string 7",
  "ExpiryDate": "2024-05-03T10:26:28.326273Z",
  "Description": "sample string 9",
  "Region": "sample string 10",
  "Title": "sample string 11",
  "LegislationLink": "sample string 12",
  "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
  }
}
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 restrictions by key

Full update for restrictions item.

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

Section

System.String

Read only: False

RegionalArea

System.String

Read only: False

MarkerInfo

System.String

Read only: False

Year

System.String

Read only: False

ExpiryDate

System.DateTimeOffset

Read only: False

Description

System.String

Read only: False

Region

System.String

Read only: False

Title

System.String

Read only: False

LegislationLink

System.String

Read only: False

Location

Telerik.Sitefinity.GeoLocations.Model.Address

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",
  "Section": "sample string 4",
  "RegionalArea": "sample string 5",
  "MarkerInfo": "sample string 6",
  "Year": "sample string 7",
  "ExpiryDate": "2024-05-03T10:26:28.326273Z",
  "Description": "sample string 9",
  "Region": "sample string 10",
  "Title": "sample string 11",
  "LegislationLink": "sample string 12",
  "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
  }
}
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 restrictions by key

Deletes a restrictions item by Id.

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