TicketUserServices

<back to all web services

ConfirmPhoneVerificationRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
GET POST/phoneverification/verification/{RequestId}/{Code}
GET POST/phoneverification/verification/{RequestId}/{Code}/{Path}
import 'package:servicestack/servicestack.dart';

class PhoneVerificationResult implements IConvertible
{
    String? token;
    bool? codeMatches;
    int? statusCode;
    String? statusMessage;

    PhoneVerificationResult({this.token,this.codeMatches,this.statusCode,this.statusMessage});
    PhoneVerificationResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        token = json['token'];
        codeMatches = json['codeMatches'];
        statusCode = json['statusCode'];
        statusMessage = json['statusMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'token': token,
        'codeMatches': codeMatches,
        'statusCode': statusCode,
        'statusMessage': statusMessage
    };

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

class RequestSignature implements IConvertible
{
    String? systemId;
    String? systemSecret;
    String? signature;

    RequestSignature({this.systemId,this.systemSecret,this.signature});
    RequestSignature.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        systemId = json['systemId'];
        systemSecret = json['systemSecret'];
        signature = json['signature'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'systemId': systemId,
        'systemSecret': systemSecret,
        'signature': signature
    };

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

class ConfirmPhoneVerificationRequest implements IConvertible
{
    String? code;
    String? requestId;
    String? path;
    String? senderVerification;
    int? requestUnixUTCTimeStamp;
    RequestSignature? signature;

    ConfirmPhoneVerificationRequest({this.code,this.requestId,this.path,this.senderVerification,this.requestUnixUTCTimeStamp,this.signature});
    ConfirmPhoneVerificationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        code = json['code'];
        requestId = json['requestId'];
        path = json['path'];
        senderVerification = json['senderVerification'];
        requestUnixUTCTimeStamp = json['requestUnixUTCTimeStamp'];
        signature = JsonConverters.fromJson(json['signature'],'RequestSignature',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'code': code,
        'requestId': requestId,
        'path': path,
        'senderVerification': senderVerification,
        'requestUnixUTCTimeStamp': requestUnixUTCTimeStamp,
        'signature': JsonConverters.toJson(signature,'RequestSignature',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'stubbur_autoupdates_live.smartnewapis.com', types: <String, TypeInfo> {
    'PhoneVerificationResult': TypeInfo(TypeOf.Class, create:() => PhoneVerificationResult()),
    'RequestSignature': TypeInfo(TypeOf.Class, create:() => RequestSignature()),
    'ConfirmPhoneVerificationRequest': TypeInfo(TypeOf.Class, create:() => ConfirmPhoneVerificationRequest()),
});

Dart ConfirmPhoneVerificationRequest DTOs

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

HTTP + JSV

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

POST /phoneverification/verification/{RequestId}/{Code} HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	code: String,
	requestId: String,
	path: String,
	senderVerification: String,
	requestUnixUTCTimeStamp: 0,
	signature: 
	{
		systemId: String,
		systemSecret: String,
		signature: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	token: String,
	codeMatches: False,
	statusCode: 0,
	statusMessage: String
}