ConsumerApi

<back to all web services

UserStatusRequest

Consumer
The following routes are available for this service:
GET/user/status

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

enum Locale
{
    EnUs,
    NbNo,
}

class DateOfBirth implements IConvertible
{
    int? year;
    int? month;
    int? dayOfMonth;

    DateOfBirth({this.year,this.month,this.dayOfMonth});
    DateOfBirth.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        year = json['year'];
        month = json['month'];
        dayOfMonth = json['dayOfMonth'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'year': year,
        'month': month,
        'dayOfMonth': dayOfMonth
    };

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

enum Sex
{
    Male,
    Female,
}

class UserAddress implements IConvertible
{
    String? streetName;
    String? streetNumber;
    String? postalCode;
    String? region;
    String? countryCode;

    UserAddress({this.streetName,this.streetNumber,this.postalCode,this.region,this.countryCode});
    UserAddress.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        streetName = json['streetName'];
        streetNumber = json['streetNumber'];
        postalCode = json['postalCode'];
        region = json['region'];
        countryCode = json['countryCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'streetName': streetName,
        'streetNumber': streetNumber,
        'postalCode': postalCode,
        'region': region,
        'countryCode': countryCode
    };

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

class HomeLocation implements IConvertible
{
    UserAddress? address;
    double? latitude;
    double? longitude;

    HomeLocation({this.address,this.latitude,this.longitude});
    HomeLocation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        address = JsonConverters.fromJson(json['address'],'UserAddress',context!);
        latitude = JsonConverters.toDouble(json['latitude']);
        longitude = JsonConverters.toDouble(json['longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'address': JsonConverters.toJson(address,'UserAddress',context!),
        'latitude': latitude,
        'longitude': longitude
    };

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

enum DistanceUnit
{
    Kilometer,
    Mile,
}

TypeContext _ctx = TypeContext(library: 'ConsumerApi', types: <String, TypeInfo> {
    'Locale': TypeInfo(TypeOf.Enum, enumValues:Locale.values),
    'DateOfBirth': TypeInfo(TypeOf.Class, create:() => DateOfBirth()),
    'Sex': TypeInfo(TypeOf.Enum, enumValues:Sex.values),
    'UserAddress': TypeInfo(TypeOf.Class, create:() => UserAddress()),
    'HomeLocation': TypeInfo(TypeOf.Class, create:() => HomeLocation()),
    'DistanceUnit': TypeInfo(TypeOf.Enum, enumValues:DistanceUnit.values),
});

Dart UserStatusRequest 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.

GET /user/status HTTP/1.1 
Host: unstable-consumer-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/ConsumerApi.Dto">
  <BusinessInvites>
    <StaffInviteSmallDto>
      <InviteKey>String</InviteKey>
      <InvitingUserName>String</InvitingUserName>
      <Name>String</Name>
    </StaffInviteSmallDto>
  </BusinessInvites>
  <Status>LoginOrSignup</Status>
  <SuggestPwaInstallation>false</SuggestPwaInstallation>
  <UserProfile>
    <DateOfBirth xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:DayOfMonth>0</d3p1:DayOfMonth>
      <d3p1:Month>0</d3p1:Month>
      <d3p1:Year>0</d3p1:Year>
    </DateOfBirth>
    <Email>String</Email>
    <EmailVerified>false</EmailVerified>
    <FirstName>String</FirstName>
    <HasPassword>false</HasPassword>
    <Home xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Address>
        <d3p1:CountryCode>String</d3p1:CountryCode>
        <d3p1:PostalCode>String</d3p1:PostalCode>
        <d3p1:Region>String</d3p1:Region>
        <d3p1:StreetName>String</d3p1:StreetName>
        <d3p1:StreetNumber>String</d3p1:StreetNumber>
      </d3p1:Address>
      <d3p1:Latitude>0</d3p1:Latitude>
      <d3p1:Longitude>0</d3p1:Longitude>
    </Home>
    <LastName>String</LastName>
    <LegalIdentityVerified>false</LegalIdentityVerified>
    <Locale>EnUs</Locale>
    <ManagesPlacesInBusinessWeb>false</ManagesPlacesInBusinessWeb>
    <MobilePhone>String</MobilePhone>
    <MobilePhoneVerified>false</MobilePhoneVerified>
    <PointsTotal>0</PointsTotal>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
    <Sex>Male</Sex>
    <ShowDistancesIn>Kilometer</ShowDistancesIn>
    <UserGuid>00000000-0000-0000-0000-000000000000</UserGuid>
  </UserProfile>
</UserStatusResponse>