FrameAppWS

<back to all web services

AuthenticateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/authenticate
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class CoreRS implements IConvertible
{
    String? Code;
    String? ErrorMessage;
    String? ErrorStackTrace;

    CoreRS({this.Code,this.ErrorMessage,this.ErrorStackTrace});
    CoreRS.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['Code'];
        ErrorMessage = json['ErrorMessage'];
        ErrorStackTrace = json['ErrorStackTrace'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Code': Code,
        'ErrorMessage': ErrorMessage,
        'ErrorStackTrace': ErrorStackTrace
    };

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

class Citizen implements IConvertible
{
    String? Email;
    String? DisplayName;
    String? Avatar;
    String? Theme;
    String? PhoneNumber;
    int? Provider;
    String? ProviderId;
    String? Password;
    String? Banned;
    String? Status;

    Citizen({this.Email,this.DisplayName,this.Avatar,this.Theme,this.PhoneNumber,this.Provider,this.ProviderId,this.Password,this.Banned,this.Status});
    Citizen.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Email = json['Email'];
        DisplayName = json['DisplayName'];
        Avatar = json['Avatar'];
        Theme = json['Theme'];
        PhoneNumber = json['PhoneNumber'];
        Provider = json['Provider'];
        ProviderId = json['ProviderId'];
        Password = json['Password'];
        Banned = json['Banned'];
        Status = json['Status'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Email': Email,
        'DisplayName': DisplayName,
        'Avatar': Avatar,
        'Theme': Theme,
        'PhoneNumber': PhoneNumber,
        'Provider': Provider,
        'ProviderId': ProviderId,
        'Password': Password,
        'Banned': Banned,
        'Status': Status
    };

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

class AuthenticateCitizenRS extends CoreRS implements IConvertible
{
    Citizen? Data;

    AuthenticateCitizenRS({this.Data});
    AuthenticateCitizenRS.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Data = JsonConverters.fromJson(json['Data'],'Citizen',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Data': JsonConverters.toJson(Data,'Citizen',context!)
    });

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

class AuthenticateCitizenRQ implements IConvertible
{
    String? Email;
    String? Password;
    int? Provider;
    String? DisplayName;
    String? PhoneNumber;
    String? ProviderId;
    String? MobileId;
    String? MobileOS;
    String? CreatedUser;

    AuthenticateCitizenRQ({this.Email,this.Password,this.Provider,this.DisplayName,this.PhoneNumber,this.ProviderId,this.MobileId,this.MobileOS,this.CreatedUser});
    AuthenticateCitizenRQ.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Email = json['Email'];
        Password = json['Password'];
        Provider = json['Provider'];
        DisplayName = json['DisplayName'];
        PhoneNumber = json['PhoneNumber'];
        ProviderId = json['ProviderId'];
        MobileId = json['MobileId'];
        MobileOS = json['MobileOS'];
        CreatedUser = json['CreatedUser'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Email': Email,
        'Password': Password,
        'Provider': Provider,
        'DisplayName': DisplayName,
        'PhoneNumber': PhoneNumber,
        'ProviderId': ProviderId,
        'MobileId': MobileId,
        'MobileOS': MobileOS,
        'CreatedUser': CreatedUser
    };

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

TypeContext _ctx = TypeContext(library: 'ws.jimsnwa.com', types: <String, TypeInfo> {
    'CoreRS': TypeInfo(TypeOf.Class, create:() => CoreRS()),
    'Citizen': TypeInfo(TypeOf.Class, create:() => Citizen()),
    'AuthenticateCitizenRS': TypeInfo(TypeOf.Class, create:() => AuthenticateCitizenRS()),
    'AuthenticateCitizenRQ': TypeInfo(TypeOf.Class, create:() => AuthenticateCitizenRQ()),
});

Dart AuthenticateCitizenRQ 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 /citizen/authenticate HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AuthenticateCitizenRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
  <CreatedUser>String</CreatedUser>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <MobileId>String</MobileId>
  <MobileOS>String</MobileOS>
  <Password>String</Password>
  <PhoneNumber>String</PhoneNumber>
  <Provider>0</Provider>
  <ProviderId>String</ProviderId>
</AuthenticateCitizenRQ>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuthenticateCitizenRS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
  <Code xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</Code>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorMessage>
  <ErrorStackTrace xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorStackTrace>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nwa.Model.Contexto.nwa.citizen">
    <d2p1:Avatar>String</d2p1:Avatar>
    <d2p1:Banned>String</d2p1:Banned>
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:Password>String</d2p1:Password>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:Provider>0</d2p1:Provider>
    <d2p1:ProviderId>String</d2p1:ProviderId>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Theme>String</d2p1:Theme>
  </Data>
</AuthenticateCitizenRS>