WEBCentralizedShoppingCartGiftGetGiftProductList
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
XML results |
This method returns a list of gift products which are currently configured for sale online.
In order to appear in the list, the Fund must have a default campaign and the Fund Fee and Price(s) must be marked to show online.
In the response, the value of the <prc_key> element is the critical value that will be passed into other web methods as a parameter. The <prc_price> is the default donation amount, although in most Fundraising applications the interface will prompt the donor to enter a particular donation amount. There might be several suggested amounts ($25, $50, $100, etc.) with an other amount where the user may enter their own amount. Whatever the ultimate donation amount is, you will pass that value in the Fee.overrideamount property in the FeeCollection that you pass in one of the other Fundraising web methods.
Be aware that in many netFORUM systems, the <prc_price> may actually be 0.00 because the expectation is that every donation amount can be different and that the amount is entered at the time the gift is entered.
Parameters
This method does not accept any parameters.
Response
Xml (XML Node). A list of gift products, including the price, code, description, name, and product type.
Sample Request
<?xml version="1.0" encoding="utf-8"?>
<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 soap:actor="5d66ef8b-55a5-4f34-848c-ee519d0a9f1f" xmlns="http://www.avectra.com/2005/">
<Token>32b276bb-6a5b-47c6-abca-7839756e745d</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBCentralizedShoppingCartGiftGetGiftProductList xmlns="http://www.avectra.com/2005/" />
</soap:Body>
</soap:Envelope>
Sample Response
<?xml version="1.0" encoding="utf-16"?>
<Results recordReturn="3" xmlns="http://www.avectra.com/2005/">
<Result>
<prc_key>52005483-a6c1-4fe8-bc14-a7678d0ca2f2</prc_key>
<prc_price>5</prc_price>
<prd_key>a1f40972-7029-4be9-99b2-5dc7156177d9</prd_key>
<prd_code>Spring Product</prd_code>
<prd_description />
<Name>Spring Product-Spring Product/Spring Camp</Name>
<ptp_code>Fundraising</ptp_code>
</Result>
<Result>
<prc_key>1ae4f8c8-c594-4c79-ab25-448d2f6f18c4</prc_key>
<prc_price>200</prc_price>
<prd_key>ccd6cca0-1766-4803-964b-792ca8d75c3d</prd_key>
<prd_code>2009 Fund</prd_code>
<prd_description>desc</prd_description>
<Name>2009 Fundraising-2009 Fund/2009 Campaing</Name>
<ptp_code>Fundraising</ptp_code>
</Result>
<Result>
<prc_key>f2dcc358-f42e-4e92-b0e8-5e5ec650b3a7</prc_key>
<prc_price>300</prc_price>
<prd_key>ccd6cca0-1766-4803-964b-792ca8d75c3d</prd_key>
<prd_code>2009 Fund</prd_code>
<prd_description>desc</prd_description>
<Name>2009 Fundraising-2009 Fund/2009 Campaing</Name>
<ptp_code>Fundraising</ptp_code>
</Result>
</Results>
JSON Method
POST /xWeb/JSON/WEBCentralizedShoppingCartGiftGetGiftProductList
DATA: JSON
{
"WEBCentralizedShoppingCartGiftGetGiftProductList": null
}
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Results": {
"@recordReturn": "7",
"Result": [
{
"prc_key": "1ad58674-f563-42bf-842f-0de1b77bb595",
"prc_price": "50.0000",
"prd_key": "a02ecc6b-476c-4011-ab82-3733ab344b39",
"prd_code": "AbilaFund1_abila_bu1",
"prd_description": "AbilaFund1_abila_bu1",
"Name": "AbilaFund1_abila_bu1-AbilaFund1_abila_bu1/Abila Campaign1",
"ptp_code": "Fundraising"
},
{
"prc_key": "95855003-b99f-4bfd-ac71-24901eb47ec1",
"prc_price": "0.0000",
"prd_key": "a02ecc6b-476c-4011-ab82-3733ab344b39",
"prd_code": "AbilaFund1_abila_bu1",
"prd_description": "AbilaFund1_abila_bu1",
"Name": "AbilaFund1_abila_bu1-AbilaFund1_abila_bu1/Abila Campaign1",
"ptp_code": "Fundraising"
},
{
"prc_key": "a850fffc-c28b-40b4-9ec3-731158987df6",
"prc_price": "25.0000",
"prd_key": "a02ecc6b-476c-4011-ab82-3733ab344b39",
"prd_code": "AbilaFund1_abila_bu1",
"prd_description": "AbilaFund1_abila_bu1",
"Name": "AbilaFund1_abila_bu1-AbilaFund1_abila_bu1/Abila Campaign1",
"ptp_code": "Fundraising"
},
{
"prc_key": "ee0835fa-900b-4aa6-9eb5-cc1ae5f4bde2",
"prc_price": "50.0000",
"prd_key": "a02ecc6b-476c-4011-ab82-3733ab344b39",
"prd_code": "AbilaFund1_abila_bu1",
"prd_description": "AbilaFund1_abila_bu1",
"Name": "AbilaFund1_abila_bu1-AbilaFund1_abila_bu1/Abila Campaign1",
"ptp_code": "Fundraising"
},
{
"prc_key": "a427007d-abac-4d4f-9f63-cc3330e13f2a",
"prc_price": "0.0000",
"prd_key": "a02ecc6b-476c-4011-ab82-3733ab344b39",
"prd_code": "AbilaFund1_abila_bu1",
"prd_description": "AbilaFund1_abila_bu1",
"Name": "AbilaFund1_abila_bu1-AbilaFund1_abila_bu1/Abila Campaign1",
"ptp_code": "Fundraising"
},
{
"prc_key": "cb24250e-0a49-46ea-a958-d809c0a49cd0",
"prc_price": "100.0000",
"prd_key": "a02ecc6b-476c-4011-ab82-3733ab344b39",
"prd_code": "AbilaFund1_abila_bu1",
"prd_description": "AbilaFund1_abila_bu1",
"Name": "AbilaFund1_abila_bu1-AbilaFund1_abila_bu1/Abila Campaign1",
"ptp_code": "Fundraising"
},
{
"prc_key": "cd7b4280-336f-40df-9577-ecc5134a3226",
"prc_price": "100.0000",
"prd_key": "a02ecc6b-476c-4011-ab82-3733ab344b39",
"prd_code": "AbilaFund1_abila_bu1",
"prd_description": "AbilaFund1_abila_bu1",
"Name": "AbilaFund1_abila_bu1-AbilaFund1_abila_bu1/Abila Campaign1",
"ptp_code": "Fundraising"
}
]
}
}