ConsumerApi

<back to all web services

UserCreateRequest

Consumer
The following routes are available for this service:
POST/signup/create_user

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

enum Sex
{
    Male,
    Female,
}

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;
}

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;
}

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

Dart UserCreateRequest 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 /signup/create_user HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <AcceptTermsOfService>false</AcceptTermsOfService>
  <DateOfBirth xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:DayOfMonth>0</d2p1:DayOfMonth>
    <d2p1:Month>0</d2p1:Month>
    <d2p1:Year>0</d2p1:Year>
  </DateOfBirth>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <Home xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:Address>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:StreetName>String</d2p1:StreetName>
      <d2p1:StreetNumber>String</d2p1:StreetNumber>
    </d2p1:Address>
    <d2p1:Latitude>0</d2p1:Latitude>
    <d2p1:Longitude>0</d2p1:Longitude>
  </Home>
  <LastName>String</LastName>
  <Password>String</Password>
  <PasswordConfirmation>String</PasswordConfirmation>
  <ReferFriendToken>String</ReferFriendToken>
  <Sex>Male</Sex>
  <Token>String</Token>
</UserCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <PasswordScore>0</PasswordScore>
  <ReferFriendAwarded>false</ReferFriendAwarded>
  <SentVerificationEmailWithRequestId>String</SentVerificationEmailWithRequestId>
  <UserGuid>00000000-0000-0000-0000-000000000000</UserGuid>
</UserCreateResponse>