WEBCentralizedShoppingCartGiftGetGiftProductListByName
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
XML results |
This method returns a list of gift products available for sale online, filtered by the gift name value passed in. The method will search for the Fund Name and Fund Code of the Fund. The value of <prc_key> is used later on to set parameter values for other methods.
See WEBCentralizedShoppingCartGiftGetGiftProductList for more on the return values of this method.
Parameters
GiftName (String). The results will be only included gifts with this value in the name.
Response
Xml (XML Node). A list of gifts where the name of the gift includes the gift name value passed. The list will include the price, code, name, description, and product type.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>*******************</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBCentralizedShoppingCartGiftGetGiftProductListByName>
<ns:GiftName>ABC</ns:GiftName>
</ns:WEBCentralizedShoppingCartGiftGetGiftProductListByName>
</soapenv:Body>
</soapenv:Envelope>
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>******************</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBCentralizedShoppingCartGiftGetGiftProductListByNameResponse xmlns="http://www.avectra.com/2005/">
<WEBCentralizedShoppingCartGiftGetGiftProductListByNameResult>
<Results recordReturn="2">
<Result>
<prc_key>40eb9ce2-4d81-433c-ae7b-0ed5f07e5ebe</prc_key>
<prc_price>101</prc_price>
<prd_key>99476384-3d99-414a-b9dd-01480e657e10</prd_key>
<prd_code>ABCGF</prd_code>
<prd_description>The longer description of the Fund</prd_description>
<Name>ABC General Fund-ABCGF/ABC Capital Campaign</Name>
<ptp_code>Fundraising</ptp_code>
</Result>
<Result>
<prc_key>ded1e569-4a91-4b5d-ba79-effb9f48dee1</prc_key>
<prc_price>50</prc_price>
<prd_key>99476384-3d99-414a-b9dd-01480e657e10</prd_key>
<prd_code>ABCGF</prd_code>
<prd_description>The longer description of the Fund</prd_description>
<Name>ABCGeneral Fund-ABCGF/ABC Capital Campaign</Name>
<ptp_code>Fundraising</ptp_code>
</Result>
</Results>
</WEBCentralizedShoppingCartGiftGetGiftProductListByNameResult>
</WEBCentralizedShoppingCartGiftGetGiftProductListByNameResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/WEBCentralizedShoppingCartGiftGetGiftProductListByName
Copy
DATA: JSON
{
"WEBCentralizedShoppingCartGiftGetGiftProductListByName": {
"GiftName":"{{prdCodeGiftSearchByName}}"
}
}
Copy
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"
}
]
}
}