How to use ScrumWorks API with .NET?

Edit Subject

Here is a solution for all of you which use C#:

Set Up
=====================
Add a web reference to your project. When asked for a Url, enter http://yourserver:8080/scrumworks-api... to find the service. By default it doesn't create the correct properties in you solution, so please check the following settings:
(I can not provide the correct xml, because it wouldn't show in the reply. So please look for similar expressions in those files.)

-> in *Service.wsdl:
"soap:address location="http://yourserver:8080/scrumworks-api..."

-> in web.config:
add key="ScrumWorksWebReference.ScrumWorksService" value="http://yourserver:8080/scrumworks-api..."

Now the service is set up and ready to use. If you find yourself having problems to establish a connection like described in the next steps, it will most likely be because of a HTTP error 505 (HTTP version not supported). There is a workaround for this. You can find it on http://geekswithblogs.net/scarpenter/...

Establish connection
=====================
private ScrumWorksService connectToService(string user, string password)
{
NetworkCredential credentials = new NetworkCredential(user, password);
ScrumWorksService service = new ScrumWorksService();

service.Credentials = credentials;
service.PreAuthenticate = true;

// Test connection with web service
try
{
getTest getTestMethod = new getTest();
service.getTest(getTestMethod);
}
catch (Exception ex)
{
Label1.Text = string.Format("Error: Connection failed ({0})", ex.Message);
}
return service;
}

Get data
=====================
To get all products use this code:
private ProductWSO[] getProductsArray(ScrumWorksService service)
{
getProducts getProductsMethod = new getProducts();
return service.getProducts(getProductsMethod);
}

To get all sprints of a product, use this code:
private SprintWSO[] getSprintArray(ScrumWorksService service, ProductWSO product)
{
getSprints getSprintsMethod = new getSprints();
getSprintsMethod.ProductWSO_1 = product;
return service.getSprints(getSprintsMethod);
}

It is similar for all data.

Update data
=====================
If you want to change data, e.g. the title of a story (backlog item), you have to submit your changes:
private void setStoryTitle(ScrumWorksService service, BacklogItemWSO backlogItem, string title)
{
backlogItem.title = title;

updateBacklogItem updateBacklogItem = new updateBacklogItem();
updateBacklogItem.BacklogItemWSO_1 = backlogItem;
service.updateBacklogItem(updateBacklogItem);
}

I know that this could be more efficient, but it works for now. I wanted to show how I was able to get data from the WSO objects. I hope this will help people using this API.

(Note: This is in a .DLL file)

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using ScrumWorks.scrumpro;
using System.Net;
using System.Collections;

namespace AM_APP
{
public class ScrumWorks
{
ScrumWorksService service = new ScrumWorksService();
ProductWSO product = new ProductWSO();
SprintWSO sprint = new SprintWSO();
BacklogItemWSO backlog = new BacklogItemWSO();

public Boolean SWauthorization(string userName, string password)
{
NetworkCredential credentials = new NetworkCredential(userName, password);

service.Credentials = credentials;
service.PreAuthenticate = true;

getAuthenticatedTest testAuth = new getAuthenticatedTest();

try
{
service.getAuthenticatedTest(testAuth);
return true;
}
catch
{
return false;
}
}

///
/// Gets array of products
///
/// Array of products
public ArrayList SWproducts()
{
getProducts getProductsMethod = new getProducts();
ProductWSO[] productArray = new ProductWSO[1];
ArrayList returnList = new ArrayList();
productArray = (ProductWSO[])service.getProducts(getProductsMethod);

for (int x = 0; x < productArray.Length; x++)
{
product = productArray[x];
returnList.Add(product.name);
}

return returnList;
}

///
/// Sets product
///
/// Selected product name
public void SWselectedProduct(string productName)
{
getProducts getProductsMethod = new getProducts();
ProductWSO[] productArray = new ProductWSO[0];
ArrayList returnList = new ArrayList();
productArray = (ProductWSO[])service.getProducts(getProductsMethod);

for (int x = 0; x < productArray.Length; x++)
{
product = productArray[x];
if (product.name == productName)
{
break;
}
}
}

public ArrayList SWreleases()
{
return null;
}

///
/// Gets array of sprints
///
/// Array of sprints
public ArrayList SWsprints()
{

getSprints getSprintsMethod = new getSprints();
SprintWSO[] sprintArray = new SprintWSO[0];
ArrayList returnList = new ArrayList();
getSprintsMethod.ProductWSO_1 = product;
sprintArray = (SprintWSO[])service.getSprints(getSprintsMethod);

for (int x = 0; x < sprintArray.Length; x++)
{
sprint = sprintArray[x];
returnList.Add(sprint.name);
}

return returnList;
}

///
/// Sets sprint
///
/// Selected sprint name
public void SWselectedSprint(string sprintName)
{
getSprints getSprintsMethod = new getSprints();
SprintWSO[] sprintArray = new SprintWSO[0];
ArrayList returnList = new ArrayList();
getSprintsMethod.ProductWSO_1 = product;
sprintArray = (SprintWSO[])service.getSprints(getSprintsMethod);

for (int x = 0; x < sprintArray.Length; x++)
{
sprint = sprintArray[x];
if (sprint.name == sprintName)
{
break;
}
}
}

///
/// Gets array of backlogs in sprint
///
/// Array of backlogs in sprint
public ArrayList SWbacklog()
{
getActiveBacklogItemsForSprint getBacklogItemMethod = new getActiveBacklogItemsForSprint();
BacklogItemWSO[] backlogArray = new BacklogItemWSO[0];
ArrayList returnList = new ArrayList();
getBacklogItemMethod.SprintWSO_1 = sprint;
backlogArray = (BacklogItemWSO[])service.getActiveBacklogItemsForSprint(getBacklogItemMethod);

for (int x = 0; x < backlogArray.Length; x++)
{
backlog = backlogArray[x];
returnList.Add(backlog.title);
}

return returnList;
}

///
/// Sets backlog
///
/// Selected backlog
public void SWselectedBacklog(string backlogName)
{
getActiveBacklogItemsForSprint getBacklogItemMethod = new getActiveBacklogItemsForSprint();
BacklogItemWSO[] backlogArray = new BacklogItemWSO[0];
ArrayList returnList = new ArrayList();
getBacklogItemMethod.SprintWSO_1 = sprint;
backlogArray = (BacklogItemWSO[])service.getActiveBacklogItemsForSprint(getBacklogItemMethod);

for (int x = 0; x < backlogArray.Length; x++)
{
backlog = backlogArray[x];
if(backlogName == backlog.title)
{
break;
}
}
}

///
/// Returns description of selected backlog item
///
/// Backlog description as string
public string SWbacklogDescription()
{
return backlog.description;
}

}
}