Antel API

<back to all web services

StartSaveUpliftProductImages

Requires Authentication
The following routes are available for this service:
POST/uplift/product/startimage
import Foundation
import ServiceStack

public class StartSaveUpliftProductImages : ApiServiceRequest
{
    public var type:UpliftImageType
    public var upliftId:Int

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

    private enum CodingKeys : String, CodingKey {
        case type
        case upliftId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        type = try container.decodeIfPresent(UpliftImageType.self, forKey: .type)
        upliftId = try container.decodeIfPresent(Int.self, forKey: .upliftId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if type != nil { try container.encode(type, forKey: .type) }
        if upliftId != nil { try container.encode(upliftId, forKey: .upliftId) }
    }
}

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 enum UpliftImageType : Int, Codable
{
    case ClaimDoc = 0
    case DamagedOk = 1
    case DamagedBad = 2
    case Expired = 3
    case Recall = 4
    case Product = 5
    case OperatorSignature = 6
    case OperatorRegistration = 7
    case OutletSignature = 8
    case GoodStock = 9
    case Deranged = 10
    case Overstocked = 11
    case FactoryFault = 12
    case Status = 13
}

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

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /uplift/product/startimage HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"type":0,"upliftId":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}