Platform API

AddLog

Add a log entry to the logging database

The following routes are available for this service:
POST	/api/logs

import Foundation
import ServiceStack

/**
* Add a log entry to the logging database
*/
// @Api(Description="Add a log entry to the logging database")
public class AddLog : Codable
{
    /**
    * Log Category - Information = 1, Warning = 2, AppError = 3
    */
    // @ApiMember(Description="Log Category - Information = 1, Warning = 2, AppError = 3")
    public var category:Int

    public var logEntry:String
    public var browser:String
    public var perspectiveSessionId:String

    required public init(){}
}

// @ApiResponse(Description="Returns the log reference id and response status")
public class AddLogResponse : Codable
{
    public var logId:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift AddLog 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 /api/logs HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Category":0,"LogEntry":"String","Browser":"String","PerspectiveSessionId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"LogId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}