Platform API

AddLog

Add a log entry to the logging database

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ApiResponse(Description="Returns the log reference id and response status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddLogResponse:
    log_id: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Add a log entry to the logging database")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddLog:
    """
    Add a log entry to the logging database
    """

    # @ApiMember(Description="Log Category - Information = 1, Warning = 2, AppError = 3")
    category: int = 0
    """
    Log Category - Information = 1, Warning = 2, AppError = 3
    """


    log_entry: Optional[str] = None
    browser: Optional[str] = None
    perspective_session_id: Optional[str] = None

Python AddLog DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	Category: 0,
	LogEntry: String,
	Browser: String
}

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}