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

// @ApiResponse(Description="Returns the log reference id and response status")
export class AddLogResponse
{
    public LogId: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<AddLogResponse>) { (Object as any).assign(this, init); }
}

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

    public LogEntry: string;
    public Browser: string;
    public PerspectiveSessionId: string;

    public constructor(init?: Partial<AddLog>) { (Object as any).assign(this, init); }
}

TypeScript AddLog DTOs

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

HTTP + CSV

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

{"Category":0,"LogEntry":"String","Browser":"String","PerspectiveSessionId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}