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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Persons;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Person
        : IIdentifiableResource
    {
        public virtual UserAccountName Name { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string Email { get; set; }
        public virtual string PhoneNumber { get; set; }
        public virtual string Timezone { get; set; }
        public virtual string DefaultOrganisationId { get; set; }
        public virtual string Id { get; set; }
    }

    public partial class UserAccountName
    {
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PutPatchOperationUnTenanted<TResponse>
        : IPatch, IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Persons
{
    public partial class UpdatePersonRequest
        : PutPatchOperationUnTenanted<UpdatePersonResponse>
    {
        public virtual string Id { get; set; }
        public virtual string PhoneNumber { get; set; }
        public virtual string Timezone { get; set; }
    }

    public partial class UpdatePersonResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Person Person { get; set; }
    }

}

C# 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
	}
}