Platform API

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AddLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Browser>String</Browser>
  <Category>0</Category>
  <LogEntry>String</LogEntry>
  <PerspectiveSessionId>00000000-0000-0000-0000-000000000000</PerspectiveSessionId>
</AddLog>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddLogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <LogId>00000000-0000-0000-0000-000000000000</LogId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AddLogResponse>