Billiecart API

DeliverEmailRequest

**Requires Authentication**
Required role:	service

The following routes are available for this service:
POST	/emails/deliver


export class PostOperationUnTenanted<TResponse> implements IPost
{

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

export class DeliverEmailResponse
{
    public responseStatus?: ResponseStatus;
    public isDelivered: boolean;

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

export class DeliverEmailRequest extends PostOperationUnTenanted<DeliverEmailResponse>
{
    public message?: string;

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

TypeScript DeliverEmailRequest 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 /emails/deliver HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	message: 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
		}
	},
	isDelivered: False
}