Antel Merchandiser App API

<back to all web services

AppLogError

import Foundation
import ServiceStack

public class AppLogError : ApiServiceRequest
{
    public var stackTrack:String?
    public var message:String?
    public var raw:String?
    public var extra:ExtraErrorData?

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

    private enum CodingKeys : String, CodingKey {
        case stackTrack
        case message
        case raw
        case extra
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        stackTrack = try container.decodeIfPresent(String.self, forKey: .stackTrack)
        message = try container.decodeIfPresent(String.self, forKey: .message)
        raw = try container.decodeIfPresent(String.self, forKey: .raw)
        extra = try container.decodeIfPresent(ExtraErrorData.self, forKey: .extra)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if stackTrack != nil { try container.encode(stackTrack, forKey: .stackTrack) }
        if message != nil { try container.encode(message, forKey: .message) }
        if raw != nil { try container.encode(raw, forKey: .raw) }
        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 ExtraErrorData : Codable
{
    public var appUserId: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 AppLogError DTOs

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

{
	StackTrack: String,
	Message: String,
	Raw: String,
	Extra: 
	{
		AppUserId: 0
	},
	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
		}
	}
}