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

Returns a list of phone models based on the IsSupported flag.

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

Syntax

C#
public WS..::.GetPhoneModelListResult GetPhoneModelList(
	string AccessKey,
	bool IsSupported
)
Visual Basic (Declaration)
Public Function GetPhoneModelList ( _
	AccessKey As String, _
	IsSupported As Boolean _
) As WS..::.GetPhoneModelListResult
JScript
public function GetPhoneModelList(
	AccessKey : String, 
	IsSupported : boolean
) : WS..::.GetPhoneModelListResult

Parameters

AccessKey
Type: System..::.String
Security key allocated to a developer enabling access to the web service API.
IsSupported
Type: System..::.Boolean
If True, returns a list of supported phones. If False, returns a list of known unsupported phones. Both lists are continously updated.

Supported phone models meet the following requirements: support true tone audio, color main display, internet enabled (with proper data plan).

Return Value

An array of supported/unsupported phone models within the Phone Sherpa system. Each item contains the name, vendor, user display name, and Phone Sherpa internal ID for a given phone model

Remarks

Phone Sherpa is continuously adding phone models into its system, keeping upto date with the last hardware releases. PhoneModelIDs are guarenteed to be maintained across DB updates, meaning referencing a phone model by its ID will be consistent and safe to store in a calling application's data structure.

This function is most often used in support of an end user interface. The phone model list can be placed in a drop down or similar UI element and the user can select thier phone model from it. PhoneModelID is used in several API calls to determine target content format targets, sizes, and general connectivity abilities.

If the user is not presented this list explicitly, it is up to the integrator to map the Phone Sherpa phone model ID values into its own notion of phone model or stored user account information.

Below is an example of how to use this function:

CopyVB.NET
Public Sub Populate_PhoneModels(ByRef ddPhoneModel As DropDownList)
    Dim SherpaService As New PhoneSherpa.Services.WS
    Dim PhoneModel_Response As PhoneSherpa.Services.GetPhoneModelListResult = Nothing
    Dim PhoneModelItem As PhoneSherpa.Services.PhoneModel = Nothing

    PhoneModel_Response = SherpaService.GetPhoneModelList("My_WSAccessKey", True)

    If PhoneModel_Response.Result.ErrorCode = 0 Then
        For Each PhoneModelItem In PhoneModel_Response.PhoneModels
            ddPhoneModel.Items.Add(New ListItem(PhoneModelItem.DisplayName, PhoneModelItem.Id.ToString))
        Next
    Else
        'error - failed calling the get phonemodel list call. Handle this here.
    End If
End Sub

See Also