Antel API

<back to all web services

AppLogError

The following routes are available for this service:
POST/error/log
import Foundation
import ServiceStack

public class AppLogError : ApiServiceRequest
{
    public var stackTrack:String
    public var message:String
    public var request:String
    public var response:String
    public var extraData:String
    public var extra:ExtraErrorData

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

    private enum CodingKeys : String, CodingKey {
        case stackTrack
        case message
        case request
        case response
        case extraData
        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)
        request = try container.decodeIfPresent(String.self, forKey: .request)
        response = try container.decodeIfPresent(String.self, forKey: .response)
        extraData = try container.decodeIfPresent(String.self, forKey: .extraData)
        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 request != nil { try container.encode(request, forKey: .request) }
        if response != nil { try container.encode(response, forKey: .response) }
        if extraData != nil { try container.encode(extraData, forKey: .extraData) }
        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

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

HTTP + OTHER

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

POST /error/log HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"stackTrack":"String","message":"String","request":"String","response":"String","extraData":"String","extra":{"appUserId":0},"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}