ProblemList - CWS web service

AddClientProblems Call

Adds to and/or edits a client’s list of problems.

When adding to a client's problem list, if a cached 'SYSTEM.RADplus_IMO_results' table row exists, and either 'IMOCacheCode' or 'IMOCode' and 'IMODesc' (in combination) is provided, many other properties do not need to be provided, since data will come directly from the cached table row. Alternatively, all of the same properties returned from either the 'SearchProblems' or 'GetClientProblemList' call can be filled out, including the internal hash. This hash will be validated against all other properties provided, and hash validation will fail if any of these properties are different or missing. This prevents users from making modifications to data returned by the 'SearchProblems' or 'GetGlientProblemList' call.

Data validation can fail for a number of reasons. If data validation fails, no data will be filed. Reasons for validation failure may include missing required fields, providing an invalid 'UniqueID', attempting to file duplicate active problem codes, filing conflicting problem data that already exists for the client, etc.. When validation fails, the response will contain errors. These errors will detail the nature of the error and the web service object which caused the error. If validation succeeds, the response will indicate a successful filing, and will include the 'UniqueID's of the added/edited problems. It is recommended that a 'GetClientProblemList' call is performed before performing a 'AddClientProblems' call in order to anticipate and resolve these validation errors.

The following tables list the AddClientProblems parameters, properties, accepted values, and associated dictionaries.

GetClientProblemList Call

Gets a client’s current list of problems. This list will include all of the data displayed in the 'Problem List' myAvatar form, as well as a 'UniqueID' for each item (which can be used by the 'AddClientProblem' call to select the problem to be modified).

When retrieving existing client problems that use IMO problem codes, the results will contain a number of properties, including 'IMOCode', 'IMODesc', 'IMOLastUpdated', etc.. The property 'IMOCacheCode' is a value that is returned if a cached 'SYSTEM.RADplus_IMO_results' table row exists for the problem code.The property 'InternalHash' is a value that is generated from other returned properties. See the 'AddClientProblems' call for more information on how these properties are used.

The following tables list the GetClientProblemList parameters, properties, accepted values, and associated dictionaries.

GetDictionaryItems Call

Gets the dictionary codes and values from the myAvatar 'Problem List' form and grid. 

The following tables list the GetDictionaryItems parameters, properties, accepted values, and associated dictionaries.

SearchProblems Call

Search for valid problem codes/descriptions using the IMO problem search (if available), as well as any user defined problems defined in myAvatar . The data returned can be used when adding/editing a client’s problem list.

When searching for problems via the IMO web search, the results will contain a number of properties, including 'IMOCode', 'IMODesc', 'IMOLastUpdated', etc.. The property 'IMOCacheCode' is a value that is returned if a cached 'SYSTEM.RADplus_IMO_results' table row exists for the problem code.The property 'InternalHash' is a value that is generated from other returned properties. See the 'AddClientProblems' call for more information on how these properties are used.

The following tables list the SearchProblems parameters, properties, accepted values, and associated dictionaries.

Object class: ListOfProblemListObjectsContainer

Object class: ListOfProblemListObjects

Object class: ProblemListObject

Object class: ListOfProblemCodeObjects

Object class: ProblemCodeObject