Foundry API

UpdateOrganisationRequest

The following routes are available for this service:
PUT,PATCH	/organisations/{Id}


export class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{

    public constructor(init?: Partial<PutPatchOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class Organisation implements IIdentifiableResource
{
    public displayName?: string;
    public owners?: string[];
    public isDefault?: boolean;
    public id?: string;
    public forceTwoFactor: boolean;

    public constructor(init?: Partial<Organisation>) { (Object as any).assign(this, init); }
}

export class UpdateOrganisationResponse
{
    public responseStatus?: ResponseStatus;
    public organisation?: Organisation;

    public constructor(init?: Partial<UpdateOrganisationResponse>) { (Object as any).assign(this, init); }
}

export class UpdateOrganisationRequest extends PutPatchOperationUnTenanted<UpdateOrganisationResponse>
{
    public id?: string;
    public displayName?: string;

    public constructor(init?: Partial<UpdateOrganisationRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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.foundrylab.com 
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,
		forceTwoFactor: False
	}
}