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.
JSON Method
POST /xWeb/JSON/WEBIndividualGetPrefixes
DATA: JSON
{
"WEBIndividualGetPrefixes": null
}
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Results": {
"@recordReturn": "7",
"Result": [
{
"prf_key": "d18a8445-3ba6-4945-a0a7-672c1d33869a",
"prf_code": null
},
{
"prf_key": "28268cd8-047c-4e5b-b2cd-bc659137dca0",
"prf_code": "Dr."
},
{
"prf_key": "feeeebbc-e169-4211-bbaa-2f7f0f17ebd2",
"prf_code": "Miss"
},
{
"prf_key": "0d694fa1-92b6-4c43-b16c-0c51cc971b99",
"prf_code": "Mr."
},
{
"prf_key": "c6950f39-4144-4b78-9916-bb23fc8e1c4a",
"prf_code": "Mrs."
},
{
"prf_key": "5fe3e654-85c2-4c1a-b6f5-4129d9bd43ef",
"prf_code": "Ms"
},
{
"prf_key": "7c349aa7-d6da-4be1-8baa-d43d82f2b05b",
"prf_code": "tt"
}
]
}
}