developer:soap-1.6:methods:getproductcategory

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:methods:getproductcategory [2012/08/04 11:18] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​
  
 +====== getProductCategory ======
 +
 +Retrieve all data for a single product category
 +
 +===== Description =====
 +
 +This method retrieves the [[..:​objects:​ProductCategory]] object for the product category specified by ProductCateogryRefNum. ​ The ProductCategoryRefNum is the gateway assigned unique product category identifier that was returned by [[addProductCategory].  ​
 +
 +The entire [[..:​objects:​ProductCategory]] object is returned.
 +
 +See also [[addProductCategory]]
 +
 +===== Syntax =====
 +
 +[[..:​objects:​ProductCategory]] **getProductCategory** ( [[..:​objects:​ueSecurityToken]] Token,​string ProductCategoryRefNum)
 +
 +===== Arguments =====
 +
 +^Type   ​^Name ​  ​^Description ​  ^
 +|[[..:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and retrieve the custom fields.|
 +|string |ProductCategoryRefNum |Gateway assigned product category ID used to pull product category details|
 +
 +===== Return Value =====
 +
 +|[[..:​objects:​ProductCategory]] |Returns a Product Category object containing fields and their values. |
 +
 +===== Exceptions =====
 +
 +The following exceptions (errors) are applicable to this method. ​
 +
 +^Code ^Message ​ ^Advice ​ ^
 +|41006 |Product Category Not Found  |Product category specified by ProductCategoryRefNum was not found. ​ Make sure the number stored is not truncated or rounded. |
 +
 +===== Examples =====
 +
 +
 +==== PHP ====
 +
 +For directions on how to set up the WSDL link, create "​$token"​ and "​$client",​ go to [[..:​howto:​php|PHP Soap How-to]].
 +
 +<code php>
 +<?​php ​
 +
 +
 +</​code>​
 +
 +==== VB ====
 +
 +<code vb>
 +    Dim catRefNum As String
 +        catRefNum = "​9001169812"​
 +
 +        Dim category As usaepay.ProductCategory
 +        category = client.getProductCategory(token,​ catRefNum)
 +        MsgBox(category.Name)
 +</​code>​
 +
 +
 +==== .NET C# ====
 +<code c>
 +            string catRefNum = "​900116985";​
 +            ​
 +            try
 +            {
 +                usaepay.ProductCategory category = client.getProductCategory(token,​ catRefNum);
 +                MessageBox.Show(string.Concat(category.Name));​
 +            }
 +            catch (Exception err)
 +            {
 +                MessageBox.Show(err.Message);​
 +            }
 +</​code>​
 +
 +==== XML ====
 +Request:
 +<code xml>
 +</​code>​
 +
 +Response:
 +<code xml>
 +</​code>​
 +
 +
 +===== Change History =====
 +
 +^Version ^Change ^
 +|[[developer:​soap-1.3:​methods:​getproductcategory|1.3]] | Method added in this release |
developer/soap-1.6/methods/getproductcategory.txt ยท Last modified: 2012/08/04 11:18 by tem

Page Tools