Foundry API

<back to all web services

GetLatestPhotoRequest

Requires Authentication
The following routes are available for this service:
GET/machines/{MachineId}/viewpoint/latest
import Foundation
import ServiceStack

public class GetLatestPhotoRequest : GetOperationTenanted<GetLatestPhotoResponse>
{
    public var machineId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case machineId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        machineId = try container.decodeIfPresent(String.self, forKey: .machineId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if machineId != nil { try container.encode(machineId, forKey: .machineId) }
    }
}

public class GetOperationTenanted<TResponse : Codable> : GetOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
    }
}

public class GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
    public var embed:String?

    required public init(){}
}

public class GetLatestPhotoResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var photo:Photo?

    required public init(){}
}

public class Photo : IIdentifiableResource, Codable
{
    public var uploadedAt:Date?
    public var imageUrl:String?
    public var thumbnailUrl:String?
    public var id:String?

    required public init(){}
}


Swift GetLatestPhotoRequest 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.

GET /machines/{MachineId}/viewpoint/latest 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"}},"photo":{"imageUrl":"String","thumbnailUrl":"String","id":"String"}}