﻿.NET Scaffold Client and Task Force API Interface Libraries
===========================================================

This ZIP archive that contained the file you're currently reading was generated on-the-fly from Task Force's own binaries cache. Therefore, it is guaranteed to be up to date and compatible with the instance of Task Force from whence it was retrieved, WHEN it was retrieved. As the instance of Task Force is upgraded or enhanced, you may need to obtain newer copies of client libraries to use new features. You may do so in the future via the same means you retrieved this copy.

DISCLAIMER: These libaries are provided "as is", with no warranty of any kind. Please refer to the Task Force Terms of Use for further details:

http://www.epiforge.com/TaskForce/TermsOfUse.aspx

----------------------
FULL API DOCUMENTATION
----------------------

For more details on the services available, the purposes of their methods, and the meanings of their parameters and return values, please refer to the Task Force API documentation found at this URL:

http://taskforce.epiforge.com/API

If the corresponding XML file for a given library binary is present, Microsoft Visual Studio and similarly-aware tools will provide extended Intellisense documentation.

----------------------------------
TASK FORCE API INTERFACE LIBRARIES
----------------------------------

Each Task Force API service has an interface library. The interface library contains all of the methods of the service and their parameters, but does not contain any logic. Interface libaries are used by the Scaffold Service Client to determine the necessary request and response formats to be used with the API service.

---------------------------------
USING THE SCAFFOLD SERVICE CLIENT
---------------------------------

In order to actually call a method in a Task Force API service, you can use the Scaffold Service Client class combined with the interface of the service in question. For details on all the various invocation options available, refer to Visual Studio's Object Explorer and look up the ServiceClient class in the Scaffold.Client.dll assembly.

Here is an example of how to call the GetVersion method of the Task Force API's Instance service:

[C#]
var instance = new Scaffold.Client.ServiceClient<Gorgo.Client.IInstance>("https://taskforce.epiforge.com/API/Instance.aspx");
var version = instance.Invoke(svc => svc.GetVersion());
Console.WriteLine(string.Format("Version {0}.{1} Build {2}", version.Major, version.Minor, version.Build));

[VB]
Dim instance = New Scaffold.Client.ServiceClient(Of Gorgo.Client.IInstance)("https://taskforce.epiforge.com/API/Instance.aspx")
Dim version = instance.Invoke(Function(svc) svc.GetVersion())
Console.WriteLine(String.Format("Version {0}.{1} Build {2}", version.Major, version.Minor, version.Build))