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 .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 /errors/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateError xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ExceptionMessage>String</ExceptionMessage>
  <ExceptionName>String</ExceptionName>
  <ExceptionSource>String</ExceptionSource>
  <IPAddress>String</IPAddress>
  <InnerExceptionName>String</InnerExceptionName>
  <LoggedInUser>String</LoggedInUser>
  <Request>String</Request>
  <Session>String</Session>
  <StackTrace>String</StackTrace>
  <URL>String</URL>
</CreateError>

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

<ErrorQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <ExceptionMessage>String</ExceptionMessage>
  <ExceptionName>String</ExceptionName>
  <ExceptionSource>String</ExceptionSource>
  <IPAddress>String</IPAddress>
  <Id>0</Id>
  <InnerExceptionName>String</InnerExceptionName>
  <LoggedInUser>String</LoggedInUser>
  <Request>String</Request>
  <Session>String</Session>
  <StackTrace>String</StackTrace>
  <URL>String</URL>
  <Visible>false</Visible>
</ErrorQueryResponse>