Location

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Locations/Indexed

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

string[]Optional

get

/api/ConsumerApi/v1/Locations/Indexed

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Locations/Indexed HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  "text"
]

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Locations/Cuisines

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

CuisineTypestring · enumOptionalPossible values:

ProviderLocationIdinteger · int32Optional

SlugstringOptional

TitlestringOptional

IsIndexedbooleanOptional

get

/api/ConsumerApi/v1/Locations/Cuisines

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Locations/Cuisines HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "CuisineType": 0,
    "ProviderLocationId": 1,
    "Slug": "sample string 1",
    "Title": "sample string 2",
    "IsIndexed": true
  }
]

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Locations/Featured

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

NamestringOptional

LocationPathstringOptional

ImageUrlstringOptional

get

/api/ConsumerApi/v1/Locations/Featured

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Locations/Featured HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "Name": "sample string 1",
    "LocationPath": "sample string 2",
    "ImageUrl": "sample string 3"
  }
]

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/{locationId}

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

locationIdinteger · int32Required

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

Idinteger · int32Optional

NamestringOptional

PathstringOptional

UrlstringOptional

get

/api/ConsumerApi/v1/Location/{locationId}

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Location/{locationId} HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "Id": 1,
  "Name": "sample string 2",
  "Path": "sample string 3",
  "Url": "sample string 4"
}

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Locations/Cuisine/{slug}

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

slugstringRequired

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

CuisineTypestring · enumOptionalPossible values:

ProviderLocationIdinteger · int32Optional

SlugstringOptional

TitlestringOptional

IsIndexedbooleanOptional

get

/api/ConsumerApi/v1/Locations/Cuisine/{slug}

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Locations/Cuisine/{slug} HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "CuisineType": 0,
  "ProviderLocationId": 1,
  "Slug": "sample string 1",
  "Title": "sample string 2",
  "IsIndexed": true
}

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/{locationId}/Near

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

locationIdinteger · int32Required

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

NamestringOptional

IconUrlstringOptional

TargetPathstringOptional

get

/api/ConsumerApi/v1/Location/{locationId}/Near

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Location/{locationId}/Near HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "Name": "sample string 1",
    "IconUrl": "sample string 2",
    "TargetPath": "sample string 3"
  }
]

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Locations/Cuisines/Indexed

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

CuisineTypestring · enumOptionalPossible values:

ProviderLocationIdinteger · int32Optional

SlugstringOptional

TitlestringOptional

IsIndexedbooleanOptional

get

/api/ConsumerApi/v1/Locations/Cuisines/Indexed

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Locations/Cuisines/Indexed HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "CuisineType": 0,
    "ProviderLocationId": 1,
    "Slug": "sample string 1",
    "Title": "sample string 2",
    "IsIndexed": true
  }
]

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Locations/FeaturedAndTopCities

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

get

/api/ConsumerApi/v1/Locations/FeaturedAndTopCities

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Locations/FeaturedAndTopCities HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "FeaturedLocations": [
    {
      "Name": "sample string 1",
      "LocationPath": "sample string 2",
      "ImageUrl": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "LocationPath": "sample string 2",
      "ImageUrl": "sample string 3"
    }
  ],
  "TopCities": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "LocationPath": "sample string 3",
      "ImageUrl": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "LocationPath": "sample string 3",
      "ImageUrl": "sample string 4"
    }
  ]
}

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Restaurant/{micrositeName}/Location

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

micrositeNamestringRequired

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

Idinteger · int32Optional

NamestringOptional

PathstringOptional

UrlstringOptional

get

/api/ConsumerApi/v1/Restaurant/{micrositeName}/Location

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Restaurant/{micrositeName}/Location HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "Id": 1,
  "Name": "sample string 2",
  "Path": "sample string 3",
  "Url": "sample string 4"
}

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Locations/Search/{searchTerm}

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

searchTermstringRequired

Query parameters

latnumber · doubleOptional

