<back to all web services

GetService

The following routes are available for this service:
GET/RestApi/apiservice/services/{Route}/{UrlName}

export class GetService
{
    public UrlName: string;
    public Route: string;

    public constructor(init?: Partial<GetService>) { (Object as any).assign(this, init); }
}

export class PropertiesProxy
{
    public Name: string;
    public PropertyType: string;
    public IsPersistent: boolean;
    public AllowSort: boolean;
    public AllowFilter: boolean;
    public IsKey: boolean;

    public constructor(init?: Partial<PropertiesProxy>) { (Object as any).assign(this, init); }
}

export class ContentsProxy
{
    public Name: string;
    public ReadOnly: boolean;
    public UrlKey: string;
    public ClrType: string;
    public Access: string;
    public Properties: PropertiesProxy[];
    public Children: ContentsProxy[];
    public AutogenerateProperties: boolean;
    public parentId: string;

    public constructor(init?: Partial<ContentsProxy>) { (Object as any).assign(this, init); }
}

export class ServicesProxy
{
    public Name: string;
    public Route: string;
    public UrlName: string;
    public Enabled: boolean;
    public Access: string;
    public ApiKey: string;
    public AccessControlAllowOrigin: string;
    public AutogenerateTypes: boolean;
    public Types: ContentsProxy[];
    public Protocol: string;
    public ErrorMessage: string;

    public constructor(init?: Partial<ServicesProxy>) { (Object as any).assign(this, init); }
}

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

GET /RestApi/apiservice/services/{Route}/{UrlName} HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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"
}