[This is preliminary documentation and is subject to change.]

Returns a list of states or provinces for a given country.

Namespace:  PhoneSherpa.Services
Assembly:  App_Code.fxrph_yi (in App_Code.fxrph_yi)
Version: 0.0.0.0

Syntax

C#
public WS..::.GetStateProvinceListResult GetStateProvinceList(
	string AccessKey,
	int CountryID
)
Visual Basic (Declaration)
Public Function GetStateProvinceList ( _
	AccessKey As String, _
	CountryID As Integer _
) As WS..::.GetStateProvinceListResult
JScript
public function GetStateProvinceList(
	AccessKey : String, 
	CountryID : int
) : WS..::.GetStateProvinceListResult

Parameters

AccessKey
Type: System..::.String
Security key allocated to a developer enabling access to the web service API.
CountryID
Type: System..::.Int32
Phone Sherpa internal identifier for a country. Returned states/provinces will all be for the specified CountryID

Return Value

An array list of states or provinces for the specified country.

Remarks

This function is most often used in support of an end user interface. The state or province list can be placed in a drop down or similar UI element and the user can select thier state. The selected ID value is used in billing API calls.

If the user is not presented this list explicitly, it is up to the integrator to map the Phone Sherpa state/province ID values into its own notion of user account information.

This ID values from this function return object is only needed for calling credit card billing functions and is part of the address verification system [AVS] for CC validation.

See Also