Billiecart API

<back to all web services

CreateOrganisationRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/organisations
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Organisations;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Organisation
        : IIdentifiableResource
    {
        public Organisation()
        {
            Owners = new List<string>{};
        }

        public virtual string DisplayName { get; set; }
        public virtual List<string> Owners { get; set; }
        public virtual bool? IsDefault { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PostOperationUnTenanted<TResponse>
        : IPost
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations
{
    public partial class CreateOrganisationRequest
        : PostOperationUnTenanted<CreateOrganisationResponse>
    {
        public virtual string Name { get; set; }
    }

    public partial class CreateOrganisationResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Organisation Organisation { get; set; }
    }

}

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

{
	name: 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
		}
	},
	organisation: 
	{
		displayName: String,
		owners: 
		[
			String
		],
		isDefault: False,
		id: String
	}
}