lngnumber · doubleOptional

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

NamestringOptional

PathstringOptional

UrlstringOptional

DistanceFromUsersLocationnumber · doubleOptional

ShortNamestringOptional

get

/api/ConsumerApi/v1/Locations/Search/{searchTerm}

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Locations/Search/{searchTerm} HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "Name": "sample string 1",
    "Path": "sample string 2",
    "Url": "sample string 3",
    "DistanceFromUsersLocation": 4.1,
    "ShortName": "sample string 5"
  }
]

Returns an overview about the specified location with information about available restaurants and cuisines.

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/Overview

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

latstringRequired

The latitude of the location.

lngstringRequired

The longitude of the location.

whiteLabelIdinteger · int32Required

The id of the white label we are querying.

userIdinteger · int32Optional

The id of the portal user who is viewing the overview page.

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

Typestring · enumOptionalPossible values:

Radiusinteger · int32Optional

get

/api/ConsumerApi/v1/Location/Overview

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Location/Overview?lat=text&lng=text&whiteLabelId=1 HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "Type": 0,
  "LocationSummary": {
    "Id": 1,
    "Name": "sample string 2",
    "Path": "sample string 3",
    "Url": "sample string 4"
  },
  "Radius": 1,
  "RestaurantSummaries": [
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    },
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    }
  ],
  "LoyaltyParticipatingRestaurants": [
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    },
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    }
  ],
  "CuisineSummaries": [
    {
      "CuisineType": 0,
      "RestaurantSummaries": [
        {
          "Name": "sample string 1",
          "MicrositeName": "sample string 2",
          "LogoUrl": "sample string 3",
          "LargeLogoUrl": "sample string 4",
          "LargeMainRestaurantImage": "sample string 5",
          "MainRestaurantImage": "sample string 6",
          "SmallMainRestaurantImage": "sample string 7",
          "TinyMainRestaurantImage": "sample string 8",
          "AverageReviewScore": 9,
          "LatestReviewDate": "sample string 10",
          "ReviewBlurb": "sample string 11",
          "PricePoint": 12,
          "LocationBreadcrumb": [
            "sample string 1",
            "sample string 2"
          ],
          "CuisineTypes": [
            0,
            0
          ],
          "FullAddress": "sample string 13",
          "IsPointsParticipating": true
        },
        {
          "Name": "sample string 1",
          "MicrositeName": "sample string 2",
          "LogoUrl": "sample string 3",
          "LargeLogoUrl": "sample string 4",
          "LargeMainRestaurantImage": "sample string 5",
          "MainRestaurantImage": "sample string 6",
          "SmallMainRestaurantImage": "sample string 7",
          "TinyMainRestaurantImage": "sample string 8",
          "AverageReviewScore": 9,
          "LatestReviewDate": "sample string 10",
          "ReviewBlurb": "sample string 11",
          "PricePoint": 12,
          "LocationBreadcrumb": [
            "sample string 1",
            "sample string 2"
          ],
          "CuisineTypes": [
            0,
            0
          ],
          "FullAddress": "sample string 13",
          "IsPointsParticipating": true
        }
      ]
    },
    {
      "CuisineType": 0,
      "RestaurantSummaries": [
        {
          "Name": "sample string 1",
          "MicrositeName": "sample string 2",
          "LogoUrl": "sample string 3",
          "LargeLogoUrl": "sample string 4",
          "LargeMainRestaurantImage": "sample string 5",
          "MainRestaurantImage": "sample string 6",
          "SmallMainRestaurantImage": "sample string 7",
          "TinyMainRestaurantImage": "sample string 8",
          "AverageReviewScore": 9,
          "LatestReviewDate": "sample string 10",
          "ReviewBlurb": "sample string 11",
          "PricePoint": 12,
          "LocationBreadcrumb": [
            "sample string 1",
            "sample string 2"
          ],
          "CuisineTypes": [
            0,
            0
          ],
          "FullAddress": "sample string 13",
          "IsPointsParticipating": true
        },
        {
          "Name": "sample string 1",
          "MicrositeName": "sample string 2",
          "LogoUrl": "sample string 3",
          "LargeLogoUrl": "sample string 4",
          "LargeMainRestaurantImage": "sample string 5",
          "MainRestaurantImage": "sample string 6",
          "SmallMainRestaurantImage": "sample string 7",
          "TinyMainRestaurantImage": "sample string 8",
          "AverageReviewScore": 9,
          "LatestReviewDate": "sample string 10",
          "ReviewBlurb": "sample string 11",
          "PricePoint": 12,
          "LocationBreadcrumb": [
            "sample string 1",
            "sample string 2"
          ],
          "CuisineTypes": [
            0,
            0
          ],
          "FullAddress": "sample string 13",
          "IsPointsParticipating": true
        }
      ]
    }
  ],
  "PopularCities": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "LocationPath": "sample string 3",
      "ImageUrl": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "LocationPath": "sample string 3",
      "ImageUrl": "sample string 4"
    }
  ],
  "TopCuisines": [
    0,
    0
  ],
  "LatestRestaurantSummaries": [
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    },
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    }
  ],
  "MyListSummaries": [
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    },
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    }
  ],
  "PreviouslyBookedSummaries": [
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    },
    {
      "Name": "sample string 1",
      "MicrositeName": "sample string 2",
      "LogoUrl": "sample string 3",
      "LargeLogoUrl": "sample string 4",
      "LargeMainRestaurantImage": "sample string 5",
      "MainRestaurantImage": "sample string 6",
      "SmallMainRestaurantImage": "sample string 7",
      "TinyMainRestaurantImage": "sample string 8",
      "AverageReviewScore": 9,
      "LatestReviewDate": "sample string 10",
      "ReviewBlurb": "sample string 11",
      "PricePoint": 12,
      "LocationBreadcrumb": [
        "sample string 1",
        "sample string 2"
      ],
      "CuisineTypes": [
        0,
        0
      ],
      "FullAddress": "sample string 13",
      "IsPointsParticipating": true
    }
  ]
}

