Antel Merchandiser App API

<back to all web services

SaveUpliftRequestImage

import Foundation
import ServiceStack

public class SaveUpliftRequestImage : ApiServiceRequest
{
    public var type:UpliftRequestImageType?
    public var upliftRequestId:Int?
    public var stockStatusId:Int?
    public var imageIds:[String] = []

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

    private enum CodingKeys : String, CodingKey {
        case type
        case upliftRequestId
        case stockStatusId
        case imageIds
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        type = try container.decodeIfPresent(UpliftRequestImageType.self, forKey: .type)
        upliftRequestId = try container.decodeIfPresent(Int.self, forKey: .upliftRequestId)
        stockStatusId = try container.decodeIfPresent(Int.self, forKey: .stockStatusId)
        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 type != nil { try container.encode(type, forKey: .type) }
        if upliftRequestId != nil { try container.encode(upliftRequestId, forKey: .upliftRequestId) }
        if stockStatusId != nil { try container.encode(stockStatusId, forKey: .stockStatusId) }
        if imageIds.count > 0 { try container.encode(imageIds, forKey: .imageIds) }
    }
}

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

// @Flags()
public enum UpliftRequestImageType : Int, Codable
{
    case MerchandiserSignature = 0
    case Product = 1
    case General = 2
}

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

POST /upliftrequest/image HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Type: 0,
	UpliftRequestId: 0,
	StockStatusId: 0,
	ImageIds: 
	[
		00000000-0000-0000-0000-000000000000
	],
	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
		}
	}
}