Foundry API

<back to all web services

GetOrganisationRequest

Requires Authentication
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /organisation HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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}}