TicketUserServices

<back to all web services

PhoneVerificationRequest

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

class PhoneVerificationRequestResult implements IConvertible
{
    String? token;
    bool? sentSuccess;
    int? statusCode;
    String? statusMessage;

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

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

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

    getTypeName() => "PhoneVerificationRequestResult";
    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 PhoneVerificationRequest implements IConvertible
{
    String? fullPhoneNumber;
    String? path;
    String? deviceId;
    String? os;
    int? requestUnixUTCTimeStamp;
    RequestSignature? signature;

    PhoneVerificationRequest({this.fullPhoneNumber,this.path,this.deviceId,this.os,this.requestUnixUTCTimeStamp,this.signature});
    PhoneVerificationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'fullPhoneNumber': fullPhoneNumber,
        'path': path,
        'deviceId': deviceId,
        'os': os,
        'requestUnixUTCTimeStamp': requestUnixUTCTimeStamp,
        'signature': JsonConverters.toJson(signature,'RequestSignature',context!)
    };

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

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

Dart PhoneVerificationRequest 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.

POST /phoneverification/request HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"fullPhoneNumber":"String","path":"String","deviceId":"String","os":"String","requestUnixUTCTimeStamp":0,"signature":{"systemId":"String","systemSecret":"String","signature":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"token":"String","sentSuccess":false,"statusCode":0,"statusMessage":"String"}