The TypelistToolsAPI web service

The getTypelistValues method

The getTypelistValues method returns an array of the typekeys for a specified typelist.

getTypelistValues(typelist : String) : TypeKeyData[]

The typelist argument specifies a PolicyCenter typelist. If the typelist does not exist, the method throws an IllegalArgumentException. The method returns an array of TypeKeyData objects that contain the typekeys defined by the typelist. The typecode for a particular TypeKeyData object can be retrieved by calling its getCode method.

The getTypeKeyByAlias and getTypeKeysByAlias methods

The getTypeKeyByAlias and getTypeKeysByAlias methods are used when an external system is exporting data to PolicyCenter. The methods enable the external system to translate one of its own codes to a mapped PolicyCenter typecode.

getTypeKeyByAlias(typelist : String, namespace : String, alias : String ) : TypeKeyData
getTypeKeysByAlias(typelist : String, namespace : String, alias : String) : TypeKeyData[]

Each argument references an attribute value assigned in the typecodemapping.xml file. The typelist argument references a PolicyCenter typelist by specifying the value of the name attribute of the typelist element. The namespace argument identifies the external system by specifying its unique name attribute value assigned in its namespace element. The alias argument references the external system's code by specifying the alias attribute value of the mapping element. None of the arguments can be null.

The methods return either a single TypeKeyData object or an array of TypeKeyData objects that are mapped to the specified external system alias. The typecode for a particular TypeKeyData object can be retrieved by calling its getCode method.

If getTypeKeyByAlias finds more than one typecode mapped to the specified code, it throws an IllegalArgumentException.

The getAliasByInternalCode and getAliasesByInternalCode methods

The getAliasByInternalCode and getAliasesByInternalCode methods are used when an external system is importing data from PolicyCenter. The term "Alias" in the method names refers to an external system's code, and "InternalCode" refers to a PolicyCenter typelist and typecode combination. The methods enable the external system to translate a PolicyCenter typelist/typecode to a mapped code in the external system.

getAliasByInternalCode(typelist : String, namespace : String, code : String) : String
getAliasesByInternalCode(typelist : String, namespace : String, code : String) : String[]

Each argument references an attribute value assigned in the typecodemapping.xml file. The typelist argument references a PolicyCenter typelist by specifying the value of the name attribute of the typelist element. The code argument references the typelist's typecode by specifying the typecode attribute value of the mapping element. The namespace argument identifies the external system by specifying its unique name attribute value assigned in its namespace element. None of the arguments can be null.

The methods return either a single external system code or an array of codes that are mapped to the specified typelist and code.

If getAliasByInternalCode finds more than one code mapped to the specified typelist/typecode, it throws an IllegalArgumentException.