HostedSuite

<back to all web services

ListServicesRequest

Retrieve list of services

The following routes are available for this service:
POST/api/services
ListServicesRequest Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNoFilter the list of services by name.
CenterIdbodystringNoFilter services by center ID
ParentServiceIdbodystringNoFilter services by parent service ID
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password

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 /api/services HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListServicesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <CustomerName>String</CustomerName>
  <Password>String</Password>
  <UserName>String</UserName>
  <CenterId>String</CenterId>
  <Name>String</Name>
  <ParentServiceId>String</ParentServiceId>
</ListServicesRequest>

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

<ArrayOfServiceInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <ServiceInfo>
    <CenterId>String</CenterId>
    <Id>String</Id>
    <Name>String</Name>
    <ParentServiceId>String</ParentServiceId>
  </ServiceInfo>
</ArrayOfServiceInfo>