Platform API

AddLog

Add a log entry to the logging database

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

"use strict";
export class AddLogResponse {
    /** @param {{LogId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LogId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class AddLog {
    /** @param {{Category?:number,LogEntry?:string,Browser?:string,PerspectiveSessionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Log Category - Information = 1, Warning = 2, AppError = 3 */
    Category;
    /** @type {string} */
    LogEntry;
    /** @type {string} */
    Browser;
    /** @type {string} */
    PerspectiveSessionId;
}

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