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}
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 PutPatchOperationUnTenanted<TResponse>
        : IPatch, IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations
{
    public partial class UpdateOrganisationRequest
        : PutPatchOperationUnTenanted<UpdateOrganisationResponse>
    {
        public virtual string Id { get; set; }
        public virtual string DisplayName { get; set; }
    }

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

}

C# UpdateOrganisationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","displayName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}