| GET | /organisation |
|---|
export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
public embed?: string;
public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
public organisationId?: string;
public constructor(init?: Partial<GetOperationTenanted<TResponse>>) { super(init); (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 GetOrganisationResponse
{
public responseStatus?: ResponseStatus;
public organisation?: Organisation;
public constructor(init?: Partial<GetOrganisationResponse>) { (Object as any).assign(this, init); }
}
export class GetOrganisationRequest extends GetOperationTenanted<GetOrganisationResponse>
{
public constructor(init?: Partial<GetOrganisationRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript GetOrganisationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /organisation HTTP/1.1 Host: staging-api.foundrylab.com Accept: text/jsv
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
}
}