Billiecart API

<back to all web services

GetPersonRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/persons/{Id}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetPersonRequest : GetOperationUnTenanted<GetPersonResponse>()
{
    var id:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class GetPersonResponse
{
    var responseStatus:ResponseStatus? = null
    var person:Person? = null
}

open class Person : IIdentifiableResource
{
    var name:UserAccountName? = null
    var displayName:String? = null
    var email:String? = null
    var phoneNumber:String? = null
    var timezone:String? = null
    var defaultOrganisationId:String? = null
    var id:String? = null
}

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

Kotlin GetPersonRequest 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.

GET /persons/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
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
	}
}