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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Returns the log reference id and response status")>]
    [<AllowNullLiteral>]
    type AddLogResponse() = 
        member val LogId:Guid = new Guid() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Add a log entry to the logging database
    ///</summary>
    [<Api(Description="Add a log entry to the logging database")>]
    [<AllowNullLiteral>]
    type AddLog() = 
        ///<summary>
        ///Log Category - Information = 1, Warning = 2, AppError = 3
        ///</summary>
        [<ApiMember(Description="Log Category - Information = 1, Warning = 2, AppError = 3")>]
        member val Category:Int32 = new Int32() with get,set

        member val LogEntry:String = null with get,set
        member val Browser:String = null with get,set
        member val PerspectiveSessionId:Guid = new Guid() with get,set

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

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

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}