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

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 virtual int Category { get; set; }

        public virtual string LogEntry { get; set; }
        public virtual string Browser { get; set; }
        public virtual Guid PerspectiveSessionId { get; set; }
    }

    [ApiResponse(Description="Returns the log reference id and response status")]
    public partial class AddLogResponse
    {
        public virtual Guid LogId { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}