| GET | /v1/product/metadata |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Booklinker.API.ServiceModel.V1.Requests
Imports Booklinker.API.ServiceModel.V1.Responses
Imports Booklinker.API.ServiceModel.V1.DTOs
Imports ProductAPI.Contracts.V1.DTOs
Namespace Global
Namespace Booklinker.API.ServiceModel.V1.DTOs
<DataContract>
Public Partial Class ProductMetadata
Inherits ProductMetadata
End Class
End Namespace
Namespace Booklinker.API.ServiceModel.V1.Requests
<DataContract>
Public Partial Class GetProductMetadataRequest
<DataMember(Name:="url")>
<ApiMember(IsRequired:=true)>
Public Overridable Property Url As String
End Class
End Namespace
Namespace Booklinker.API.ServiceModel.V1.Responses
<DataContract>
Public Partial Class GetProductMetadataResponse
<DataMember(Name:="productMetadata")>
Public Overridable Property ProductMetadata As ProductMetadata
<DataMember(Name:="isSupported")>
Public Overridable Property IsSupported As Boolean
<DataMember(Name:="responseStatus")>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
Namespace ProductAPI.Contracts.V1.DTOs
<DataContract>
Public Partial Class ProductMetadata
<DataMember(Name:="title")>
Public Overridable Property Title As String
<DataMember(Name:="author")>
Public Overridable Property Author As String
<DataMember(Name:="url")>
Public Overridable Property Url As Uri
<DataMember(Name:="description")>
Public Overridable Property Description As String
<DataMember(Name:="retailer")>
Public Overridable Property Retailer As String
<DataMember(Name:="productImages")>
Public Overridable Property ProductImages As IDictionary(Of String, Uri)
End Class
End Namespace
End Namespace
VB.NET GetProductMetadataRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/product/metadata HTTP/1.1 Host: api.booklinker.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"productMetadata":{"title":"String","author":"String","description":"String","retailer":"String"},"isSupported":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}