sfgboxapi

UserGroupUserInvite

**Requires Authentication**
Required role:	SystemAdmin

The following routes are available for this service:
POST	/usergroupuserinvite

import 'package:servicestack/servicestack.dart';

class UserAuth implements IConvertible
{
    int? id;
    String? userName;
    String? email;
    String? primaryEmail;
    String? phoneNumber;
    String? firstName;
    String? lastName;
    String? displayName;
    String? company;
    DateTime? birthDate;
    String? birthDateRaw;
    String? address;
    String? address2;
    String? city;
    String? state;
    String? country;
    String? culture;
    String? fullName;
    String? gender;
    String? language;
    String? mailAddress;
    String? nickname;
    String? postalCode;
    String? timeZone;
    String? salt;
    String? passwordHash;
    String? digestHa1Hash;
    List<String>? roles;
    List<String>? permissions;
    DateTime? createdDate;
    DateTime? modifiedDate;
    int? invalidLoginAttempts;
    DateTime? lastLoginAttempt;
    DateTime? lockedDate;
    String? recoveryToken;
    int? refId;
    String? refIdStr;
    Map<String,String?>? meta;

    UserAuth({this.id,this.userName,this.email,this.primaryEmail,this.phoneNumber,this.firstName,this.lastName,this.displayName,this.company,this.birthDate,this.birthDateRaw,this.address,this.address2,this.city,this.state,this.country,this.culture,this.fullName,this.gender,this.language,this.mailAddress,this.nickname,this.postalCode,this.timeZone,this.salt,this.passwordHash,this.digestHa1Hash,this.roles,this.permissions,this.createdDate,this.modifiedDate,this.invalidLoginAttempts,this.lastLoginAttempt,this.lockedDate,this.recoveryToken,this.refId,this.refIdStr,this.meta});
    UserAuth.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        userName = json['userName'];
        email = json['email'];
        primaryEmail = json['primaryEmail'];
        phoneNumber = json['phoneNumber'];
        firstName = json['firstName'];
        lastName = json['lastName'];
        displayName = json['displayName'];
        company = json['company'];
        birthDate = JsonConverters.fromJson(json['birthDate'],'DateTime',context!);
        birthDateRaw = json['birthDateRaw'];
        address = json['address'];
        address2 = json['address2'];
        city = json['city'];
        state = json['state'];
        country = json['country'];
        culture = json['culture'];
        fullName = json['fullName'];
        gender = json['gender'];
        language = json['language'];
        mailAddress = json['mailAddress'];
        nickname = json['nickname'];
        postalCode = json['postalCode'];
        timeZone = json['timeZone'];
        salt = json['salt'];
        passwordHash = json['passwordHash'];
        digestHa1Hash = json['digestHa1Hash'];
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        permissions = JsonConverters.fromJson(json['permissions'],'List<String>',context!);
        createdDate = JsonConverters.fromJson(json['createdDate'],'DateTime',context!);
        modifiedDate = JsonConverters.fromJson(json['modifiedDate'],'DateTime',context!);
        invalidLoginAttempts = json['invalidLoginAttempts'];
        lastLoginAttempt = JsonConverters.fromJson(json['lastLoginAttempt'],'DateTime',context!);
        lockedDate = JsonConverters.fromJson(json['lockedDate'],'DateTime',context!);
        recoveryToken = json['recoveryToken'];
        refId = json['refId'];
        refIdStr = json['refIdStr'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'userName': userName,
        'email': email,
        'primaryEmail': primaryEmail,
        'phoneNumber': phoneNumber,
        'firstName': firstName,
        'lastName': lastName,
        'displayName': displayName,
        'company': company,
        'birthDate': JsonConverters.toJson(birthDate,'DateTime',context!),
        'birthDateRaw': birthDateRaw,
        'address': address,
        'address2': address2,
        'city': city,
        'state': state,
        'country': country,
        'culture': culture,
        'fullName': fullName,
        'gender': gender,
        'language': language,
        'mailAddress': mailAddress,
        'nickname': nickname,
        'postalCode': postalCode,
        'timeZone': timeZone,
        'salt': salt,
        'passwordHash': passwordHash,
        'digestHa1Hash': digestHa1Hash,
        'roles': JsonConverters.toJson(roles,'List<String>',context!),
        'permissions': JsonConverters.toJson(permissions,'List<String>',context!),
        'createdDate': JsonConverters.toJson(createdDate,'DateTime',context!),
        'modifiedDate': JsonConverters.toJson(modifiedDate,'DateTime',context!),
        'invalidLoginAttempts': invalidLoginAttempts,
        'lastLoginAttempt': JsonConverters.toJson(lastLoginAttempt,'DateTime',context!),
        'lockedDate': JsonConverters.toJson(lockedDate,'DateTime',context!),
        'recoveryToken': recoveryToken,
        'refId': refId,
        'refIdStr': refIdStr,
        'meta': meta
    };

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

class UserGroupUserInvite implements IConvertible
{
    // @Validate(Validator="Email")
    String? eMail;

    ResponseStatus? responseStatus;

    UserGroupUserInvite({this.eMail,this.responseStatus});
    UserGroupUserInvite.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'eMail': eMail,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'sfgboxapi.dev.scadsoftware.com', types: <String, TypeInfo> {
    'UserAuth': TypeInfo(TypeOf.Class, create:() => UserAuth()),
    'UserGroupUserInvite': TypeInfo(TypeOf.Class, create:() => UserGroupUserInvite()),
});

Dart UserGroupUserInvite 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 /usergroupuserinvite HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserGroupUserInvite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <EMail>String</EMail>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UserGroupUserInvite>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAuth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Address>String</Address>
  <Address2>String</Address2>
  <BirthDate>0001-01-01T00:00:00</BirthDate>
  <BirthDateRaw>String</BirthDateRaw>
  <City>String</City>
  <Company>String</Company>
  <Country>String</Country>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Culture>String</Culture>
  <DigestHa1Hash>String</DigestHa1Hash>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <FullName>String</FullName>
  <Gender>String</Gender>
  <Id>0</Id>
  <InvalidLoginAttempts>0</InvalidLoginAttempts>
  <Language>String</Language>
  <LastLoginAttempt>0001-01-01T00:00:00</LastLoginAttempt>
  <LastName>String</LastName>
  <LockedDate>0001-01-01T00:00:00</LockedDate>
  <MailAddress>String</MailAddress>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
  <Nickname>String</Nickname>
  <PasswordHash>String</PasswordHash>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <PhoneNumber>String</PhoneNumber>
  <PostalCode>String</PostalCode>
  <PrimaryEmail>String</PrimaryEmail>
  <RecoveryToken>String</RecoveryToken>
  <RefId>0</RefId>
  <RefIdStr>String</RefIdStr>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Salt>String</Salt>
  <State>String</State>
  <TimeZone>String</TimeZone>
  <UserName>String</UserName>
</UserAuth>