Billiecart API

<back to all web services

UpdateOrganisationRequest

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

public class dtos
{

    public static class UpdateOrganisationRequest extends PutPatchOperationUnTenanted<UpdateOrganisationResponse>
    {
        public String id = null;
        public String displayName = null;
        
        public String getId() { return id; }
        public UpdateOrganisationRequest setId(String value) { this.id = value; return this; }
        public String getDisplayName() { return displayName; }
        public UpdateOrganisationRequest setDisplayName(String value) { this.displayName = value; return this; }
    }

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

    public static class UpdateOrganisationResponse
    {
        public ResponseStatus responseStatus = null;
        public Organisation organisation = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public UpdateOrganisationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Organisation getOrganisation() { return organisation; }
        public UpdateOrganisationResponse setOrganisation(Organisation value) { this.organisation = value; return this; }
    }

    public static class Organisation implements IIdentifiableResource
    {
        public String displayName = null;
        public ArrayList<String> owners = null;
        public Boolean isDefault = null;
        public String id = null;
        
        public String getDisplayName() { return displayName; }
        public Organisation setDisplayName(String value) { this.displayName = value; return this; }
        public ArrayList<String> getOwners() { return owners; }
        public Organisation setOwners(ArrayList<String> value) { this.owners = value; return this; }
        public Boolean getIsDefault() { return isDefault; }
        public Organisation setIsDefault(Boolean value) { this.isDefault = value; return this; }
        public String getId() { return id; }
        public Organisation setId(String value) { this.id = value; return this; }
    }

}

Java UpdateOrganisationRequest 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 /organisations/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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