Foundry API

<back to all web services

SearchAllPhotosRequest

import Foundation
import ServiceStack

public class SearchAllPhotosRequest : SearchOperationTenanted<SearchAllPhotosResponse>
{
    public var machineId:String?
    public var observedFrom:Date?
    public var observedTo:Date?

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

    private enum CodingKeys : String, CodingKey {
        case machineId
        case observedFrom
        case observedTo
    }

    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)
        observedFrom = try container.decodeIfPresent(Date.self, forKey: .observedFrom)
        observedTo = try container.decodeIfPresent(Date.self, forKey: .observedTo)
    }

    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) }
        if observedFrom != nil { try container.encode(observedFrom, forKey: .observedFrom) }
        if observedTo != nil { try container.encode(observedTo, forKey: .observedTo) }
    }
}

public class SearchOperationTenanted<TResponse : Codable> : SearchOperationUnTenanted<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 SearchOperationUnTenanted<TResponse : Codable> : GetOperationUnTenanted<TResponse>, IHasSearchOptions
{
    public var distinct:String?
    public var limit:Int?
    public var offset:Int?
    public var sort:String?
    public var filter:String?

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

    private enum CodingKeys : String, CodingKey {
        case distinct
        case limit
        case offset
        case sort
        case filter
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        distinct = try container.decodeIfPresent(String.self, forKey: .distinct)
        limit = try container.decodeIfPresent(Int.self, forKey: .limit)
        offset = try container.decodeIfPresent(Int.self, forKey: .offset)
        sort = try container.decodeIfPresent(String.self, forKey: .sort)
        filter = try container.decodeIfPresent(String.self, forKey: .filter)
    }

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

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

    required public init(){}
}

public class SearchAllPhotosResponse : SearchOperationResponse
{
    public var responseStatus:ResponseStatus?
    public var photos:[Photo] = []

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

    private enum CodingKeys : String, CodingKey {
        case responseStatus
        case photos
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
        photos = try container.decodeIfPresent([Photo].self, forKey: .photos) ?? []
    }

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

public class SearchOperationResponse : Codable
{
    public var metadata:SearchMetadata?

    required public init(){}
}

public class SearchMetadata : Codable
{
    public var total:Int?
    public var limit:Int?
    public var offset:Int?
    public var sort:Sorting?
    public var filter:Filtering?

    required public init(){}
}

public class Sorting : Codable
{
    public var by:String?
    public var direction:SortDirection?

    required public init(){}
}

public enum SortDirection : String, Codable
{
    case Ascending
    case Descending
}

public class Filtering : Codable
{
    public var fields:[String] = []

    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 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"]}}}