WEBChaptersGetChapterByKey

Initial Build	2008.01
xWeb	Web Method
Response Type	XML results

This method returns information about a specific chapter as identified by the key provided.

Parameters

The request has the following required parameter:

Name	Type	Occurs	Description
ChapterKey	guid	1..1	Key of the chapter about which information is being requested.

Response

XML Results. Information about the chapter requested, including the chapter code, name, description, website, charter date, and chapter type.

Name	Description	Datatype	Notes
chp_cst_key	Chapter Customer Key	string (in guid format)	Customer Key of the Chapter itself. In netFORUM, a Chapter is also a Customer.
chp_code	Chapter Code	string
chp_name	Chapter Name	string
chp_description	Chapter Description	string
chp_chapter_number	Chapter Number	string
chp_website	Chapter Website	string	URL of Chapter Website, if any.
chp_charter_date	Charter Date	string (in DateTime format)	Date the Chapter was chartered (founded) in dateTime format.
asn_code	Association Code	string	Association code.
cht_code	Chapter Type Code	string	Chapter Type
chs_code	Chapter Status Code	string	Chapter Status (typically Active, Inactive, etc., but can vary for each netFORUM client).

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>45612cab-4806-402a-b136-52625c47f751</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBChaptersGetChapterByKey xmlns="http://www.avectra.com/2005/">
<ChapterKey>13f6c616-949e-42cb-af31-8c671fe475e5</ChapterKey>
</WEBChaptersGetChapterByKey>
</soap:Body>
</soap:Envelope>

Sample Response

<?xml version="1.0" encoding="utf-16"?>
<Results recordReturn="1" xmlns="http://www.avectra.com/2005/">
<Result>
<chp_cst_key>13f6c616-949e-42cb-af31-8c671fe475e5</chp_cst_key>
<chp_code>NATW_MD</chp_code>
<chp_name>Maryland State Chapter</chp_name>
<chp_description />
<chp_chapter_number />
<chp_website />
<chp_charter_date />
<asn_code>NATW</asn_code>
<cht_code>State</cht_code>
<chs_code />
</Result>
</Results>

JSON Method

POST /xWeb/JSON/WEBChaptersGetChapterByKey

DATA: JSON
{
    "WEBChaptersGetChapterByKey": {
        "ChapterKey": "{{chpCstKeyChapter}}"
    }
}

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
            }
        ]
    }
}

Related Web Methods

WEBChapterGet - similar to this web method, but returns significantly more data.

Related Functionality

Chapter.

Recommendations

Information about chapters rarely changes. Therefore we recommend you cache these results and get a new list on a regular interval, especially in a high-traffic application that calls this method frequently.