BokaMera.API.Host

<back to all web services

CreateError

The following routes are available for this service:
POST/errors/Save error to log
"use strict";
export class ErrorQueryResponse {
    /** @param {{CompanyId?:string,Id?:number,ExceptionName?:string,ExceptionMessage?:string,ExceptionSource?:string,InnerExceptionName?:string,StackTrace?:string,URL?:string,LoggedInUser?:string,Visible?:boolean,IPAddress?:string,CreatedDate?:string,Request?:string,Session?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {string} */
    ExceptionName;
    /** @type {string} */
    ExceptionMessage;
    /** @type {string} */
    ExceptionSource;
    /** @type {string} */
    InnerExceptionName;
    /** @type {string} */
    StackTrace;
    /** @type {string} */
    URL;
    /** @type {string} */
    LoggedInUser;
    /** @type {boolean} */
    Visible;
    /** @type {string} */
    IPAddress;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    Request;
    /** @type {string} */
    Session;
}
export class CreateError {
    /** @param {{CompanyId?:string,ExceptionName?:string,ExceptionMessage?:string,ExceptionSource?:string,InnerExceptionName?:string,StackTrace?:string,URL?:string,LoggedInUser?:string,IPAddress?:string,Request?:string,Session?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /** @type {string} */
    ExceptionName;
    /** @type {string} */
    ExceptionMessage;
    /** @type {string} */
    ExceptionSource;
    /** @type {string} */
    InnerExceptionName;
    /** @type {string} */
    StackTrace;
    /** @type {string} */
    URL;
    /** @type {string} */
    LoggedInUser;
    /** @type {string} */
    IPAddress;
    /** @type {string} */
    Request;
    /** @type {string} */
    Session;
}

JavaScript CreateError 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 /errors/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ExceptionName: String,
	ExceptionMessage: String,
	ExceptionSource: String,
	InnerExceptionName: String,
	StackTrace: String,
	URL: String,
	LoggedInUser: String,
	IPAddress: String,
	Request: String,
	Session: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	ExceptionName: String,
	ExceptionMessage: String,
	ExceptionSource: String,
	InnerExceptionName: String,
	StackTrace: String,
	URL: String,
	LoggedInUser: String,
	Visible: False,
	IPAddress: String,
	Request: String,
	Session: String
}