| Required role: | SystemAdmin |
| POST | /usergroupuserinvite |
|---|
namespace sfgboxapi.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type UserAuth() =
member val Id:Int32 = new Int32() with get,set
member val UserName:String = null with get,set
member val Email:String = null with get,set
member val PrimaryEmail:String = null with get,set
member val PhoneNumber:String = null with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val DisplayName:String = null with get,set
member val Company:String = null with get,set
member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val BirthDateRaw:String = null with get,set
member val Address:String = null with get,set
member val Address2:String = null with get,set
member val City:String = null with get,set
member val State:String = null with get,set
member val Country:String = null with get,set
member val Culture:String = null with get,set
member val FullName:String = null with get,set
member val Gender:String = null with get,set
member val Language:String = null with get,set
member val MailAddress:String = null with get,set
member val Nickname:String = null with get,set
member val PostalCode:String = null with get,set
member val TimeZone:String = null with get,set
member val Salt:String = null with get,set
member val PasswordHash:String = null with get,set
member val DigestHa1Hash:String = null with get,set
member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Permissions:ResizeArray<String> = new ResizeArray<String>() with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val ModifiedDate:DateTime = new DateTime() with get,set
member val InvalidLoginAttempts:Int32 = new Int32() with get,set
member val LastLoginAttempt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LockedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val RecoveryToken:String = null with get,set
member val RefId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RefIdStr:String = null with get,set
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type UserGroupUserInvite() =
[<Validate(Validator="Email")>]
member val EMail:String = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
eMail: String,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: 0,
userName: String,
email: String,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
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: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String,
meta:
{
String: String
}
}