Domains: List Domains

• authorizationHashed authorization key
• appkeyYour application’s key

• wfspidThe project id

• wfspstartstarting record requested (zero-based)
• wfsplimit# of records requested

• MessageIf the response is successful then the “message” parameter of the response will be “Success” and if there is some error or failure then the “message” parameter will be the error message.
• ProjectIDProject ID
• Domain: DomainIDThe Identifier for the domain
• Domain: DomainNameThe domain string
• TotalRecordsTotal number of records
• PageStartstarting record requested (zero-based)
• PageLimit# of records requested

PHP

<?php

require_once('Services_WFS.php');

$services = new Services_WFS;

$apiKey = '[Your API Key]';
$publicKey = '[Your Public Key]';
$privateKey = '[Your Private Key]';
$services->setCredentials($publicKey, $privateKey, $apiKey);

$my_project_name = '[project name]';
$projectKey = $services->getProjectKeyByName($my_project_name);
$services->setProjectKey($projectKey);

$result = $services->listDomains();
var_dump($result);


?>       

C#

  private string GetDomainList(string projectId, int pageStart, int pageLimit)
  {

    const string method = "GET";
    string requestUri = "/rest/" + Format + "/Domains/" + 
                                              "?wfspid=" + projectId + 
                                              "&wfspstart=" + pageStart + 
                                              "&wfsplimit=" + pageLimit;

    //See common functions for GetResponse
    return GetResponse(method, requestUri);

  }

VB.NET

  Private Function GetDomainList(ByVal projectId As String, ByVal pageStart As Integer, ByVal pageLimit As Integer) As String

    Const method As String = "GET"
    Dim requestUri As String = "/rest/" & Format & "/Domains/" & _
                               "?wfspid=" & projectId & _
                               "&wfspstart=" & pageStart & _
                               "&wfsplimit=" & pageLimit

    'See common functions for GetResponse
    Return GetResponse(method, requestUri)

  End Function

xml Response

<Domains>
  <ProjectID>7bff9927-7964-4f6f-a132-adcae35ad51f</ProjectID>
  <Message>Success</Message>
  <Domain>
    <DomainID>748f683b-822a-4212-95bf-597e3e8549db</DomainID>
    <DomainName>*.domain.com</DomainName>
  </Domain>
  <TotalRecords>1</TotalRecords>
  <PageStart>0</PageStart>
  <PageLimit>10</PageLimit>
</Domains>

json Response

{
   "Domains":{
      "Domain":{
         "DomainID":"748f683b-822a-4212-95bf-597e3e8549db",
         "DomainName":"*.domain.com"
      },
      "Message":"Success",
      "PageLimit":"10",
      "PageStart":"0",
      "ProjectID":"7bff9927-7964-4f6f-a132-adcae35ad51f",
      "TotalRecords":"1"
   }
}