| POST | /upliftrequest |
|---|
import Foundation
import ServiceStack
public class SaveUpliftRequest : ApiServiceRequest
{
public var upliftRequest:UpliftRequestData?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftRequest
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftRequest = try container.decodeIfPresent(UpliftRequestData.self, forKey: .upliftRequest)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftRequest != nil { try container.encode(upliftRequest, forKey: .upliftRequest) }
}
}
public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public var apiKey:String?
/**
* Latitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public var latitude:Double?
/**
* Longitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public var longitude:Double?
required public init(){}
}
public class UpliftRequestData : Codable
{
public var upliftRequestId:Int?
public var id:String?
public var outletId:Int?
public var products:[UpliftRequestProductData] = []
public var outletEmailAddress:String?
public var outletContactName:String?
public var outletChannel:String?
public var outletRegion:String?
public var additionalNotes:String?
//merchandiserSignatureImage:Object ignored. Type could not be extended in Swift
public var startTime:String?
public var startLatitude:Double?
public var startLongitude:Double?
public var endTime:String?
public var endLatitude:Double?
public var endLongitude:Double?
public var lastUpdated:Date?
public var lastSynced:Date?
public var incompleteUpliftRequestId:String?
public var authRequestId:String?
public var authorised:Bool?
public var principalId:Int?
public var seals:[SealData] = []
public var confirmed:Bool?
public var cancelled:Bool?
public var images:[Object] = []
public var submitImmediately:Bool?
required public init(){}
}
public class UpliftRequestProductData : Codable
{
public var id:String?
public var upliftRequestProductId:Int?
public var productId:Int?
public var principalId:Int?
public var unitPrice:Double?
public var name:String?
public var category:String?
public var unitBarcode:String?
public var unitSize:String?
public var unitWeight:Double?
public var code:String?
public var images:[Object] = []
public var quantity:Double?
public var value:Double?
public var productionDate:String?
public var expiryDate:String?
public var batchCode:String?
public var seal:SealData?
public var serialNumber:String?
public var stockStatusId:Int?
public var principalLogoUrl:String?
public var principalName:String?
public var stockStatusName:String?
public var stockStatusColor:String?
public var unitOfMeasureId:Int?
required public init(){}
}
public class SealData : Seal
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class Seal : Codable
{
public var number:String?
public var weight:Double?
required public init(){}
}
public class SaveUpliftRequestResponse : ApiServiceResponse
{
public var upliftRequestProductIds:[Int] = []
public var authRequestId:String?
public var upliftRequestId:Int?
public var deleteFromDevice:Bool?
public var imageIds:[String] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftRequestProductIds
case authRequestId
case upliftRequestId
case deleteFromDevice
case imageIds
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftRequestProductIds = try container.decodeIfPresent([Int].self, forKey: .upliftRequestProductIds) ?? []
authRequestId = try container.decodeIfPresent(String.self, forKey: .authRequestId)
upliftRequestId = try container.decodeIfPresent(Int.self, forKey: .upliftRequestId)
deleteFromDevice = try container.decodeIfPresent(Bool.self, forKey: .deleteFromDevice)
imageIds = try container.decodeIfPresent([String].self, forKey: .imageIds) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftRequestProductIds.count > 0 { try container.encode(upliftRequestProductIds, forKey: .upliftRequestProductIds) }
if authRequestId != nil { try container.encode(authRequestId, forKey: .authRequestId) }
if upliftRequestId != nil { try container.encode(upliftRequestId, forKey: .upliftRequestId) }
if deleteFromDevice != nil { try container.encode(deleteFromDevice, forKey: .deleteFromDevice) }
if imageIds.count > 0 { try container.encode(imageIds, forKey: .imageIds) }
}
}
public class ApiServiceResponse : IServiceResponse, Codable
{
/**
* Information about the response.
*/
// @ApiMember(Description="Information about the response.", IsRequired=true)
public var Description:String?
/**
* Heading or summary of the response.
*/
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public var heading:String?
/**
* Did the intended operation for this response complete successfully?
*/
// @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
public var wasSuccessful:Bool?
public var responseStatus:ResponseStatus?
required public init(){}
}
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 HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SaveUpliftRequest 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>
<UpliftRequest>
<AdditionalNotes>String</AdditionalNotes>
<AuthRequestId>00000000-0000-0000-0000-000000000000</AuthRequestId>
<Authorised>false</Authorised>
<Cancelled>false</Cancelled>
<Confirmed>false</Confirmed>
<EndLatitude>0</EndLatitude>
<EndLongitude>0</EndLongitude>
<EndTime>String</EndTime>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Images xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:anyType />
</Images>
<IncompleteUpliftRequestId>String</IncompleteUpliftRequestId>
<LastSynced>0001-01-01T00:00:00</LastSynced>
<LastUpdated>0001-01-01T00:00:00</LastUpdated>
<MerchandiserSignatureImage />
<OutletChannel>String</OutletChannel>
<OutletContactName>String</OutletContactName>
<OutletEmailAddress>String</OutletEmailAddress>
<OutletId>0</OutletId>
<OutletRegion>String</OutletRegion>
<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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1: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>
<Seals>
<SealData>
<Number xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">String</Number>
<Weight xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">0</Weight>
</SealData>
</Seals>
<StartLatitude>0</StartLatitude>
<StartLongitude>0</StartLongitude>
<StartTime>String</StartTime>
<SubmitImmediately>false</SubmitImmediately>
<UpliftRequestId>0</UpliftRequestId>
</UpliftRequest>
</SaveUpliftRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveUpliftRequestResponse 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>
<AuthRequestId>00000000-0000-0000-0000-000000000000</AuthRequestId>
<DeleteFromDevice>false</DeleteFromDevice>
<ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIds>
<UpliftRequestId>0</UpliftRequestId>
<UpliftRequestProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</UpliftRequestProductIds>
</SaveUpliftRequestResponse>