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.*;

public class dtos
{

    /**
    * Add a log entry to the logging database
    */
    @Api(Description="Add a log entry to the logging database")
    public static class AddLog
    {
        /**
        * Log Category - Information = 1, Warning = 2, AppError = 3
        */
        @ApiMember(Description="Log Category - Information = 1, Warning = 2, AppError = 3")
        public Integer Category = null;

        public String LogEntry = null;
        public String Browser = null;
        public UUID PerspectiveSessionId = null;
        
        public Integer getCategory() { return Category; }
        public AddLog setCategory(Integer value) { this.Category = value; return this; }
        public String getLogEntry() { return LogEntry; }
        public AddLog setLogEntry(String value) { this.LogEntry = value; return this; }
        public String getBrowser() { return Browser; }
        public AddLog setBrowser(String value) { this.Browser = value; return this; }
        public UUID getPerspectiveSessionId() { return PerspectiveSessionId; }
        public AddLog setPerspectiveSessionId(UUID value) { this.PerspectiveSessionId = value; return this; }
    }

    @ApiResponse(Description="Returns the log reference id and response status")
    public static class AddLogResponse
    {
        public UUID LogId = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getLogId() { return LogId; }
        public AddLogResponse setLogId(UUID value) { this.LogId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AddLogResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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
		}
	}
}