WEBCommitteeGetPositionList

 

WEBCommitteeGetPositionList

Initial Build 2008.01
xWeb Web Method
Response Type XML results

The WEBCommitteeGetPositionList web method returns a list of Committee Positions for a specific committee as identified by the key provided.

Parameters

The request contains the following required parameter:

Name Type Occurs Description
CommitteeKey guid 1..1 The committee key.

 

Response

XML Results. A list of the positions configured for the committee including the position key and code.

Name Description Datatype
cop_key Committee Position Key string (in guid format)
cpo_code Committee Position Code string

 

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:WEBCommitteeGetPositionList>
<ns:CommitteeKey>4B0D5203-6840-401B-8B1F-A239C80D42D0</ns:CommitteeKey>
</ns:WEBCommitteeGetPositionList>
</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>4eef498a-86fd-459f-b9c5-32ae5482a22c</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBCommitteeGetPositionListResponse xmlns="http://www.avectra.com/2005/">
<WEBCommitteeGetPositionListResult>
<Results recordReturn="7">
<Result>
<cop_key>a504b2a1-fc30-407a-820f-18cdeab0a289</cop_key>
<cpo_code>President</cpo_code>
</Result>
<Result>
<cop_key>c589596f-b575-4a42-a5f8-7d0b387cb2d7</cop_key>
<cpo_code>Officer</cpo_code>
</Result>
<Result>
<cop_key>f8d09415-642b-4ec3-aca4-83eb08d9e2c3</cop_key>
<cpo_code>Secretary</cpo_code>
</Result>
<Result>
<cop_key>831f1ed5-142a-498a-8c7c-9938906934bf</cop_key>
<cpo_code>VP</cpo_code>
</Result>
<Result>
<cop_key>e99d3e60-57cc-4c86-83b9-a12d4e174407</cop_key>
<cpo_code>CFO</cpo_code>
</Result>
<Result>
<cop_key>12f16f74-92be-4b0d-b919-bb6ee4c66079</cop_key>
<cpo_code>CEO</cpo_code>
</Result>
<Result>
<cop_key>b8a31017-5419-4200-acf0-eaead6350931</cop_key>
<cpo_code>Staff</cpo_code>
</Result>
</Results>
</WEBCommitteeGetPositionListResult>
</WEBCommitteeGetPositionListResponse>
</soap:Body>
</soap:Envelope>

 

JSON Method

POST /xWeb/JSON/WEBCommitteeGetPositionList

DATA: JSON
{
    "WEBCommitteeGetPositionList": {
        "CommitteeKey": "{{cmtKeyCommittee}}"
    }
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "Results": {
        "@recordReturn": "6",
        "Result": [
            {
                "cop_key": "b37be7f1-dd9e-426c-b7dc-fecd71cac1c2",
                "cpo_code": "eb0b0be251f40ef0"
            },
            {
                "cop_key": "9afa5b6b-ebfc-4752-87be-abdfdc005ad6",
                "cpo_code": "Recorder/Secretary"
            },
            {
                "cop_key": "f5cf3ef6-00de-45a7-ba1b-26b0efa5c72e",
                "cpo_code": "Chairperson"
            },
            {
                "cop_key": "f40943d3-d1af-4288-bb90-53abba5d4703",
                "cpo_code": "Pravin Test"
            },
            {
                "cop_key": "4e7345e8-6f66-48bf-a405-9f6258a218b3",
                "cpo_code": "Sub-committee Leader"
            },
            {
                "cop_key": "d3770528-b6b2-4d85-a337-5d23a3352b74",
                "cpo_code": "Senior"
            }
        ]
    }
}

 

Related Functionality

Committee Position

Recommendations

This data 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.

Was this article helpful?
0 out of 0 found this helpful