sfgboxapi

UserGroupUserInvite

**Requires Authentication**
Required role:	SystemAdmin

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


export class UserAuth
{
    public id: number;
    public userName: string;
    public email: string;
    public primaryEmail: string;
    public phoneNumber: string;
    public firstName: string;
    public lastName: string;
    public displayName: string;
    public company: string;
    public birthDate?: string;
    public birthDateRaw: string;
    public address: string;
    public address2: string;
    public city: string;
    public state: string;
    public country: string;
    public culture: string;
    public fullName: string;
    public gender: string;
    public language: string;
    public mailAddress: string;
    public nickname: string;
    public postalCode: string;
    public timeZone: string;
    public salt: string;
    public passwordHash: string;
    public digestHa1Hash: string;
    public roles: string[];
    public permissions: string[];
    public createdDate: string;
    public modifiedDate: string;
    public invalidLoginAttempts: number;
    public lastLoginAttempt?: string;
    public lockedDate?: string;
    public recoveryToken: string;
    public refId?: number;
    public refIdStr: string;
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<UserAuth>) { (Object as any).assign(this, init); }
}

export class UserGroupUserInvite
{
    // @Validate(Validator="Email")
    public eMail: string;

    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<UserGroupUserInvite>) { (Object as any).assign(this, init); }
}

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