Billiecart API

<back to all web services

PromoteOrganisationOwnerRequest

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

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class Organisation
            Implements IIdentifiableResource
            Public Sub New()
                Owners = New List(Of String)
            End Sub

            Public Overridable Property DisplayName As String
            Public Overridable Property Owners As List(Of String)
            Public Overridable Property IsDefault As Nullable(Of Boolean)
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PostOperationUnTenanted(Of TResponse)
            Implements IPost
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations

        Public Partial Class PromoteOrganisationOwnerRequest
            Inherits PostOperationUnTenanted(Of PromoteOrganisationOwnerResponse)
            Public Overridable Property Id As String
            Public Overridable Property UserAccountId As String
        End Class

        Public Partial Class PromoteOrganisationOwnerResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Organisation As Organisation
        End Class
    End Namespace
End Namespace

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

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