Foundry API

<back to all web services

SearchAllPhotosRequest

export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

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

export class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
    public distinct?: string;
    public limit?: number;
    public offset?: number;
    public sort?: string;
    public filter?: string;

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

export class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export enum SortDirection
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class Sorting
{
    public by?: string;
    public direction: SortDirection;

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

export class Filtering
{
    public fields?: string[];

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

export class SearchMetadata
{
    public total: number;
    public limit: number;
    public offset: number;
    public sort?: Sorting;
    public filter?: Filtering;

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

export class SearchOperationResponse
{
    public metadata?: SearchMetadata;

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

export class Photo implements IIdentifiableResource
{
    public uploadedAt: string;
    public imageUrl?: string;
    public thumbnailUrl?: string;
    public id?: string;

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

export class SearchAllPhotosResponse extends SearchOperationResponse
{
    public responseStatus?: ResponseStatus;
    public photos?: Photo[];

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

export class SearchAllPhotosRequest extends SearchOperationTenanted<SearchAllPhotosResponse>
{
    public machineId?: string;
    public observedFrom: string;
    public observedTo: string;

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

TypeScript SearchAllPhotosRequest DTOs

GET /machines/{MachineId}/viewpoint HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"photos":[{"imageUrl":"String","thumbnailUrl":"String","id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"]}}}