Antel API

<back to all web services

FinishSubmitCompletedUplifts

import Foundation
import ServiceStack

public class FinishSubmitCompletedUplifts : ApiServiceRequest
{
    public var success:Int
    public var failed:[UpliftSubmissionResult] = []
    public var remaining:Int
    public var extra:String

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

    private enum CodingKeys : String, CodingKey {
        case success
        case failed
        case remaining
        case extra
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        success = try container.decodeIfPresent(Int.self, forKey: .success)
        failed = try container.decodeIfPresent([UpliftSubmissionResult].self, forKey: .failed) ?? []
        remaining = try container.decodeIfPresent(Int.self, forKey: .remaining)
        extra = try container.decodeIfPresent(String.self, forKey: .extra)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if success != nil { try container.encode(success, forKey: .success) }
        if failed.count > 0 { try container.encode(failed, forKey: .failed) }
        if remaining != nil { try container.encode(remaining, forKey: .remaining) }
        if extra != nil { try container.encode(extra, forKey: .extra) }
    }
}

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 UpliftSubmissionResult : Codable
{
    public var wasSuccessful:Bool
    public var Description:String
    public var step:String
    public var upliftId:Int

    required public init(){}
}

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 FinishSubmitCompletedUplifts DTOs

POST /sync/finishsubmit HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	success: 0,
	failed: 
	[
		{
			wasSuccessful: False,
			description: String,
			step: String,
			upliftId: 0
		}
	],
	remaining: 0,
	extra: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

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

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