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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Add a log entry to the logging database
        '''</Summary>
        <Api(Description:="Add a log entry to the logging database")>
        Public Partial Class AddLog
            '''<Summary>
            '''Log Category - Information = 1, Warning = 2, AppError = 3
            '''</Summary>
            <ApiMember(Description:="Log Category - Information = 1, Warning = 2, AppError = 3")>
            Public Overridable Property Category As Integer

            Public Overridable Property LogEntry As String
            Public Overridable Property Browser As String
            Public Overridable Property PerspectiveSessionId As Guid
        End Class

        <ApiResponse(Description:="Returns the log reference id and response status")>
        Public Partial Class AddLogResponse
            Public Overridable Property LogId As Guid
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}