| GET | /principal/get |
|---|
namespace WebService.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
///<summary>
///Information about the response.
///</summary>
[<ApiMember(Description="Information about the response.", IsRequired=true)>]
member val Description:String = null with get,set
///<summary>
///Heading or summary of the response.
///</summary>
[<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
member val Heading:String = null with get,set
///<summary>
///Did the intended operation for this response complete successfully?
///</summary>
[<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
member val WasSuccessful:Boolean = new Boolean() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type ProductData() =
member val ProductId:Int32 = new Int32() with get,set
member val PrincipalId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Category:String = null with get,set
member val ProductCode:String = null with get,set
member val UnitBarcode:String = null with get,set
member val CartonQuantity:Int32 = new Int32() with get,set
member val ShrinkQuantity:Int32 = new Int32() with get,set
member val UnitQuantity:Int32 = new Int32() with get,set
member val CartonMeasurement:String = null with get,set
member val ShrinkMeasurement:String = null with get,set
member val UnitMeasurement:String = null with get,set
member val CartonWeight:Double = new Double() with get,set
member val ShrinkWeight:Double = new Double() with get,set
member val UnitWeight:Decimal = new Decimal() with get,set
member val CartonPrice:Decimal = new Decimal() with get,set
member val ShrinkPrice:Decimal = new Decimal() with get,set
member val UnitPrice:Decimal = new Decimal() with get,set
member val MaxQuantity:Int32 = new Int32() with get,set
member val MaxPrice:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type ProductDataCategory() =
member val UnitBarcode:String = null with get,set
member val Products:ResizeArray<ProductData> = new ResizeArray<ProductData>() with get,set
[<AllowNullLiteral>]
type ProductExceptionData() =
member val Region:String = null with get,set
member val Channel:String = null with get,set
member val ProductId:Int32 = new Int32() with get,set
member val StockStatusIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
[<AllowNullLiteral>]
type PrincipalData() =
member val PrincipalId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val AuthLetterFileUrl:ResizeArray<String> = new ResizeArray<String>() with get,set
member val LogoImageUrl:String = null with get,set
member val Products:ResizeArray<ProductDataCategory> = new ResizeArray<ProductDataCategory>() with get,set
member val UpliftPrefix:String = null with get,set
member val ContactName:String = null with get,set
member val ContactNumber:String = null with get,set
member val ContactEmail:String = null with get,set
member val AllowProductLookup:Boolean = new Boolean() with get,set
member val HasLogo:Boolean = new Boolean() with get,set
member val HasAuthLetter:Boolean = new Boolean() with get,set
member val SealNetWeightMandatory:Boolean = new Boolean() with get,set
member val AllowBillableSeals:Boolean = new Boolean() with get,set
member val CaptureSerialNumber:Boolean = new Boolean() with get,set
member val BatchCodesMandatory:Boolean = new Boolean() with get,set
member val CaptureManufactureAndExpiryDate:Boolean = new Boolean() with get,set
member val ProductExceptions:ResizeArray<ProductExceptionData> = new ResizeArray<ProductExceptionData>() with get,set
member val UsesOwnSealNumbers:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type GetPrincipalResponse() =
inherit ApiServiceResponse()
member val Data:PrincipalData = null with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
///<summary>
///Latitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///Longitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
member val Longitude:Double = new Double() with get,set
[<AllowNullLiteral>]
type GetPrincipal() =
inherit ApiServiceRequest()
member val PrincipalId:Int32 = new Int32() with get,set
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.
GET /principal/get HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
data:
{
principalId: 0,
name: String,
authLetterFileUrl:
[
String
],
logoImageUrl: String,
products:
[
{
unitBarcode: String,
products:
[
{
productId: 0,
principalId: 0,
name: String,
category: String,
productCode: String,
unitBarcode: String,
cartonQuantity: 0,
shrinkQuantity: 0,
unitQuantity: 0,
cartonMeasurement: String,
shrinkMeasurement: String,
unitMeasurement: String,
cartonWeight: 0,
shrinkWeight: 0,
unitWeight: 0,
cartonPrice: 0,
shrinkPrice: 0,
unitPrice: 0,
maxQuantity: 0,
maxPrice: 0
}
]
}
],
upliftPrefix: String,
contactName: String,
contactNumber: String,
contactEmail: String,
allowProductLookup: False,
hasLogo: False,
hasAuthLetter: False,
sealNetWeightMandatory: False,
allowBillableSeals: False,
captureSerialNumber: False,
batchCodesMandatory: False,
captureManufactureAndExpiryDate: False,
productExceptions:
[
{
region: String,
channel: String,
productId: 0,
stockStatusIds:
[
0
]
}
],
usesOwnSealNumbers: False
},
description: String,
heading: String,
wasSuccessful: False,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}