WEBCentralizedShoppingCartGiftGetGiftTypeList
Initial Build |
2008.01 |
xWEB |
Web Method |
Response Type |
XML results |
This method returns a list of Gift Types which are available in netFORUM. The <gty_key> can be used to set the value of <Gift.gft_gty_key> in the Gift Object before you add the Gift to the Shopping Cart Object.
Be aware that there are special business rules around each of these Gift Types. For general donations, use the value of the Donations Gift Type. Once this value is set in netFORUM, it likely will never change, so rather than calling this method repeatedly, call it once in testing mode, get the value of the Donations Gift Type Key, and configure that value in a constant/variable.
Important! Don't use the same values you see in the sample XML below in your application. These values can be different for each organization using netFORUM.
Parameters
This method does not accept any parameters.
Response
Xml (XML Node). A list of the gift types including the gift type key and code.
Sample Request
<<SAMPLE REQUEST>>
Sample Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>a2a0b250-8f4f-4434-a3d9-f48747e0bf0a</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBCentralizedShoppingCartGiftGetGiftTypeListResponse xmlns="http://www.avectra.com/2005/">
<WEBCentralizedShoppingCartGiftGetGiftTypeListResult>
<Results recordReturn="7">
<Result>
<gty_key>AAAAA-cfcb-4977-85ff-29eaba0aeb2e</gty_key>
<gty_type>Donations</gty_type>
</Result>
<Result>
<gty_key>BBBBBB-dcbe-4ac2-8027-2bd5b577e9e8</gty_key>
<gty_type>Stock</gty_type>
</Result>
<Result>
<gty_key>CCCCC-9bf0-48ad-908c-35d2f54bcd79</gty_key>
<gty_type>Pledge Payment</gty_type>
</Result>
<Result>
<gty_key>DDDDD-0f16-4ef7-a694-39e3cb3d3e9b</gty_key>
<gty_type>Sponsor</gty_type>
</Result>
<Result>
<gty_key>EEEEEE-ba02-4647-99fd-b003fd5b5039</gty_key>
<gty_type>Matching Gift</gty_type>
</Result>
</Results>
</WEBCentralizedShoppingCartGiftGetGiftTypeListResult>
</WEBCentralizedShoppingCartGiftGetGiftTypeListResponse>
</soap:Body>
</soap:Envelope>