WEBIndividualGetPrefixes

Initial Build

2008.01

xWEB

Web Method

Response Type

XML results

The WEBIndividualGetPrefixes web method returns a list of prefixes that can be used to populate a drop-down list of prefixes when adding or updating individual records.

Parameters

This web method does not have any parameters.

Response

XML Results

Name Description Datatype
prf_key Prefix Key string (in guid format)
prf_code Prefix Code string

Note: The list of prefixes 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. See Data Caching for more information.

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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualGetPrefixes/>
</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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBIndividualGetPrefixesResponse xmlns="http://www.avectra.com/2005/">
<WEBIndividualGetPrefixesResult>
<Results recordReturn="3">
<Result>
<prf_key>c929a98a-beee-40fd-93f3-880e483e8b33</prf_key>
<prf_code>Mr</prf_code>
</Result>
<Result>
<prf_key>388dd495-d24d-4830-a246-6b7002c0b3c5</prf_key>
<prf_code>Mrs</prf_code>
</Result>
<Result>
<prf_key>3fc0789c-1071-4e30-ae25-f81312f838b2</prf_key>
<prf_code>Dr</prf_code>
</Result>
</Results>
</WEBIndividualGetPrefixesResult>
</WEBIndividualGetPrefixesResponse>
</soap:Body>
</soap:Envelope>

Important! The sample for this method contains sample data. Do not assume that the specific data you see on this page, particularly the keys, are the same data that will exist in the netFORUM site in which you're developing an integration. Moreover, if you are developing an integration that will work against multiple netFORUM sites for multiple customers, be aware that the data for each customer, including setup data, will differ. See xWeb NetFORUM Overview for more information.

Related Web Methods

Related Functionality

Prefixes