ASH.ResourceLibrary.WebApi

<back to all web services

ResourceItemSearchRequest

Requires Authentication
The following routes are available for this service:
GET/searchResultsUse to search Resource Items
import Foundation
import ServiceStack

public class ResourceItemSearchRequest : BasicResourceLibraryRequest
{
    public var request:String?
    public var tags:[String] = []
    public var categoryId:String?
    public var offset:Int?
    public var limit:Int?
    public var digitalFitness:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case request
        case tags
        case categoryId
        case offset
        case limit
        case digitalFitness
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        request = try container.decodeIfPresent(String.self, forKey: .request)
        tags = try container.decodeIfPresent([String].self, forKey: .tags) ?? []
        categoryId = try container.decodeIfPresent(String.self, forKey: .categoryId)
        offset = try container.decodeIfPresent(Int.self, forKey: .offset)
        limit = try container.decodeIfPresent(Int.self, forKey: .limit)
        digitalFitness = try container.decodeIfPresent(Bool.self, forKey: .digitalFitness)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if request != nil { try container.encode(request, forKey: .request) }
        if tags.count > 0 { try container.encode(tags, forKey: .tags) }
        if categoryId != nil { try container.encode(categoryId, forKey: .categoryId) }
        if offset != nil { try container.encode(offset, forKey: .offset) }
        if limit != nil { try container.encode(limit, forKey: .limit) }
        if digitalFitness != nil { try container.encode(digitalFitness, forKey: .digitalFitness) }
    }
}

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

    required public init(){}
}

public class ResourceItemSearchResponse : Codable
{
    public var searchResults:SearchResult?

    required public init(){}
}

public class SearchResult : Codable
{
    public var id:String?
    public var resourceItems:[ResourceItemForSearch] = []
    public var searchItems:[ResourceItemForSearch] = []
    public var tags:[Tag] = []
    public var itemCount:Int?

    required public init(){}
}

public class ResourceItemForSearch : Codable
{
    public var id:String?
    public var type:String?
    public var categories:[String] = []
    public var categoryIndexes:[String] = []
    public var title:String?
    public var Description:String?
    public var descriptionSummary:String?
    public var content:String?
    public var tags:[String] = []
    public var isComplete:Bool?
    public var isFavorite:Bool?
    public var isImplicitlyComplete:Bool?
    public var transcript:String?
    public var thumbnail:String?
    public var difficulty:String?
    public var duration:String?
    public var mediaPath:String?

    required public init(){}
}

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

    required public init(){}
}


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

{"searchResults":{"id":"String","resourceItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"searchItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"tags":[{"id":"String","title":"String"}],"itemCount":0}}