<back to all web services

GetService

The following routes are available for this service:
GET/RestApi/apiservice/services/{Route}/{UrlName}
"use strict";
export class GetService {
    /** @param {{UrlName?:string,Route?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UrlName;
    /** @type {string} */
    Route;
}
export class PropertiesProxy {
    /** @param {{Name?:string,PropertyType?:string,IsPersistent?:boolean,AllowSort?:boolean,AllowFilter?:boolean,IsKey?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    PropertyType;
    /** @type {boolean} */
    IsPersistent;
    /** @type {boolean} */
    AllowSort;
    /** @type {boolean} */
    AllowFilter;
    /** @type {boolean} */
    IsKey;
}
export class ContentsProxy {
    /** @param {{Name?:string,ReadOnly?:boolean,UrlKey?:string,ClrType?:string,Access?:string,Properties?:PropertiesProxy[],Children?:ContentsProxy[],AutogenerateProperties?:boolean,parentId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {boolean} */
    ReadOnly;
    /** @type {string} */
    UrlKey;
    /** @type {string} */
    ClrType;
    /** @type {string} */
    Access;
    /** @type {PropertiesProxy[]} */
    Properties;
    /** @type {ContentsProxy[]} */
    Children;
    /** @type {boolean} */
    AutogenerateProperties;
    /** @type {string} */
    parentId;
}
export class ServicesProxy {
    /** @param {{Name?:string,Route?:string,UrlName?:string,Enabled?:boolean,Access?:string,ApiKey?:string,AccessControlAllowOrigin?:string,AutogenerateTypes?:boolean,Types?:ContentsProxy[],Protocol?:string,ErrorMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Route;
    /** @type {string} */
    UrlName;
    /** @type {boolean} */
    Enabled;
    /** @type {string} */
    Access;
    /** @type {string} */
    ApiKey;
    /** @type {string} */
    AccessControlAllowOrigin;
    /** @type {boolean} */
    AutogenerateTypes;
    /** @type {ContentsProxy[]} */
    Types;
    /** @type {string} */
    Protocol;
    /** @type {string} */
    ErrorMessage;
}

JavaScript GetService 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.

GET /RestApi/apiservice/services/{Route}/{UrlName} HTTP/1.1 
Host: www.asg.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Name":"String","Route":"String","UrlName":"String","Enabled":false,"Access":"String","ApiKey":"String","AccessControlAllowOrigin":"String","AutogenerateTypes":false,"Types":null,"Protocol":"String","ErrorMessage":"String"}