| POST | /upliftrequest/auth |
|---|
namespace BusinessLogic.Entities
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 UpliftRequestAuthRequestResponse() =
inherit ApiServiceResponse()
member val UpliftRequestAuthRequestId:Guid = new Guid() 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 Seal() =
member val Number:String = null with get,set
member val Weight:Double = new Double() with get,set
[<AllowNullLiteral>]
type SealData() =
inherit Seal()
[<AllowNullLiteral>]
type UpliftRequestProductData() =
member val Id:Guid = new Guid() with get,set
member val UpliftRequestProductId:Int32 = new Int32() with get,set
member val ProductId:Int32 = new Int32() with get,set
member val PrincipalId:Int32 = new Int32() with get,set
member val UnitPrice:Decimal = new Decimal() with get,set
member val Name:String = null with get,set
member val Category:String = null with get,set
member val UnitBarcode:String = null with get,set
member val UnitSize:String = null with get,set
member val UnitWeight:Decimal = new Decimal() with get,set
member val Code:String = null with get,set
member val Images:ResizeArray<Object> = new ResizeArray<Object>() with get,set
member val Quantity:Double = new Double() with get,set
member val Value:Decimal = new Decimal() with get,set
member val ProductionDate:String = null with get,set
member val ExpiryDate:String = null with get,set
member val BatchCode:String = null with get,set
member val Seal:SealData = null with get,set
member val SerialNumber:String = null with get,set
member val StockStatusId:Int32 = new Int32() with get,set
member val PrincipalLogoUrl:String = null with get,set
member val PrincipalName:String = null with get,set
member val StockStatusName:String = null with get,set
member val StockStatusColor:String = null with get,set
member val UnitOfMeasureId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type UpliftRequestAuthRequest() =
inherit ApiServiceRequest()
member val UpliftRequestOnDeviceId:Guid = new Guid() with get,set
member val OutletId:Int32 = new Int32() with get,set
member val PrincipalId:Int32 = new Int32() with get,set
member val TotalValue:Decimal = new Decimal() with get,set
member val TotalUnits:Double = new Double() with get,set
member val Region:String = null with get,set
member val Channel:String = null with get,set
member val Products:ResizeArray<UpliftRequestProductData> = new ResizeArray<UpliftRequestProductData>() with get,set
F# UpliftRequestAuthRequest 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.
POST /upliftrequest/auth HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpliftRequestAuthRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Longitude>
<Channel>String</Channel>
<OutletId>0</OutletId>
<PrincipalId>0</PrincipalId>
<Products>
<UpliftRequestProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
</Images>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<PrincipalLogoUrl>String</PrincipalLogoUrl>
<PrincipalName>String</PrincipalName>
<ProductId>0</ProductId>
<ProductionDate>String</ProductionDate>
<Quantity>0</Quantity>
<Seal>
<Number xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">String</Number>
<Weight xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">0</Weight>
</Seal>
<SerialNumber>String</SerialNumber>
<StockStatusColor>String</StockStatusColor>
<StockStatusId>0</StockStatusId>
<StockStatusName>String</StockStatusName>
<UnitBarcode>String</UnitBarcode>
<UnitOfMeasureId>0</UnitOfMeasureId>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftRequestProductId>0</UpliftRequestProductId>
<Value>0</Value>
</UpliftRequestProductData>
</Products>
<Region>String</Region>
<TotalUnits>0</TotalUnits>
<TotalValue>0</TotalValue>
<UpliftRequestOnDeviceId>00000000-0000-0000-0000-000000000000</UpliftRequestOnDeviceId>
</UpliftRequestAuthRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpliftRequestAuthRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
<Description xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">false</WasSuccessful>
<UpliftRequestAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftRequestAuthRequestId>
</UpliftRequestAuthRequestResponse>