Billiecart API

<back to all web services

InviteGuestRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/users/invite
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class InviteGuestRequest extends PostOperationUnTenanted<InviteGuestResponse>
    {
        public String email = null;
        
        public String getEmail() { return email; }
        public InviteGuestRequest setEmail(String value) { this.email = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class InviteGuestResponse
    {
        public ResponseStatus responseStatus = null;
        public Invitation invitation = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public InviteGuestResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Invitation getInvitation() { return invitation; }
        public InviteGuestResponse setInvitation(Invitation value) { this.invitation = value; return this; }
    }

    public static class Invitation
    {
        public String firstName = null;
        public String lastName = null;
        public String email = null;
        public String id = null;
        
        public String getFirstName() { return firstName; }
        public Invitation setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public Invitation setLastName(String value) { this.lastName = value; return this; }
        public String getEmail() { return email; }
        public Invitation setEmail(String value) { this.email = value; return this; }
        public String getId() { return id; }
        public Invitation setId(String value) { this.id = value; return this; }
    }

}

Java 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.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: 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,
		email: String,
		id: String
	}
}