BusinessApi

<back to all web services

UserStatusRequest

Business
The following routes are available for this service:
GET/user/status
UserStatusResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformBusinessUserStatusNo
UserDtoformBusinessUserDtoNo
InvitationsformList<StaffInvitationDto>No
RolesformList<string>No
BusinessesformList<BusinessDto>No
PlacesformList<PlaceBasicDto>No
BusinessUserStatus Enum:
SignInOrUp
MustCompleteConsumerSignup
MustProvideEmailAddress
MustConfirmEmailAddress
MustAcceptTermsOfService
Ready
BusinessUserDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
FirstNameformstringNo
LastNameformstringNo
MobilePhoneformstringYes
LegalIdentityVerifiedformboolNo
LocaleformLocaleNo
Locale Enum:
EnUs
NbNo
StaffInvitationDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UserIdformlong?No
PlaceIdformlong?No
PlaceGuidformGuid?No
InviteKeyformstringYes
BusinessIdformlong?No
FirstNameformstringNo
LastNameformstringNo
PlaceNameformstringNo
BusinessNameformstringNo
RoleformStaffRoleNo
BusinessRoleformBusinessRoleNo
CreatedAtformDateTimeNo
UpdatedAtformDateTimeNo
StaffRole Enum:
Owner
Admin
Regular
BusinessRole Enum:
Owner
Manager
Sales
Marketing
Other
BusinessDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringYes
OrganizationNumberformstringNo
StreetAddressformstringYes
PostalCodeformstringYes
CityformstringYes
CountryformstringYes
ContactformBusinessContactNo
BusinessContact Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes
PositionformstringYes
PhoneformstringNo
EmailformstringNo
PlaceBasicDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
NameformstringYes
BusinessIdformlong?No
Longitudeformfloat?No
Latitudeformfloat?No
ClaimedformboolNo
OrganizationNumberformstringNo
CountryCodeformstringYes
OverviewformstringNo
OpeningHoursformOpeningHoursNo
PlaceTypeformPlaceTypeNo
ContactformPlaceContactYes
AddressformPlaceAddressYes
WheelChairAccessibleformbool?No
Wififormbool?No
OutdoorSeatingformbool?No
SaveFoodAndMoneyformbool?No
TimeZoneDtoformTimeZoneDtoYes
PriceMainDishformPriceMainDishDtoNo
OtherServicesformList<MallOtherServiceDto>No
FloorformstringNo
OpeningHours Parameters:
NameParameterData TypeRequiredDescription
WeeklyformWeeklyOpeningHoursYes
WeeklyOpeningHours Parameters:
NameParameterData TypeRequiredDescription
MondayformOpeningHourNo
TuesdayformOpeningHourNo
WednesdayformOpeningHourNo
ThursdayformOpeningHourNo
FridayformOpeningHourNo
SaturdayformOpeningHourNo
SundayformOpeningHourNo
OpeningHour Parameters:
NameParameterData TypeRequiredDescription
OpenAtHourformintNo
OpenAtMinuteformintNo
CloseAtHourformintNo
CloseAtMinuteformintNo
PlaceType Enum:
Mall
Regular
PlaceContact Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
WebShopformstringNo
PlaceAddress Parameters:
NameParameterData TypeRequiredDescription
StreetformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
TimeZoneDto Parameters:
NameParameterData TypeRequiredDescription
BaseUtcOffsetformTimeSpanNo
DaylightNameformstringYes
DisplayNameformstringYes
IdformstringYes
StandardNameformstringYes
SupportsDaylightSavingTimeformboolNo
PriceMainDishDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
SlugformPriceMainDishNo
PriceMainDish Enum:
Value
Medium
High
FineDining
MallOtherServiceDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ServiceNameformstringYes
FloorformstringYes

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.

GET /user/status HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Businesses>
    <BusinessDto>
      <City>String</City>
      <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Email>String</d4p1:Email>
        <d4p1:FirstName>String</d4p1:FirstName>
        <d4p1:LastName>String</d4p1:LastName>
        <d4p1:Phone>String</d4p1:Phone>
        <d4p1:Position>String</d4p1:Position>
      </Contact>
      <Country>String</Country>
      <Id>0</Id>
      <Name>String</Name>
      <OrganizationNumber>String</OrganizationNumber>
      <PostalCode>String</PostalCode>
      <StreetAddress>String</StreetAddress>
    </BusinessDto>
  </Businesses>
  <Invitations>
    <StaffInvitationDto>
      <BusinessId>0</BusinessId>
      <BusinessName>String</BusinessName>
      <BusinessRole>Owner</BusinessRole>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <FirstName>String</FirstName>
      <Id>0</Id>
      <InviteKey>String</InviteKey>
      <LastName>String</LastName>
      <PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
      <PlaceId>0</PlaceId>
      <PlaceName>String</PlaceName>
      <Role>Owner</Role>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UserId>0</UserId>
    </StaffInvitationDto>
  </Invitations>
  <Places>
    <PlaceBasicDto>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:CountryCode>String</d4p1:CountryCode>
        <d4p1:PostalCode>String</d4p1:PostalCode>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:Street>String</d4p1:Street>
      </Address>
      <BusinessId>0</BusinessId>
      <Claimed>false</Claimed>
      <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Email>String</d4p1:Email>
        <d4p1:Phone>String</d4p1:Phone>
        <d4p1:WebShop>String</d4p1:WebShop>
        <d4p1:Website>String</d4p1:Website>
      </Contact>
      <CountryCode>String</CountryCode>
      <Floor>String</Floor>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <Id>0</Id>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Name>String</Name>
      <OpeningHours xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Weekly>
          <d4p1:Friday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Friday>
          <d4p1:Monday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Monday>
          <d4p1:Saturday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Saturday>
          <d4p1:Sunday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Sunday>
          <d4p1:Thursday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Thursday>
          <d4p1:Tuesday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Tuesday>
          <d4p1:Wednesday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Wednesday>
        </d4p1:Weekly>
      </OpeningHours>
      <OrganizationNumber>String</OrganizationNumber>
      <OtherServices>
        <MallOtherServiceDto>
          <Floor>String</Floor>
          <Id>0</Id>
          <ServiceName>String</ServiceName>
        </MallOtherServiceDto>
      </OtherServices>
      <OutdoorSeating>false</OutdoorSeating>
      <Overview>String</Overview>
      <PlaceType>Mall</PlaceType>
      <PriceMainDish xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Slug>Value</d4p1:Slug>
        <d4p1:Title>String</d4p1:Title>
      </PriceMainDish>
      <SaveFoodAndMoney>false</SaveFoodAndMoney>
      <TimeZoneDto xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:BaseUtcOffset>PT0S</d4p1:BaseUtcOffset>
        <d4p1:DaylightName>String</d4p1:DaylightName>
        <d4p1:DisplayName>String</d4p1:DisplayName>
        <d4p1:Id>String</d4p1:Id>
        <d4p1:StandardName>String</d4p1:StandardName>
        <d4p1:SupportsDaylightSavingTime>false</d4p1:SupportsDaylightSavingTime>
      </TimeZoneDto>
      <WheelChairAccessible>false</WheelChairAccessible>
      <Wifi>false</Wifi>
    </PlaceBasicDto>
  </Places>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Status>SignInOrUp</Status>
  <UserDto>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <Id>0</Id>
    <LastName>String</LastName>
    <LegalIdentityVerified>false</LegalIdentityVerified>
    <Locale>EnUs</Locale>
    <MobilePhone>String</MobilePhone>
  </UserDto>
</UserStatusResponse>