GetTemplates

Method

GetTemplates(GetTemplatesRequest)

This method can be used to request Velocity template settings.

Declaration

public GetTemplatesResponse GetTemplates(GetTemplatesRequest request)

Parameters

TYPE	NAME	DESCRIPTION
GetTemplatesRequest	request	GetTemplatesCriteriaAll GetTemplatesCriteriaName

Returns

TYPE	DESCRIPTION
GetTemplatesResponse

Example C#

public Template[] GetTemplates_All()
{
	using (RDAAdminWebServiceClient client = new RDAAdminWebServiceClient())
	{
		var request = new GetTemplatesRequest()
		{
			Credentials = GetCredentials(),
			RequestId = NewRequestId(),
			RequestDate = DateTime.Now,
			Criteria = new GetTemplatesCriteriaAll()
		};

		var response = client.GetTemplates(request);
		if (CheckSuccess(response))
		{
			return response.Templates;
		}
		else
		{
			HandleOther(response);
			return new Template[0];
		}
	}
}
public Template[] GetTemplates_Name()
{
	using (RDAAdminWebServiceClient client = new RDAAdminWebServiceClient())
	{
		var request = new GetTemplatesRequest()
		{
			Credentials = GetCredentials(),
			RequestId = NewRequestId(),
			RequestDate = DateTime.Now,
			Criteria = new GetTemplatesCriteriaName()
			{
				TemplateName = "My Template Name"
			}
		};

		var response = client.GetTemplates(request);
		if (CheckSuccess(response))
		{
			return response.Templates;
		}
		else
		{
			HandleOther(response);
			return new Template[0];
		}
	}
}

Example JS

function GetAllTemplates(success, error) {
  var request = new XMLHttpRequest();
  var data = new GetTemplatesRequest();
  var criteria = new GetTemplatesCriteriaAll();

  data.Criteria = criteria;
  data.Credentials = token;

  request.setRequestHeader("Content-type", "application/json; charset=utf-8");
  request.open(
    "POST",
    "http://localhost/mobile/RDAAdminWebService.svc/GetTemplates",
    true
  );
  request.onreadystatechange = function () {
    if (request.readyState === 4) {
      if (request.status !== 200) {
        return error(request.statusText);
      }

      var response = JSON.parse(request.responseText);

      switch (response.Result) {
        case Result.Error:
        case Result.ValidationError:
          return error(response);
        case Result.Success:
        default:
          return success(response.Templates);
      }
    }
  };

  request.send(data);
}

function GetTemplatesByName(name, success, error) {
  var request = new XMLHttpRequest();
  var data = new GetTemplatesRequest();
  var criteria = new GetTemplatesCriteriaName();

  criteria.TemplateName = name;

  data.Criteria = criteria;
  data.Credentials = token;

  request.setRequestHeader("Content-type", "application/json; charset=utf-8");
  request.open(
    "POST",
    "http://localhost/mobile/RDAAdminWebService.svc/GetTemplates",
    true
  );
  request.onreadystatechange = function () {
    if (request.readyState === 4) {
      if (request.status !== 200) {
        return error(request.statusText);
      }

      var response = JSON.parse(request.responseText);

      switch (response.Result) {
        case Result.Error:
        case Result.ValidationError:
          return error(response);
        case Result.Success:
        default:
          return success(response.Templates);
      }
    }
  };

  request.send(data);
}