WEBChaptersGetChapterListByName
| Initial Build | 2008.01 |
| xWeb | Web Method |
| Response Type | XML results |
This method returns a list of chapters, filtered by the ChapterName search parameter passed in.
Parameters
The request has the following required parameter:
| Name | Type | Occurs | Description |
|---|---|---|---|
| ChapterName | string | 1..1 | The results will only include chapters with this value in the name. |
Response
XML Results Information about the chapter requested, including the chapter code, name, description, website, charter date, and chapter type.
See WEBChaptersGetChapterByKey for more information on each field.
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:WEBChaptersGetChapterListByName>
<ns:ChapterName>AV_Chapter</ns:ChapterName>
</ns:WEBChaptersGetChapterListByName>
</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>254ad25c-7a8b-47d4-a521-9240bb07db23</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBChaptersGetChapterListByNameResponse xmlns="http://www.avectra.com/2005/">
<WEBChaptersGetChapterListByNameResult>
<Results recordReturn="1">
<Result>
<chp_cst_key>b747933c-602c-472b-bc92-e6b096d878bd</chp_cst_key>
<chp_code>AV_Chapter</chp_code>
<chp_name>AV_Chapter</chp_name>
<chp_description/>
<chp_chapter_number/>
<chp_website/>
<chp_charter_date>11/1/2010 12:00:00 AM</chp_charter_date>
<asn_code>AV</asn_code>
<cht_code>RSR - Local Chapter</cht_code>
<chs_code>Active</chs_code>
</Result>
</Results>
</WEBChaptersGetChapterListByNameResult>
</WEBChaptersGetChapterListByNameResponse>
</soap:Body>
</soap:Envelope>JSON Method
POST /xWeb/JSON/WEBChaptersGetChapterListByName
DATA: JSON
{
"WEBChaptersGetChapterListByName": {
"ChapterName": "{{chpNameSnippetChapter}}"
}
}
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Results": {
"@recordReturn": "1",
"Result": [
{
"chp_cst_key": "ed9eff3d-d603-4a0c-965a-c5c1f963347d",
"chp_code": "ABC_CH1",
"chp_name": "ABC Chapter1",
"chp_description": null,
"chp_chapter_number": null,
"chp_website": null,
"chp_charter_date": null,
"asn_code": "ABC Assoc",
"cht_code": "Chapter",
"chs_code": null
}
]
}
}