| POST | /upliftrequest/auth |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.AppApi.Models;
using WebService.AppApi.Models.Base;
using BusinessLogic.Entities;
namespace BusinessLogic.Entities
{
public partial class Seal
{
public virtual string Number { get; set; }
public virtual double Weight { get; set; }
}
}
namespace WebService.AppApi.Models
{
public partial class SealData
: Seal
{
}
public partial class UpliftRequestAuthRequest
: ApiServiceRequest
{
public UpliftRequestAuthRequest()
{
Products = new List<UpliftRequestProductData>{};
}
public virtual Guid UpliftRequestOnDeviceId { get; set; }
public virtual int OutletId { get; set; }
public virtual int PrincipalId { get; set; }
public virtual decimal TotalValue { get; set; }
public virtual double TotalUnits { get; set; }
public virtual string Region { get; set; }
public virtual string Channel { get; set; }
public virtual List<UpliftRequestProductData> Products { get; set; }
}
public partial class UpliftRequestAuthRequestResponse
: ApiServiceResponse
{
public virtual Guid UpliftRequestAuthRequestId { get; set; }
}
public partial class UpliftRequestProductData
{
public UpliftRequestProductData()
{
Images = new List<Object>{};
}
public virtual Guid Id { get; set; }
public virtual int UpliftRequestProductId { get; set; }
public virtual int ProductId { get; set; }
public virtual int PrincipalId { get; set; }
public virtual decimal UnitPrice { get; set; }
public virtual string Name { get; set; }
public virtual string Category { get; set; }
public virtual string UnitBarcode { get; set; }
public virtual string UnitSize { get; set; }
public virtual decimal UnitWeight { get; set; }
public virtual string Code { get; set; }
public virtual List<Object> Images { get; set; }
public virtual double Quantity { get; set; }
public virtual decimal Value { get; set; }
public virtual string ProductionDate { get; set; }
public virtual string ExpiryDate { get; set; }
public virtual string BatchCode { get; set; }
public virtual SealData Seal { get; set; }
public virtual string SerialNumber { get; set; }
public virtual int StockStatusId { get; set; }
public virtual string PrincipalLogoUrl { get; set; }
public virtual string PrincipalName { get; set; }
public virtual string StockStatusName { get; set; }
public virtual string StockStatusColor { get; set; }
public virtual int UnitOfMeasureId { get; set; }
}
}
namespace WebService.AppApi.Models.Base
{
public partial class ApiServiceRequest
: IServiceRequest, IHasApiKey, IHasDeviceInfo
{
///<summary>
///The API Key required for authentication
///</summary>
[ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
public virtual string ApiKey { get; set; }
///<summary>
///Latitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Latitude of the user making this request")]
public virtual double Latitude { get; set; }
///<summary>
///Longitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Longitude of the user making this request")]
public virtual double Longitude { get; set; }
}
public partial class ApiServiceResponse
: IServiceResponse
{
///<summary>
///Information about the response.
///</summary>
[ApiMember(Description="Information about the response.", IsRequired=true)]
public virtual string Description { get; set; }
///<summary>
///Heading or summary of the response.
///</summary>
[ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
public virtual string Heading { 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)]
public virtual bool WasSuccessful { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
C# 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>