| GET | /searchResults | Use 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResourceItemSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
<SearchResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
<d2p1:Id>String</d2p1:Id>
<d2p1:ItemCount>0</d2p1:ItemCount>
<d2p1:ResourceItems>
<d2p1:ResourceItemForSearch>
<d2p1:Categories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d2p1:Categories>
<d2p1:CategoryIndexes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d2p1:CategoryIndexes>
<d2p1:Content>String</d2p1:Content>
<d2p1:Description>String</d2p1:Description>
<d2p1:DescriptionSummary>String</d2p1:DescriptionSummary>
<d2p1:Difficulty>String</d2p1:Difficulty>
<d2p1:Duration>String</d2p1:Duration>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsComplete>false</d2p1:IsComplete>
<d2p1:IsFavorite>false</d2p1:IsFavorite>
<d2p1:IsImplicitlyComplete>false</d2p1:IsImplicitlyComplete>
<d2p1:MediaPath>String</d2p1:MediaPath>
<d2p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d2p1:Tags>
<d2p1:Thumbnail>String</d2p1:Thumbnail>
<d2p1:Title>String</d2p1:Title>
<d2p1:Transcript>String</d2p1:Transcript>
<d2p1:Type>String</d2p1:Type>
</d2p1:ResourceItemForSearch>
</d2p1:ResourceItems>
<d2p1:SearchItems>
<d2p1:ResourceItemForSearch>
<d2p1:Categories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d2p1:Categories>
<d2p1:CategoryIndexes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d2p1:CategoryIndexes>
<d2p1:Content>String</d2p1:Content>
<d2p1:Description>String</d2p1:Description>
<d2p1:DescriptionSummary>String</d2p1:DescriptionSummary>
<d2p1:Difficulty>String</d2p1:Difficulty>
<d2p1:Duration>String</d2p1:Duration>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsComplete>false</d2p1:IsComplete>
<d2p1:IsFavorite>false</d2p1:IsFavorite>
<d2p1:IsImplicitlyComplete>false</d2p1:IsImplicitlyComplete>
<d2p1:MediaPath>String</d2p1:MediaPath>
<d2p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d2p1:Tags>
<d2p1:Thumbnail>String</d2p1:Thumbnail>
<d2p1:Title>String</d2p1:Title>
<d2p1:Transcript>String</d2p1:Transcript>
<d2p1:Type>String</d2p1:Type>
</d2p1:ResourceItemForSearch>
</d2p1:SearchItems>
<d2p1:Tags>
<d2p1:Tag>
<d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
</d2p1:Tag>
</d2p1:Tags>
</SearchResults>
</ResourceItemSearchResponse>