Platform API

<back to all web services

AddLog

Add a log entry to the logging database

The following routes are available for this service:
POST/api/logs
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    open var LogEntry:String? = null
    open var Browser:String? = null
    open var PerspectiveSessionId:UUID? = null
}

@ApiResponse(Description="Returns the log reference id and response status")
open class AddLogResponse
{
    open var LogId:UUID? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin AddLog DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Category":0,"LogEntry":"String","Browser":"String","PerspectiveSessionId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}