Foundry API

InviteGuestRequest

The following routes are available for this service:
POST	/users/invite

import java.math.*
import java.util.*
import net.servicestack.client.*


open class InviteGuestRequest : PostOperationUnTenanted<InviteGuestResponse>()
{
    var emailAddress:String? = null
}

open class PostOperationUnTenanted<TResponse> : IPost
{
}

open class InviteGuestResponse
{
    var responseStatus:ResponseStatus? = null
    var invitation:Invitation? = null
}

open class Invitation
{
    var firstName:String? = null
    var lastName:String? = null
    var emailAddress:String? = null
}

Kotlin InviteGuestRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/invite HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	emailAddress: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	invitation: 
	{
		firstName: String,
		lastName: String,
		emailAddress: String
	}
}