Billiecart API

<back to all web services

UpdatePersonRequest

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

public class dtos
{

    public static class UpdatePersonRequest extends PutPatchOperationUnTenanted<UpdatePersonResponse>
    {
        public String id = null;
        public String phoneNumber = null;
        public String timezone = null;
        
        public String getId() { return id; }
        public UpdatePersonRequest setId(String value) { this.id = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public UpdatePersonRequest setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public String getTimezone() { return timezone; }
        public UpdatePersonRequest setTimezone(String value) { this.timezone = value; return this; }
    }

    public static class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
    {
        
    }

    public static class UpdatePersonResponse
    {
        public ResponseStatus responseStatus = null;
        public Person person = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public UpdatePersonResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Person getPerson() { return person; }
        public UpdatePersonResponse setPerson(Person value) { this.person = value; return this; }
    }

    public static class Person implements IIdentifiableResource
    {
        public UserAccountName name = null;
        public String displayName = null;
        public String email = null;
        public String phoneNumber = null;
        public String timezone = null;
        public String defaultOrganisationId = null;
        public String id = null;
        
        public UserAccountName getName() { return name; }
        public Person setName(UserAccountName value) { this.name = value; return this; }
        public String getDisplayName() { return displayName; }
        public Person setDisplayName(String value) { this.displayName = value; return this; }
        public String getEmail() { return email; }
        public Person setEmail(String value) { this.email = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public Person setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public String getTimezone() { return timezone; }
        public Person setTimezone(String value) { this.timezone = value; return this; }
        public String getDefaultOrganisationId() { return defaultOrganisationId; }
        public Person setDefaultOrganisationId(String value) { this.defaultOrganisationId = value; return this; }
        public String getId() { return id; }
        public Person setId(String value) { this.id = value; return this; }
    }

    public static class UserAccountName
    {
        public String firstName = null;
        public String lastName = null;
        
        public String getFirstName() { return firstName; }
        public UserAccountName setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public UserAccountName setLastName(String value) { this.lastName = value; return this; }
    }

}

Java UpdatePersonRequest 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.

PUT /persons/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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