ConsumerApi

<back to all web services

SharePlaceLinkUsedRequest

Consumer
The following routes are available for this service:
POST/share/share-place-link-usedA share place link was usedValidates the JWT token with the identity of the sharing user and the shared place and returns relevant information.
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module ConsumerApi


Python SharePlaceLinkUsedRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /share/share-place-link-used HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SharePlaceLinkUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <Locale>EnUs</Locale>
  <SharePlaceToken>String</SharePlaceToken>
</SharePlaceLinkUsedRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SharePlaceLinkUsedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ExpiresAt xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ExpiresAt>
  <Place>
    <Guid>00000000-0000-0000-0000-000000000000</Guid>
    <Id>0</Id>
    <ImageUrl>String</ImageUrl>
    <LogoUrl>String</LogoUrl>
    <Name>String</Name>
    <OpeningHours xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Weekly>
        <d3p1:Friday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Friday>
        <d3p1:Monday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Monday>
        <d3p1:Saturday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Saturday>
        <d3p1:Sunday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Sunday>
        <d3p1:Thursday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Thursday>
        <d3p1:Tuesday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Tuesday>
        <d3p1:Wednesday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Wednesday>
      </d3p1:Weekly>
    </OpeningHours>
    <PriceMainDish>
      <Label>String</Label>
      <Slug>Value</Slug>
    </PriceMainDish>
    <RootCategories>
      <SharedRootCategory>
        <AbsoluteSlug>String</AbsoluteSlug>
        <Name>String</Name>
      </SharedRootCategory>
    </RootCategories>
    <TimeZoneDto xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:BaseUtcOffset>PT0S</d3p1:BaseUtcOffset>
      <d3p1:DaylightName>String</d3p1:DaylightName>
      <d3p1:DisplayName>String</d3p1:DisplayName>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:StandardName>String</d3p1:StandardName>
      <d3p1:SupportsDaylightSavingTime>false</d3p1:SupportsDaylightSavingTime>
    </TimeZoneDto>
    <WearPriceProfiles>
      <ShareWearPriceProfile>
        <Label>String</Label>
        <Slug>String</Slug>
      </ShareWearPriceProfile>
    </WearPriceProfiles>
  </Place>
  <SharingUser>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
  </SharingUser>
  <State>Teaser</State>
</SharePlaceLinkUsedResponse>