Returns a list of the nearest restaurants to a lat and lng value which have opted into the loyalty program

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/NearestLoyaltyRestaurants

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

latstringRequired

The latitude of the location.

lngstringRequired

The longitude of the location.

whiteLabelIdinteger · int32Required

The id of the white label we are querying.

maxResultsinteger · int32Required

The maxium number of results to return

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

NamestringOptional

MicrositeNamestringOptional

LogoUrlstringOptional

LargeLogoUrlstringOptional

LargeMainRestaurantImagestringOptional

MainRestaurantImagestringOptional

SmallMainRestaurantImagestringOptional

TinyMainRestaurantImagestringOptional

AverageReviewScorenumber · doubleOptional

LatestReviewDatestringOptional

ReviewBlurbstringOptional

PricePointinteger · int32Optional

LocationBreadcrumbstring[]Optional

FullAddressstringOptional

IsPointsParticipatingbooleanOptional

get

/api/ConsumerApi/v1/Location/NearestLoyaltyRestaurants

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Location/NearestLoyaltyRestaurants?lat=text&lng=text&whiteLabelId=1&maxResults=1 HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "Name": "sample string 1",
    "MicrositeName": "sample string 2",
    "LogoUrl": "sample string 3",
    "LargeLogoUrl": "sample string 4",
    "LargeMainRestaurantImage": "sample string 5",
    "MainRestaurantImage": "sample string 6",
    "SmallMainRestaurantImage": "sample string 7",
    "TinyMainRestaurantImage": "sample string 8",
    "AverageReviewScore": 9,
    "LatestReviewDate": "sample string 10",
    "ReviewBlurb": "sample string 11",
    "PricePoint": 12,
    "LocationBreadcrumb": [
      "sample string 1",
      "sample string 2"
    ],
    "CuisineTypes": [
      0,
      0
    ],
    "FullAddress": "sample string 13",
    "IsPointsParticipating": true
  }
]

