Foundry API

<back to all web services

UploadViewpointPhotoRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{MachineId}/viewpoint
import 'package:servicestack/servicestack.dart';

abstract class PostOperationUnTenanted<TResponse> implements IPost
{
    PostOperationUnTenanted();
    PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PostOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PostOperationTenanted({this.organisationId});
    PostOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        organisationId = json['organisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'organisationId': organisationId
    });

    getTypeName() => "PostOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class Photo implements IIdentifiableResource, IConvertible
{
    DateTime? uploadedAt;
    String? imageUrl;
    String? thumbnailUrl;
    String? id;

    Photo({this.uploadedAt,this.imageUrl,this.thumbnailUrl,this.id});
    Photo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uploadedAt = JsonConverters.fromJson(json['uploadedAt'],'DateTime',context!);
        imageUrl = json['imageUrl'];
        thumbnailUrl = json['thumbnailUrl'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uploadedAt': JsonConverters.toJson(uploadedAt,'DateTime',context!),
        'imageUrl': imageUrl,
        'thumbnailUrl': thumbnailUrl,
        'id': id
    };

    getTypeName() => "Photo";
    TypeContext? context = _ctx;
}

class UploadViewpointPhotoResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Photo? photo;

    UploadViewpointPhotoResponse({this.responseStatus,this.photo});
    UploadViewpointPhotoResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        photo = JsonConverters.fromJson(json['photo'],'Photo',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'photo': JsonConverters.toJson(photo,'Photo',context!)
    };

    getTypeName() => "UploadViewpointPhotoResponse";
    TypeContext? context = _ctx;
}

class UploadViewpointPhotoRequest extends PostOperationTenanted<UploadViewpointPhotoResponse> implements IConvertible
{
    String? machineId;
    DateTime? uploadedAt;

    UploadViewpointPhotoRequest({this.machineId,this.uploadedAt});
    UploadViewpointPhotoRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        machineId = json['machineId'];
        uploadedAt = JsonConverters.fromJson(json['uploadedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'machineId': machineId,
        'uploadedAt': JsonConverters.toJson(uploadedAt,'DateTime',context!)
    });

    getTypeName() => "UploadViewpointPhotoRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PostOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Photo': TypeInfo(TypeOf.Class, create:() => Photo()),
    'UploadViewpointPhotoResponse': TypeInfo(TypeOf.Class, create:() => UploadViewpointPhotoResponse()),
    'UploadViewpointPhotoRequest': TypeInfo(TypeOf.Class, create:() => UploadViewpointPhotoRequest()),
});

Dart UploadViewpointPhotoRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /machines/{MachineId}/viewpoint HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"machineId":"String","organisationId":"String"}
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"}},"photo":{"imageUrl":"String","thumbnailUrl":"String","id":"String"}}