Billiecart API

<back to all web services

CreatePersonRequest

The following routes are available for this service:
POST/persons
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserAccountName() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set

    [<AllowNullLiteral>]
    type Person() = 
        member val Name:UserAccountName = null with get,set
        member val DisplayName:String = null with get,set
        member val Email:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val Timezone:String = null with get,set
        member val DefaultOrganisationId:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type CreatePersonResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Person:Person = null with get,set

    [<AllowNullLiteral>]
    type CreatePersonRequest() = 
        inherit PostOperationUnTenanted<CreatePersonResponse>()
        member val UserAccountId:String = null with get,set
        member val Timezone:String = null with get,set
        member val PhoneNumber:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# CreatePersonRequest 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 /persons HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userAccountId: String,
	timezone: String,
	phoneNumber: 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
		}
	},
	person: 
	{
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		email: String,
		phoneNumber: String,
		timezone: String,
		defaultOrganisationId: String,
		id: String
	}
}