post

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/Id

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Bodystring[]

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

string[]Optional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

integer · int32Optional

post

/api/ConsumerApi/v1/Location/Id

HTTPcURLJavaScriptPython

POST /rd-consumer-api/api/ConsumerApi/v1/Location/Id HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

1

post

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/Settings

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Body

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

LocationBreadcrumbstring[]Optional

Latitudenumber · doubleOptional

Longitudenumber · doubleOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

IsEnabledbooleanOptional

IsIndexedbooleanOptional

DescriptionstringOptional

IsFeaturedLocationbooleanOptional

LocationGuideUrlstringOptional

IconUrlstringOptional

MastheadUrlstringOptional

LocationIdinteger · int32Optional

GuideLocationNamestringOptional

GuideBlurbstringOptional

AboutLocationNamestringOptional

CentralLatitudenumber · doubleOptional

CentralLongitudenumber · doubleOptional

post

/api/ConsumerApi/v1/Location/Settings

HTTPcURLJavaScriptPython

POST /rd-consumer-api/api/ConsumerApi/v1/Location/Settings HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "LocationBreadcrumb": [
    "sample string 1",
    "sample string 2"
  ],
  "Latitude": 1.1,
  "Longitude": 2.1
}

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

{
  "IsEnabled": true,
  "IsIndexed": true,
  "Description": "sample string 3",
  "IsFeaturedLocation": true,
  "LocationGuideUrl": "sample string 5",
  "IconUrl": "sample string 6",
  "MastheadUrl": "sample string 7",
  "LocationId": 8,
  "GuideLocationName": "sample string 9",
  "GuideBlurb": "sample string 10",
  "Breadcrumb": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Path": "sample string 3",
      "Url": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Path": "sample string 3",
      "Url": "sample string 4"
    }
  ],
  "AboutLocationName": "sample string 11",
  "CentralLatitude": 12.1,
  "CentralLongitude": 13.1
}

post

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/FilterCounts

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

api-versionstringOptional

Body

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

TotalRestaurantsinteger · int32Optional

AvailabilityCountinteger · int32Optional

SellsVouchersCountinteger · int32Optional

IsPointsParticipatingCountinteger · int32Optional

post

/api/ConsumerApi/v1/Location/FilterCounts

HTTPcURLJavaScriptPython

POST /rd-consumer-api/api/ConsumerApi/v1/Location/FilterCounts HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 400

{
  "SearchParameters": {
    "ProviderLocationId": 1,
    "Latitude": "sample string 1",
    "Longitude": "sample string 2",
    "SearchRadius": 1,
    "CuisineTypes": [
      0,
      0
    ],
    "ChildLocationFilters": [
      1,
      2
    ],
    "PricePoints": [
      1,
      2
    ],
    "IsOnlyWithAvailability": true,
    "WhiteLabelId": 1,
    "AvailabilityTimeWindow": 1,
    "PortalUserId": 1,
    "IsOnlyWithVouchers": true,
    "IsOnlyWithLoyalty": true
  },
  "AvailabilityParameters": {
    "DateTime": "sample string 1",
    "Covers": 2
  }
}

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

{
  "TotalRestaurants": 1,
  "CuisineCounts": {
    "African": 1
  },
  "SublocationRestaurantCounts": [
    {
      "Id": 1,
      "Count": 2,
      "Name": "sample string 3"
    },
    {
      "Id": 1,
      "Count": 2,
      "Name": "sample string 3"
    }
  ],
  "PricePointCounts": {
    "1": 2,
    "3": 4
  },
  "AvailabilityCount": 1,
  "SellsVouchersCount": 1,
  "IsPointsParticipatingCount": 1
}

post

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Location/Restaurants

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Query parameters

pageNumberinteger · int32Required

pageSizeinteger · int32Required

api-versionstringOptional

