| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET | /v1/Products/{UserID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Products/ |
import Foundation
import ServiceStack
public class ProductsRequest : Codable
{
public var userID:String
public var products:[Product] = []
required public init(){}
}
public class Product : Codable
{
public var id:Int
public var productName:String
public var productTypeID:UInt8
public var unitPrice:Double
public var Description:String
public var imageURL:String
public var imageKey:String
public var specialSaleText:String
public var shipPrice:Double
public var salePrice:Double
public var uid:String
public var productCategory:UInt8
public var productSubCategory:UInt8
public var productWeight:Double
public var freightMarkupPercent:Double
public var freightMarkUpAmount:Double
public var pointValue:Double
public var isActive:Bool
public var stripeProductId:String
required public init(){}
}
public class ProductsResponse : Codable
{
public var responseStatus:ResponseStatus
public var products:[Product] = []
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Products/ HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
UserID: 00000000000000000000000000000000,
Products:
[
{
ID: 0,
ProductName: String,
ProductTypeID: 0,
UnitPrice: 0,
Description: String,
ImageURL: String,
ImageKey: String,
SpecialSaleText: String,
ShipPrice: 0,
SalePrice: 0,
UID: 00000000000000000000000000000000,
ProductCategory: 0,
ProductSubCategory: 0,
ProductWeight: 0,
FreightMarkupPercent: 0,
FreightMarkUpAmount: 0,
PointValue: 0,
IsActive: False,
StripeProductId: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Products:
[
{
ID: 0,
ProductName: String,
ProductTypeID: 0,
UnitPrice: 0,
Description: String,
ImageURL: String,
ImageKey: String,
SpecialSaleText: String,
ShipPrice: 0,
SalePrice: 0,
UID: 00000000000000000000000000000000,
ProductCategory: 0,
ProductSubCategory: 0,
ProductWeight: 0,
FreightMarkupPercent: 0,
FreightMarkUpAmount: 0,
PointValue: 0,
IsActive: False,
StripeProductId: String
}
]
}