Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestList

import Foundation
import ServiceStack

public class IncompleteUpliftRequestList : ApiServiceRequest
{
    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 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 IncompleteUpliftRequestListResponse : ApiServiceResponse
{
    public var incompleteUpliftRequests:[IncompleteUpliftRequestData] = []
    public var allowLogin:Bool?
    public var assignedOutlets:[OutletData] = []
    public var archived:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case incompleteUpliftRequests
        case allowLogin
        case assignedOutlets
        case archived
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        incompleteUpliftRequests = try container.decodeIfPresent([IncompleteUpliftRequestData].self, forKey: .incompleteUpliftRequests) ?? []
        allowLogin = try container.decodeIfPresent(Bool.self, forKey: .allowLogin)
        assignedOutlets = try container.decodeIfPresent([OutletData].self, forKey: .assignedOutlets) ?? []
        archived = try container.decodeIfPresent(Bool.self, forKey: .archived)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if incompleteUpliftRequests.count > 0 { try container.encode(incompleteUpliftRequests, forKey: .incompleteUpliftRequests) }
        if allowLogin != nil { try container.encode(allowLogin, forKey: .allowLogin) }
        if assignedOutlets.count > 0 { try container.encode(assignedOutlets, forKey: .assignedOutlets) }
        if archived != nil { try container.encode(archived, forKey: .archived) }
    }
}

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(){}
}

public class IncompleteUpliftRequestData : Codable
{
    public var systemUserId:Int?
    public var incompleteUpliftRequestId:String?
    public var upliftRequestOnDeviceId:String?
    public var outletId:Int?
    public var lastSynced:Date?
    public var isSubmitted:Bool?
    public var deleteFromDevice:Bool?
    public var createdByMerchandiserName:String?

    required public init(){}
}

public class OutletData : Codable
{
    public var id:Int?
    public var name:String?
    public var lastRequestedDate:String?
    public var hasGeneralUpliftRequest:Bool?
    public var upliftRequestCount:Int?
    public var assignedPrincipalIds:[Int] = []
    public var assignedRegions:[OutletRegionData] = []
    public var channel:String?
    public var nextScheduledDate:String?

    required public init(){}
}

public class OutletRegionData : Codable
{
    public var principalId:Int?
    public var region:String?

    required public init(){}
}

Swift IncompleteUpliftRequestList DTOs

GET /sync/incompleteupliftrequests HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IncompleteUpliftRequests: 
	[
		{
			
		}
	],
	AllowLogin: False,
	AssignedOutlets: 
	[
		{
			
		}
	],
	Archived: 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
		}
	}
}