| POST | /uplift/finalise |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
namespace WebService.ServiceModel
{
public partial class FinaliseUplift
: ApiServiceRequest
{
public virtual int UpliftId { get; set; }
public virtual Guid IncompleteUpliftId { get; set; }
}
public partial class SaveUpliftResponse
: ApiServiceResponse
{
public SaveUpliftResponse()
{
Seals = new List<UpliftSealData>{};
Claims = new List<UpliftClaimData>{};
ImageIds = new List<string>{};
}
public virtual int UpliftId { get; set; }
public virtual Guid UpliftAuthRequestId { get; set; }
public virtual List<UpliftSealData> Seals { get; set; }
public virtual UpliftSealData UnbaggedItems { get; set; }
public virtual List<UpliftClaimData> Claims { get; set; }
public virtual bool DeleteFromDevice { get; set; }
public virtual List<string> ImageIds { get; set; }
public virtual bool InvalidAntelSeal { get; set; }
}
public partial class UpliftClaimData
{
public UpliftClaimData()
{
ClaimDocumentImages = new List<Object>{};
}
public virtual int UpliftClaimId { get; set; }
public virtual int ClaimUnits { get; set; }
public virtual string ClaimNumber { get; set; }
public virtual decimal ClaimValue { get; set; }
public virtual List<Object> ClaimDocumentImages { get; set; }
public virtual string ReturnOrderNumber { get; set; }
public virtual int LineCount { get; set; }
}
public partial class UpliftProductData
{
public UpliftProductData()
{
UpliftImages = new List<Object>{};
}
public virtual int UpliftProductId { get; set; }
public virtual int UpliftId { get; set; }
public virtual int ProductId { 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> UpliftImages { get; set; }
public virtual double Quantity { get; set; }
public virtual decimal Value { get; set; }
public virtual bool PriceOverMax { get; set; }
public virtual bool QuantityOverMax { get; set; }
public virtual bool QuantityOverRequirement { get; set; }
public virtual string SerialNumber { get; set; }
public virtual string BatchCode { get; set; }
public virtual int StockStatusId { get; set; }
public virtual string LotNumber { get; set; }
public virtual string ExpiryDate { get; set; }
public virtual string ManufactureDate { get; set; }
}
public partial class UpliftSealData
{
public UpliftSealData()
{
Products = new List<UpliftProductData>{};
}
public virtual bool Unbagged { get; set; }
public virtual string SealNumber { get; set; }
public virtual string AntelSealNumber { get; set; }
public virtual List<UpliftProductData> Products { get; set; }
public virtual double TotalPrice { get; set; }
public virtual double TotalQuantity { get; set; }
public virtual double NetWeight { get; set; }
public virtual double GrossWeight { get; set; }
public virtual bool BillableSeal { get; set; }
public virtual bool InvalidAntelSealNumber { get; set; }
}
}
namespace WebService.ServiceModel.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; }
}
}
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 /uplift/finalise HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
upliftId: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
upliftId: 0,
seals:
[
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
}
],
unbaggedItems:
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
},
claims:
[
{
upliftClaimId: 0,
claimUnits: 0,
claimNumber: String,
claimValue: 0,
claimDocumentImages:
[
{
}
],
returnOrderNumber: String,
lineCount: 0
}
],
deleteFromDevice: False,
imageIds:
[
String
],
invalidAntelSeal: 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
}
}
}