| GET | /principal/get |
|---|
namespace WebService.AppApi.Models
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 PrincipalPrefix:String = null 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 UnitOfMeasureId: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 StockStatusData() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val PhotoRequired:Boolean = new Boolean() with get,set
member val BatchCodeMandatory:Boolean = new Boolean() with get,set
member val Color:String = null 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 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 HasLogo:Boolean = new Boolean() with get,set
member val AllowProductLookup:Boolean = new Boolean() with get,set
member val CaptureSerialNumber:Boolean = new Boolean() with get,set
member val ShowProductionDate:Boolean = new Boolean() with get,set
member val ShowExpiryDate:Boolean = new Boolean() with get,set
member val ShowBatchCode:Boolean = new Boolean() with get,set
member val SealNumberPerProduct:Boolean = new Boolean() with get,set
member val AllowedProductStockStatuses:ResizeArray<StockStatusData> = new ResizeArray<StockStatusData>() with get,set
member val Enabled:Boolean = new Boolean() with get,set
member val ShowSealNumber:Boolean = new Boolean() with get,set
member val ShowSealWeight:Boolean = new Boolean() with get,set
member val ConsolidationEnabled: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: returnit-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Data:
{
PrincipalId: 0,
Name: String,
LogoImageUrl: String,
Products:
[
{
UnitBarcode: String,
Products:
[
{
ProductId: 0,
PrincipalId: 0,
PrincipalPrefix: String,
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,
UnitOfMeasureId: 0
}
]
}
],
UpliftPrefix: String,
ContactName: String,
ContactNumber: String,
ContactEmail: String,
HasLogo: False,
AllowProductLookup: False,
CaptureSerialNumber: False,
ShowProductionDate: False,
ShowExpiryDate: False,
ShowBatchCode: False,
SealNumberPerProduct: False,
AllowedProductStockStatuses:
[
{
Id: 0,
Name: String,
PhotoRequired: False,
BatchCodeMandatory: False,
Color: String
}
],
Enabled: False,
ShowSealNumber: False,
ShowSealWeight: False,
ConsolidationEnabled: 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
}
}
}