ASH.ResourceLibrary.WebApi

<back to all web services

ResourceLookAheadRequest

Requires Authentication
The following routes are available for this service:
GET/lookaheadResultsUse to get lookahead response for resourceitems
import Foundation
import ServiceStack

public class ResourceLookAheadRequest : BasicResourceLibraryRequest
{
    public var text:String?
    /**
    * Set it to true if requesting resources only from digital library
    */
    // @ApiMember(Description="Set it to true if requesting resources only from digital library")
    public var digitalFitness:Bool?

    /**
    * Set it to true if requesting resources only from health library
    */
    // @ApiMember(Description="Set it to true if requesting resources only from health library")
    public var healthLibrary:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case text
        case digitalFitness
        case healthLibrary
    }

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

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

public class BasicResourceLibraryRequest : Codable
{
    public var resourceLibraryMemberId:Int?

    required public init(){}
}

public class ResourceLookAheadResponse : Codable
{
    public var lookaheadResult:LookaheadResult?

    required public init(){}
}

public class LookaheadResult : Codable
{
    public var id:String?
    public var lookaheadTitles:[LookaheadTitle] = []
    public var lookaheadTags:[LookaheadTag] = []

    required public init(){}
}

public class LookaheadTitle : Codable
{
    public var id:String?
    public var title:String?
    public var subtitle:String?

    required public init(){}
}

public class LookaheadTag : Codable
{
    public var id:String?
    public var title:String?

    required public init(){}
}


Swift ResourceLookAheadRequest 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 /lookaheadResults HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"lookaheadResult":{"id":"String","lookaheadTitles":[{"id":"String","title":"String","subtitle":"String"}],"lookaheadTags":[{"id":"String","title":"String"}]}}