MicroApp API

<back to all web services

GetCurrentMicroAppRequest

The following routes are available for this service:
All Verbs/current/{Key}/{TenantKey}
"use strict";
export class GetCurrentMicroAppRequest {
    /** @param {{key?:string,tenantKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    key;
    /** @type {string} */
    tenantKey;
}
export class MicroApp {
    /** @param {{id?:number,name?:string,key?:string,version?:number,current?:boolean,production?:boolean,manifestUrl?:string,url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    key;
    /** @type {number} */
    version;
    /** @type {boolean} */
    current;
    /** @type {boolean} */
    production;
    /** @type {string} */
    manifestUrl;
    /** @type {string} */
    url;
}

JavaScript GetCurrentMicroAppRequest 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 /current/{Key}/{TenantKey} HTTP/1.1 
Host: apps.harbourassist.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCurrentMicroAppRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarbourAssist.Api.MicroApp.Dtos.Requests">
  <Key>String</Key>
  <TenantKey>String</TenantKey>
</GetCurrentMicroAppRequest>

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

<MicroApp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarbourAssist.Api.MicroApp.Domain">
  <Current>false</Current>
  <Id>0</Id>
  <Key>String</Key>
  <Name>String</Name>
  <Production>false</Production>
  <Url>String</Url>
  <Version>0</Version>
</MicroApp>