Billiecart API

<back to all web services

CreateOrganisationRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/organisations
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateOrganisationRequest : PostOperationUnTenanted<CreateOrganisationResponse>()
{
    var name:String? = null
}

open class PostOperationUnTenanted<TResponse> : IPost
{
}

open class CreateOrganisationResponse
{
    var responseStatus:ResponseStatus? = null
    var organisation:Organisation? = null
}

open class Organisation : IIdentifiableResource
{
    var displayName:String? = null
    var owners:ArrayList<String> = ArrayList<String>()
    var isDefault:Boolean? = null
    var id:String? = null
}

Kotlin CreateOrganisationRequest 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.

POST /organisations HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"name":"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"}}