SWS GetSiteAttributes Method
Retrieves a collection of site attribute data. This pertains to the unique site attributes.
Parameters
Name | DataType | Is Required |
---|---|---|
SiteID | Long | Required |
Description | The site’s ID number. This can be found using the GetSiteList method. |
Returned Parameters
Name | DataType |
---|---|
ATT_NAME | String |
Description | The site attribute’s name. |
CREATED_BY | Long |
Description | The Store user’s ID that created the field. |
SITE_ID | Long |
Description | The site’s ID number. |
UPDATED_BY | Long |
Description | The Store user’s ID number that last updated the field. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a GetSiteAttributes request object and a GetSiteAttributes response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetSiteAttributes_Request request = new SWS.GetSiteAttributes_Request();
SWS.GetSiteAttributes_Response response;
Here’s my sample code of the Request object.
// GetSiteAttribute Request
request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to get our site attributes. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.GetSiteAttributes(user_request, request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.