ConsumerApi

<back to all web services

ProfileGetRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/profile

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 ProfileGetRequest DTOs

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

HTTP + CSV

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

GET /profile HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"userProfile":{"locale":"EnUs","firstName":"String","lastName":"String","profilePhotoUrl":"String","mobilePhone":"String","mobilePhoneVerified":false,"email":"String","emailVerified":false,"hasPassword":false,"dateOfBirth":{"year":0,"month":0,"dayOfMonth":0},"sex":"Male","home":{"address":{"streetName":"String","streetNumber":"String","postalCode":"String","region":"String","countryCode":"String"},"latitude":0,"longitude":0},"showDistancesIn":"Kilometer","legalIdentityVerified":false,"managesPlacesInBusinessWeb":false,"pointsTotal":0}}