VOCABULARIES

RECO POX Web Services

Plain Old XML (POX) style services provide instant access to lists and details of vocabularies in RECO database.
RECO POX Web Services are also fully described by a Web Service Description Language (WSDL) document that can be used to create clients that access the service.

The following web service APIs are provided. Select from the following for more information on each method :

GetCodeTypeList - retrieves all the code types.

GetCodeList - retrieves all the codes for the given code type.

GetCodeDetail - retrieves all the details for the given code.

Name

GetCodeTypeList()

Description

This API of the web service returns all the code types.

Input

Modified (optional): All the code types that have been modified after the given date (e.g. 2010-12-24).
If there are no matches, an empty result set will be returned.

Output

Returns code types found in RECO that have been modified after the given date.

Example

Example to get all the code types
Example to get all the code types that have been modified after the 2010-12-01

Name

GetCodeList()

Description

This API of the web service returns all the codes for the given code type.

Input

Code Type: All the codes in a code type (e.g. SHIPC)
Modified (optional): All the code types that have been modified after the given date (e.g. 2010-12-24).
If there are no matches, an empty result set will be returned.

Output

Returns all the codes for the given code type that have been modified after the given date.

Example

Example to get all the codes in the SHIPC
Example to get all the codes in the SHIPC that have been modified after 2010-12-01

Name

GetCodeDetail()

Description

This API of the web service returns all the details for the given code.

Input

Code: (e.g. 26DA)
Code Type: (e.g. SHIPC)
If there are no matches, an empty result set will be returned.

Output

Returns all the details for the given code from the given code type

The output contains:

Code Detail (Key, Description, Modified)

Attribute (Description, Value, Modified)

Synonym (Description, Modified)

Parent Relation contains:

Parent code type (Key, Description, Modified)

Parent code (Key, Description, Modified)

Modified - modified date of relation

Child Relation contains:

Child code type (Key, Description, Modified)

Child code (Key, Description, Modified)

Modified - modified date of relation

Example

Example to get detail of the code "26DA" from the code type "SHIPC"
Example to get detail of the code "06VH" from the code type "SHIPC"