BusinessApi

<back to all web services

PlaceUpdateRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/place/update

library BusinessApi;
import 'package:servicestack/servicestack.dart';

class OpeningHour implements IConvertible
{
    int? openAtHour;
    int? openAtMinute;
    int? closeAtHour;
    int? closeAtMinute;

    OpeningHour({this.openAtHour,this.openAtMinute,this.closeAtHour,this.closeAtMinute});
    OpeningHour.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        openAtHour = json['openAtHour'];
        openAtMinute = json['openAtMinute'];
        closeAtHour = json['closeAtHour'];
        closeAtMinute = json['closeAtMinute'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'openAtHour': openAtHour,
        'openAtMinute': openAtMinute,
        'closeAtHour': closeAtHour,
        'closeAtMinute': closeAtMinute
    };

    getTypeName() => "OpeningHour";
    TypeContext? context = _ctx;
}

class WeeklyOpeningHours implements IConvertible
{
    OpeningHour? monday;
    OpeningHour? tuesday;
    OpeningHour? wednesday;
    OpeningHour? thursday;
    OpeningHour? friday;
    OpeningHour? saturday;
    OpeningHour? sunday;

    WeeklyOpeningHours({this.monday,this.tuesday,this.wednesday,this.thursday,this.friday,this.saturday,this.sunday});
    WeeklyOpeningHours.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        monday = JsonConverters.fromJson(json['monday'],'OpeningHour',context!);
        tuesday = JsonConverters.fromJson(json['tuesday'],'OpeningHour',context!);
        wednesday = JsonConverters.fromJson(json['wednesday'],'OpeningHour',context!);
        thursday = JsonConverters.fromJson(json['thursday'],'OpeningHour',context!);
        friday = JsonConverters.fromJson(json['friday'],'OpeningHour',context!);
        saturday = JsonConverters.fromJson(json['saturday'],'OpeningHour',context!);
        sunday = JsonConverters.fromJson(json['sunday'],'OpeningHour',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'monday': JsonConverters.toJson(monday,'OpeningHour',context!),
        'tuesday': JsonConverters.toJson(tuesday,'OpeningHour',context!),
        'wednesday': JsonConverters.toJson(wednesday,'OpeningHour',context!),
        'thursday': JsonConverters.toJson(thursday,'OpeningHour',context!),
        'friday': JsonConverters.toJson(friday,'OpeningHour',context!),
        'saturday': JsonConverters.toJson(saturday,'OpeningHour',context!),
        'sunday': JsonConverters.toJson(sunday,'OpeningHour',context!)
    };

    getTypeName() => "WeeklyOpeningHours";
    TypeContext? context = _ctx;
}

class OpeningHours implements IConvertible
{
    WeeklyOpeningHours? weekly;

    OpeningHours({this.weekly});
    OpeningHours.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        weekly = JsonConverters.fromJson(json['weekly'],'WeeklyOpeningHours',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'weekly': JsonConverters.toJson(weekly,'WeeklyOpeningHours',context!)
    };

    getTypeName() => "OpeningHours";
    TypeContext? context = _ctx;
}

enum Parking
{
    StreetParking,
    ParkingGarageNearby,
}

enum PaymentOption
{
    Visa,
    MasterCard,
    AmericanExpress,
    Diners,
    Vipps,
}

TypeContext _ctx = TypeContext(library: 'BusinessApi', types: <String, TypeInfo> {
    'OpeningHour': TypeInfo(TypeOf.Class, create:() => OpeningHour()),
    'WeeklyOpeningHours': TypeInfo(TypeOf.Class, create:() => WeeklyOpeningHours()),
    'OpeningHours': TypeInfo(TypeOf.Class, create:() => OpeningHours()),
    'Parking': TypeInfo(TypeOf.Enum, enumValues:Parking.values),
    'PaymentOption': TypeInfo(TypeOf.Enum, enumValues:PaymentOption.values),
});

Dart PlaceUpdateRequest 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 /place/update HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PlaceUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Email>String</Email>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <Name>String</Name>
  <OpeningHours xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:Weekly>
      <d2p1:Friday>
        <d2p1:CloseAtHour>0</d2p1:CloseAtHour>
        <d2p1:CloseAtMinute>0</d2p1:CloseAtMinute>
        <d2p1:OpenAtHour>0</d2p1:OpenAtHour>
        <d2p1:OpenAtMinute>0</d2p1:OpenAtMinute>
      </d2p1:Friday>
      <d2p1:Monday>
        <d2p1:CloseAtHour>0</d2p1:CloseAtHour>
        <d2p1:CloseAtMinute>0</d2p1:CloseAtMinute>
        <d2p1:OpenAtHour>0</d2p1:OpenAtHour>
        <d2p1:OpenAtMinute>0</d2p1:OpenAtMinute>
      </d2p1:Monday>
      <d2p1:Saturday>
        <d2p1:CloseAtHour>0</d2p1:CloseAtHour>
        <d2p1:CloseAtMinute>0</d2p1:CloseAtMinute>
        <d2p1:OpenAtHour>0</d2p1:OpenAtHour>
        <d2p1:OpenAtMinute>0</d2p1:OpenAtMinute>
      </d2p1:Saturday>
      <d2p1:Sunday>
        <d2p1:CloseAtHour>0</d2p1:CloseAtHour>
        <d2p1:CloseAtMinute>0</d2p1:CloseAtMinute>
        <d2p1:OpenAtHour>0</d2p1:OpenAtHour>
        <d2p1:OpenAtMinute>0</d2p1:OpenAtMinute>
      </d2p1:Sunday>
      <d2p1:Thursday>
        <d2p1:CloseAtHour>0</d2p1:CloseAtHour>
        <d2p1:CloseAtMinute>0</d2p1:CloseAtMinute>
        <d2p1:OpenAtHour>0</d2p1:OpenAtHour>
        <d2p1:OpenAtMinute>0</d2p1:OpenAtMinute>
      </d2p1:Thursday>
      <d2p1:Tuesday>
        <d2p1:CloseAtHour>0</d2p1:CloseAtHour>
        <d2p1:CloseAtMinute>0</d2p1:CloseAtMinute>
        <d2p1:OpenAtHour>0</d2p1:OpenAtHour>
        <d2p1:OpenAtMinute>0</d2p1:OpenAtMinute>
      </d2p1:Tuesday>
      <d2p1:Wednesday>
        <d2p1:CloseAtHour>0</d2p1:CloseAtHour>
        <d2p1:CloseAtMinute>0</d2p1:CloseAtMinute>
        <d2p1:OpenAtHour>0</d2p1:OpenAtHour>
        <d2p1:OpenAtMinute>0</d2p1:OpenAtMinute>
      </d2p1:Wednesday>
    </d2p1:Weekly>
  </OpeningHours>
  <OutdoorSeating>false</OutdoorSeating>
  <Overview>String</Overview>
  <Parking xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Database">
    <d2p1:Parking>StreetParking</d2p1:Parking>
  </Parking>
  <PaymentOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Database">
    <d2p1:PaymentOption>Visa</d2p1:PaymentOption>
  </PaymentOptions>
  <Phone>String</Phone>
  <PlaceId>0</PlaceId>
  <PostalCode>String</PostalCode>
  <Region>String</Region>
  <SaveFoodAndMoney>false</SaveFoodAndMoney>
  <Street>String</Street>
  <WebShop>String</WebShop>
  <Website>String</Website>
  <WheelChairAccessible>false</WheelChairAccessible>
  <Wifi>false</Wifi>
</PlaceUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PlaceUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <PlaceId>0</PlaceId>
</PlaceUpdateResponse>