MemoryGivingAPIWebService
Click here for a complete list of operations.
loadTributeGroupById
Please supply the following fields:
Parameter | Type | Mandatory | Default | Description |
api_key | string | Mandatory | Your unique code to access this operation. | |
tribute_group_id | int | Mandatory | Unique ID that identifies each fund page group. |
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /admin/api/WebService.asmx HTTP/1.1 Host: memorygiving.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://memorygiving.com/admin/api/WebService.asmx/loadTributeGroupById" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <loadTributeGroupById xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <api_key>string</api_key> </loadTributeGroupById> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <loadTributeGroupByIdResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <loadTributeGroupByIdResult> <Data> <id>int</id> <page_name>string</page_name> <tributes> <anyType /> <anyType /> </tributes> <remove> <anyType /> <anyType /> </remove> <donations_total>double</donations_total> <donations_online_total>double</donations_online_total> <donations_offline_total>double</donations_offline_total> <gift_aid_total>double</gift_aid_total> <PageURL>string</PageURL> <CurrencyDonationsTotal>string</CurrencyDonationsTotal> <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal> <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal> <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </loadTributeGroupByIdResult> </loadTributeGroupByIdResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /admin/api/WebService.asmx HTTP/1.1 Host: memorygiving.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <loadTributeGroupById xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <api_key>string</api_key> </loadTributeGroupById> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <loadTributeGroupByIdResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <loadTributeGroupByIdResult> <Data> <id>int</id> <page_name>string</page_name> <tributes> <anyType /> <anyType /> </tributes> <remove> <anyType /> <anyType /> </remove> <donations_total>double</donations_total> <donations_online_total>double</donations_online_total> <donations_offline_total>double</donations_offline_total> <gift_aid_total>double</gift_aid_total> <PageURL>string</PageURL> <CurrencyDonationsTotal>string</CurrencyDonationsTotal> <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal> <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal> <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </loadTributeGroupByIdResult> </loadTributeGroupByIdResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /admin/api/WebService.asmx/loadTributeGroupById?api_key=string HTTP/1.1 Host: memorygiving.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ResponseOfTributeGroup xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <Data> <id>int</id> <page_name>string</page_name> <tributes> <anyType /> <anyType /> </tributes> <remove> <anyType /> <anyType /> </remove> <donations_total>double</donations_total> <donations_online_total>double</donations_online_total> <donations_offline_total>double</donations_offline_total> <gift_aid_total>double</gift_aid_total> <PageURL>string</PageURL> <CurrencyDonationsTotal>string</CurrencyDonationsTotal> <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal> <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal> <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </ResponseOfTributeGroup>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /admin/api/WebService.asmx/loadTributeGroupById HTTP/1.1 Host: memorygiving.com Content-Type: application/x-www-form-urlencoded Content-Length: length api_key=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ResponseOfTributeGroup xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <Data> <id>int</id> <page_name>string</page_name> <tributes> <anyType /> <anyType /> </tributes> <remove> <anyType /> <anyType /> </remove> <donations_total>double</donations_total> <donations_online_total>double</donations_online_total> <donations_offline_total>double</donations_offline_total> <gift_aid_total>double</gift_aid_total> <PageURL>string</PageURL> <CurrencyDonationsTotal>string</CurrencyDonationsTotal> <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal> <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal> <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </ResponseOfTributeGroup>