MyApp

<back to all web services

Register

auth

Sign Up

The following routes are available for this service:
PUT,POST/register
import 'package:servicestack/servicestack.dart';

// @DataContract
class RegisterResponse implements IMeta, IHasSessionId, IHasBearerToken, IConvertible
{
    // @DataMember(Order=1)
    String? userId;

    // @DataMember(Order=2)
    String? sessionId;

    // @DataMember(Order=3)
    String? userName;

    // @DataMember(Order=4)
    String? referrerUrl;

    // @DataMember(Order=5)
    String? bearerToken;

    // @DataMember(Order=6)
    String? refreshToken;

    // @DataMember(Order=7)
    DateTime? refreshTokenExpiry;

    // @DataMember(Order=8)
    List<String>? roles;

    // @DataMember(Order=9)
    List<String>? permissions;

    // @DataMember(Order=10)
    ResponseStatus? responseStatus;

    // @DataMember(Order=11)
    Map<String,String?>? meta;

    RegisterResponse({this.userId,this.sessionId,this.userName,this.referrerUrl,this.bearerToken,this.refreshToken,this.refreshTokenExpiry,this.roles,this.permissions,this.responseStatus,this.meta});
    RegisterResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userId = json['userId'];
        sessionId = json['sessionId'];
        userName = json['userName'];
        referrerUrl = json['referrerUrl'];
        bearerToken = json['bearerToken'];
        refreshToken = json['refreshToken'];
        refreshTokenExpiry = JsonConverters.fromJson(json['refreshTokenExpiry'],'DateTime',context!);
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        permissions = JsonConverters.fromJson(json['permissions'],'List<String>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': userId,
        'sessionId': sessionId,
        'userName': userName,
        'referrerUrl': referrerUrl,
        'bearerToken': bearerToken,
        'refreshToken': refreshToken,
        'refreshTokenExpiry': JsonConverters.toJson(refreshTokenExpiry,'DateTime',context!),
        'roles': JsonConverters.toJson(roles,'List<String>',context!),
        'permissions': JsonConverters.toJson(permissions,'List<String>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'meta': meta
    };

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

/**
* Sign Up
*/
// @Api(Description="Sign Up")
// @DataContract
class Register implements IPost, IMeta, IConvertible
{
    // @DataMember(Order=1)
    String? userName;

    // @DataMember(Order=2)
    String? firstName;

    // @DataMember(Order=3)
    String? lastName;

    // @DataMember(Order=4)
    String? displayName;

    // @DataMember(Order=5)
    String? email;

    // @DataMember(Order=6)
    String? password;

    // @DataMember(Order=7)
    String? confirmPassword;

    // @DataMember(Order=8)
    bool? autoLogin;

    // @DataMember(Order=10)
    String? errorView;

    // @DataMember(Order=11)
    Map<String,String?>? meta;

    Register({this.userName,this.firstName,this.lastName,this.displayName,this.email,this.password,this.confirmPassword,this.autoLogin,this.errorView,this.meta});
    Register.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userName = json['userName'];
        firstName = json['firstName'];
        lastName = json['lastName'];
        displayName = json['displayName'];
        email = json['email'];
        password = json['password'];
        confirmPassword = json['confirmPassword'];
        autoLogin = json['autoLogin'];
        errorView = json['errorView'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userName': userName,
        'firstName': firstName,
        'lastName': lastName,
        'displayName': displayName,
        'email': email,
        'password': password,
        'confirmPassword': confirmPassword,
        'autoLogin': autoLogin,
        'errorView': errorView,
        'meta': meta
    };

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

TypeContext _ctx = TypeContext(library: 'vue_vite_api.jamstacks.net', types: <String, TypeInfo> {
});

Dart Register 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 /register HTTP/1.1 
Host: vue-vite-api.jamstacks.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Register xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <UserName>String</UserName>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <Password>String</Password>
  <ConfirmPassword>String</ConfirmPassword>
  <AutoLogin>false</AutoLogin>
  <ErrorView>String</ErrorView>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</Register>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <UserId>String</UserId>
  <SessionId>String</SessionId>
  <UserName>String</UserName>
  <ReferrerUrl>String</ReferrerUrl>
  <BearerToken>String</BearerToken>
  <RefreshToken>String</RefreshToken>
  <RefreshTokenExpiry>0001-01-01T00:00:00</RefreshTokenExpiry>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</RegisterResponse>