| POST | /sync/saveincompleteuplift |
|---|
import Foundation
import ServiceStack
public class SaveIncompleteUpliftRequest : ApiServiceRequest
{
public var incompleteUpliftRequestId:String?
public var imageIdsOnDevice:[String] = []
public var upliftRequestData:UpliftRequestData?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case incompleteUpliftRequestId
case imageIdsOnDevice
case upliftRequestData
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
incompleteUpliftRequestId = try container.decodeIfPresent(String.self, forKey: .incompleteUpliftRequestId)
imageIdsOnDevice = try container.decodeIfPresent([String].self, forKey: .imageIdsOnDevice) ?? []
upliftRequestData = try container.decodeIfPresent(UpliftRequestData.self, forKey: .upliftRequestData)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if incompleteUpliftRequestId != nil { try container.encode(incompleteUpliftRequestId, forKey: .incompleteUpliftRequestId) }
if imageIdsOnDevice.count > 0 { try container.encode(imageIdsOnDevice, forKey: .imageIdsOnDevice) }
if upliftRequestData != nil { try container.encode(upliftRequestData, forKey: .upliftRequestData) }
}
}
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 SaveIncompleteUpliftRequestResponse : ApiServiceResponse
{
public var imageIds:[String] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case imageIds
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
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 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(){}
}
Swift SaveIncompleteUpliftRequest 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 /sync/saveincompleteuplift HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SaveIncompleteUpliftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<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>
<ImageIdsOnDevice xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIdsOnDevice>
<IncompleteUpliftRequestId>00000000-0000-0000-0000-000000000000</IncompleteUpliftRequestId>
<UpliftRequestData xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
<d2p1:AdditionalNotes>String</d2p1:AdditionalNotes>
<d2p1:AuthRequestId>00000000-0000-0000-0000-000000000000</d2p1:AuthRequestId>
<d2p1:Authorised>false</d2p1:Authorised>
<d2p1:Cancelled>false</d2p1:Cancelled>
<d2p1:Confirmed>false</d2p1:Confirmed>
<d2p1:EndLatitude>0</d2p1:EndLatitude>
<d2p1:EndLongitude>0</d2p1:EndLongitude>
<d2p1:EndTime>String</d2p1:EndTime>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Images xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:anyType />
</d2p1:Images>
<d2p1:IncompleteUpliftRequestId>String</d2p1:IncompleteUpliftRequestId>
<d2p1:LastSynced>0001-01-01T00:00:00</d2p1:LastSynced>
<d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
<d2p1:MerchandiserSignatureImage />
<d2p1:OutletChannel>String</d2p1:OutletChannel>
<d2p1:OutletContactName>String</d2p1:OutletContactName>
<d2p1:OutletEmailAddress>String</d2p1:OutletEmailAddress>
<d2p1:OutletId>0</d2p1:OutletId>
<d2p1:OutletRegion>String</d2p1:OutletRegion>
<d2p1:PrincipalId>0</d2p1:PrincipalId>
<d2p1:Products>
<d2p1:UpliftRequestProductData>
<d2p1:BatchCode>String</d2p1:BatchCode>
<d2p1:Category>String</d2p1:Category>
<d2p1:Code>String</d2p1:Code>
<d2p1:ExpiryDate>String</d2p1:ExpiryDate>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Images xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</d2p1:Images>
<d2p1:Name>String</d2p1:Name>
<d2p1:PrincipalId>0</d2p1:PrincipalId>
<d2p1:PrincipalLogoUrl>String</d2p1:PrincipalLogoUrl>
<d2p1:PrincipalName>String</d2p1:PrincipalName>
<d2p1:ProductId>0</d2p1:ProductId>
<d2p1:ProductionDate>String</d2p1:ProductionDate>
<d2p1:Quantity>0</d2p1:Quantity>
<d2p1: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>
</d2p1:Seal>
<d2p1:SerialNumber>String</d2p1:SerialNumber>
<d2p1:StockStatusColor>String</d2p1:StockStatusColor>
<d2p1:StockStatusId>0</d2p1:StockStatusId>
<d2p1:StockStatusName>String</d2p1:StockStatusName>
<d2p1:UnitBarcode>String</d2p1:UnitBarcode>
<d2p1:UnitOfMeasureId>0</d2p1:UnitOfMeasureId>
<d2p1:UnitPrice>0</d2p1:UnitPrice>
<d2p1:UnitSize>String</d2p1:UnitSize>
<d2p1:UnitWeight>0</d2p1:UnitWeight>
<d2p1:UpliftRequestProductId>0</d2p1:UpliftRequestProductId>
<d2p1:Value>0</d2p1:Value>
</d2p1:UpliftRequestProductData>
</d2p1:Products>
<d2p1:Seals>
<d2p1: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>
</d2p1:SealData>
</d2p1:Seals>
<d2p1:StartLatitude>0</d2p1:StartLatitude>
<d2p1:StartLongitude>0</d2p1:StartLongitude>
<d2p1:StartTime>String</d2p1:StartTime>
<d2p1:SubmitImmediately>false</d2p1:SubmitImmediately>
<d2p1:UpliftRequestId>0</d2p1:UpliftRequestId>
</UpliftRequestData>
</SaveIncompleteUpliftRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveIncompleteUpliftRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<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>
<ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIds>
</SaveIncompleteUpliftRequestResponse>