<back to all web services

GetService

The following routes are available for this service:
GET/RestApi/apiservice/services/{Route}/{UrlName}
GetService Parameters:
NameParameterData TypeRequiredDescription
UrlNamepathstringNo
RoutepathstringNo
ServicesProxy Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
RouteformstringNo
UrlNameformstringNo
EnabledformboolNo
AccessformstringNo
ApiKeyformstringNo
AccessControlAllowOriginformstringNo
AutogenerateTypesformboolNo
TypesformIEnumerable<ContentsProxy>No
ProtocolformstringNo
ErrorMessageformstringNo
ContentsProxy Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ReadOnlyformboolNo
UrlKeyformstringNo
ClrTypeformstringNo
AccessformstringNo
PropertiesformIEnumerable<PropertiesProxy>No
ChildrenformIEnumerable<ContentsProxy>No
AutogeneratePropertiesformboolNo
parentIdformstringNo
PropertiesProxy Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PropertyTypeformstringNo
IsPersistentformboolNo
AllowSortformboolNo
AllowFilterformboolNo
IsKeyformboolNo

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"
}