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}
UpdateOrganisationRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
DisplayNamebodystringNo
UpdateOrganisationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
OrganisationformOrganisationNo
Organisation Parameters:
NameParameterData TypeRequiredDescription
DisplayNameformstringNo
OwnersformList<string>No
IsDefaultformbool?No
IdformstringNo
UpdateOrganisationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
OrganisationformOrganisationNo

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