Body

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

PortalSortOrderstring · enumOptionalPossible values:

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

RestaurantNamestringOptional

MicrositeNamestringOptional

ReviewScorenumber · doubleOptional

PricePointinteger · int32Optional

ReviewBlurbstringOptional

TotalReviewsinteger · int32Optional

AddressstringOptional

LogoUrlstringOptional

LargeLogoUrlstringOptional

ProviderIdinteger · int32Optional

TownstringOptional

IncludesAvailabilitySearchResultsbooleanOptional

IsFavouritebooleanOptional

DistanceFromUserinteger · int32Optional

SellsVouchersbooleanOptional

VouchersUrlstringOptional

Longitudenumber · doubleOptional

Latitudenumber · doubleOptional

IsPointsParticipatingbooleanOptional

BookingWidgetTypeinteger · int32Optional

post

/api/ConsumerApi/v1/Location/Restaurants

HTTPcURLJavaScriptPython

POST /rd-consumer-api/api/ConsumerApi/v1/Location/Restaurants?pageNumber=1&pageSize=1 HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 420

{
  "SearchParameters": {
    "ProviderLocationId": 1,
    "Latitude": "sample string 1",
    "Longitude": "sample string 2",
    "SearchRadius": 1,
    "CuisineTypes": [
      0,
      0
    ],
    "ChildLocationFilters": [
      1,
      2
    ],
    "PricePoints": [
      1,
      2
    ],
    "IsOnlyWithAvailability": true,
    "WhiteLabelId": 1,
    "AvailabilityTimeWindow": 1,
    "PortalUserId": 1,
    "IsOnlyWithVouchers": true,
    "IsOnlyWithLoyalty": true
  },
  "PortalSortOrder": 0,
  "AvailabilityParameters": {
    "DateTime": "sample string 1",
    "Covers": 2
  }
}

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

[
  {
    "RestaurantName": "sample string 1",
    "MicrositeName": "sample string 2",
    "ReviewScore": 1.1,
    "CuisineTypes": [
      0,
      0
    ],
    "PricePoint": 1,
    "ReviewBlurb": "sample string 3",
    "TotalReviews": 1,
    "Address": "sample string 4",
    "LogoUrl": "sample string 5",
    "LargeLogoUrl": "sample string 6",
    "ProviderId": 1,
    "Town": "sample string 7",
    "IncludesAvailabilitySearchResults": true,
    "AvailableTimeSlots": [
      {
        "TimeSlot": "sample string 1",
        "AvailablePromotions": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ],
        "HasStandardAvailability": true
      },
      {
        "TimeSlot": "sample string 1",
        "AvailablePromotions": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ],
        "HasStandardAvailability": true
      }
    ],
    "IsFavourite": true,
    "DistanceFromUser": 1,
    "SellsVouchers": true,
    "VouchersUrl": "sample string 8",
    "Longitude": 1.1,
    "Latitude": 1.1,
    "IsPointsParticipating": true,
    "BookingWidgetType": 10
  }
]

post

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Restaurant/{providerId}/Availability

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

providerIdinteger · int32Required

Query parameters

availabilityTimeWindowinteger · int32Required

api-versionstringOptional

Body

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

DateTimestringOptional

Coversinteger · int32Optional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

TimeSlotstringOptional

HasStandardAvailabilitybooleanOptional

post

/api/ConsumerApi/v1/Restaurant/{providerId}/Availability

HTTPcURLJavaScriptPython

POST /rd-consumer-api/api/ConsumerApi/v1/Restaurant/{providerId}/Availability?availabilityTimeWindow=1 HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "DateTime": "sample string 1",
  "Covers": 2
}

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

[
  {
    "TimeSlot": "sample string 1",
    "AvailablePromotions": [
      {
        "Id": 1,
        "Name": "sample string 2"
      },
      {
        "Id": 1,
        "Name": "sample string 2"
      }
    ],
    "HasStandardAvailability": true
  }
]