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

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

<ServicesProxy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Web.Api.Web.Services.Dto.Responses">
  <Access>String</Access>
  <AccessControlAllowOrigin>String</AccessControlAllowOrigin>
  <ApiKey>String</ApiKey>
  <AutogenerateTypes>false</AutogenerateTypes>
  <Enabled>false</Enabled>
  <ErrorMessage>String</ErrorMessage>
  <Name>String</Name>
  <Protocol>String</Protocol>
  <Route>String</Route>
  <Types i:nil="true" />
  <UrlName>String</UrlName>
</ServicesProxy>