| 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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<AppLogError xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
<Extra>
<AppUserId>0</AppUserId>
</Extra>
<ExtraData>String</ExtraData>
<Message>String</Message>
<Request>String</Request>
<Response>String</Response>
<StackTrack>String</StackTrack>
</AppLogError>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
<Description>String</Description>
<Heading>String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>