Field Squared API Services

<back to all web services

PortalAuthenticationRequest

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

class PortalAuthenticationRequest implements IConvertible
{
    String? UserId;
    String? Password;
    String? TfaCode;
    String? ActivationCode;

    PortalAuthenticationRequest({this.UserId,this.Password,this.TfaCode,this.ActivationCode});
    PortalAuthenticationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserId = json['UserId'];
        Password = json['Password'];
        TfaCode = json['TfaCode'];
        ActivationCode = json['ActivationCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UserId': UserId,
        'Password': Password,
        'TfaCode': TfaCode,
        'ActivationCode': ActivationCode
    };

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

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'PortalAuthenticationRequest': TypeInfo(TypeOf.Class, create:() => PortalAuthenticationRequest()),
});

Dart PortalAuthenticationRequest 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 /PortalAuthentication HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PortalAuthenticationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.CustomerPortal">
  <ActivationCode>String</ActivationCode>
  <Password>String</Password>
  <TfaCode>String</TfaCode>
  <UserId>String</UserId>
</PortalAuthenticationRequest>