WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualList

Initial Build

2008.01

xWEB

Web Method

Response Type

XMLNode

This method returns a list of the individuals who are eligible to be registered as part of the group registration. This list will be the registrant's fellow employees.

Note that you can still register people outside of this group in a Group Registration, but this list serves as starting point. Your application could list the people and suggest that the registrant add them to the Group.

See xWeb Event Group Registration for more.

Parameters

  • EventKey (GUID). Event the group registration is for
  • IndividualCustomerKey (GUID). Customer Key of the Individual performing the group registration
  • OrganizationCustomerKey (GUID). Customer Key of the Organization the group of registrants are related to

Response

Xml (XML Node)—A list of the individuals who can be registered for this event. This includes individuals related to the organization provided as well as individuals related to the primary organization for the individual performing the registration. The results include the individual's name, key, city, state, and country.

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:WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualList>
<ns:EventKey>2b4fb750-8065-4577-987b-e43d4cd3151a</ns:EventKey>
<ns:IndividualCustomerKey>21f1093b-fd6a-4d7f-9dc2-86cdacce3171</ns:IndividualCustomerKey>
<ns:OrganizationCustomerKey>43a577de-8660-4f1f-be8b-413658c11bac</ns:OrganizationCustomerKey>
</ns:WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualList>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

There will be one <Result> for each customer in the list.

<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>fe0153e9-4e52-4f59-872f-e2a2572ed00b</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualListResponse xmlns="http://www.avectra.com/2005/">
<WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualListResult>
<Results recordReturn="104">
<Result>
<cst_key>cf6a9bb4-04ce-4747-8a68-f1b55e1e6cef</cst_key>
<cst_sort_name_dn>Corleone Michael</cst_sort_name_dn>
<adr_city>Lake Tahoe</adr_city>
<adr_state>CA</adr_state>
<adr_country>UNITED STATES</adr_country>
</Result>
<Result>
<cst_key>ed010cf4-f132-40b5-ac08-ab0a1350b3c9</cst_key>
<cst_sort_name_dn>Lavransdatter Kirsten</cst_sort_name_dn>
<adr_city>Sil</adr_city>
<adr_state>Gudbrandsdal</adr_state>
<adr_country>NORWAY</adr_country>
</Result>
<Result>
<cst_key>038da729-cb12-45eb-8963-bf668745ddda</cst_key>
<cst_sort_name_dn>Jones Jeff</cst_sort_name_dn>
<adr_city>Falls Chruch</adr_city>
<adr_state>VA</adr_state>
<adr_country>UNITED STATES</adr_country>
</Result>
</Results>
</WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualListResult>
</WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualListResponse>
</soap:Body>
</soap:Envelope>
   

JSON Method

POST /xWeb/JSON/WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualList

  • Get a list of all customers related to the organization (OrganizationCustomerKey) or related to any org that the individual (IndividualCustomerKey; note that this is the same as a customer key cst_key) is part of that are not already registered for the event (EventKey).

  • Note: that an empty key (00000000-0000-0000-0000-000000000000) can be used for either the OrganizationCustomerKey or the IndividualCustomerKey if only one or the other is needed for the call.

 

GET /xweb/JSON/WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualList?EventKey=C73A3AA5-42D4-4CC5-ADFD-E61107EEE074&IndividualCustomerKey=FA800F66-FEF3-4CB5-AE6B-00A91CA6DDD3&OrganizationCustomerKey=00000000-0000-0000-0000-000000000000

POST /xweb/JSON/WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualList

Copy
DATA: JSON
{
    "WEBCentralizedShoppingCartGetEventRegistrantGroupIndividualList": {
        "EventKey": "C73A3AA5-42D4-4CC5-ADFD-E61107EEE074",
        "IndividualCustomerKey": "FA800F66-FEF3-4CB5-AE6B-00A91CA6DDD3",
        "OrganizationCustomerKey": "00000000-0000-0000-0000-000000000000"
    }
}

 

Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "Results": {
        "@recordReturn": "13",
        "Result": [
            {
                "cst_key": "50959c6f-591f-465a-b1ae-657f37a2dfd7",
                "cst_sort_name_dn": "Beepat Marsha",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "9f6752b9-2bac-453c-92f1-e7d6d91b23d2",
                "cst_sort_name_dn": "Costa Irene E.",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "daab4ddf-3a3c-490c-8b51-2bad08105887",
                "cst_sort_name_dn": "Gil Auret M.",
                "adr_city": "Ft Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "55f3db71-6d6e-4e07-a5e8-73fd253fa48a",
                "cst_sort_name_dn": "Innocent David",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "35950658-0a8d-4f93-aae8-1c7d6f3c06d3",
                "cst_sort_name_dn": "Kent Sandra",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "fa800f66-fef3-4cb5-ae6b-00a91ca6ddd3",
                "cst_sort_name_dn": "Mohammed Haleema",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "944d50a5-4289-4902-8d1d-83dfc82a1759",
                "cst_sort_name_dn": "Oyefesobi Staci",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "d7dcb58c-d3ac-444b-87dc-b212d7b884dd",
                "cst_sort_name_dn": "Rodriguez Cristiane Z.",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "0f89f6ee-0d6c-4253-a5bd-79dafb7c46e6",
                "cst_sort_name_dn": "Samlalsingh Surendra",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "4ad024f7-ac89-48a7-b22c-bb70b1a13478",
                "cst_sort_name_dn": "Scalf Bethaney",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "f2267559-a813-42d7-bddb-b54cfa4dfadd",
                "cst_sort_name_dn": "Spaide Jason L.",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "8ca3cf27-b61b-4514-ac47-5f983df7b9f7",
                "cst_sort_name_dn": "Walker Michael",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            },
            {
                "cst_key": "e1da5bc8-d8f0-4863-a0a8-72beadf94d3d",
                "cst_sort_name_dn": "Warlen Neesa",
                "adr_city": "Fort Lauderdale",
                "adr_state": "FL",
                "adr_country": "UNITED STATES"
            }
        ]
    }
}