Field Squared API Services

<back to all web services

PortalAuthenticationRequest

The following routes are available for this service:
GET, POST/PortalAuthentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalAuthenticationRequest:
    user_id: Optional[str] = None
    password: Optional[str] = None
    tfa_code: Optional[str] = None
    activation_code: Optional[str] = None

Python 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>