Additional web-service operations since v5.1

Content

Additional web-service operations since v5.1

createSubsidiary operation

General

With this operation, the agencies would be able to create new subsidiaries in the system.

Request

createSubsidiary request is consisted of following elements:

  • path – mandatory element (dossier-specific ids for path and its children elements should not be set)
  • ruImPairId – mandatory element (this element should be provided in order PCS to resolve to which dossier subsidiary should be added)

Response

createSubsidiary operation returns a response consisted of the following:

  • status – description for the response. The list of error codes can be found in the Appendix A 

makeObservations

General

makeObservation operation exposed in PCS IP creates new, formatted (per the defined convention) comment in the dossier, based on the user provided input.

Request

makeObservation request is consisted of the following elements:

  • newObservation element which is consisted of the following
    • imIds – a mandatory list of IM agencies ids in the dossier which are influenced by the observation (the exact agencies ids can be found in the dossier xml)
    • imPathInfo (optional element)
      • pathId – IM path id for which the observation is about (the exact path id can be found in the dossier xml)
      • startingOperationPointId - operation point for which the observation is about. Should belong to entered pathId.
      • endingOperationPointId - operation point for which the observation is about. Should belong to entered pathId.
    • observationReasons – an optional element that indicates the reason for observation. In order to get id for observation reason you can use helper operation: getObservationTypes.
    • comment - an optional element, for further description of the objection
    • isJustified – an optional element that indicates whether the objection is justified
  • dossierId – mandatory element (this element should be provided in order PCS to resolve to which dossier the observation should be added.)

Response

makeObservation operation returns a response consisted of the following

  • id – id of the created observation
  • status – description for the response. The list of error codes can be found in the Appendix A. If everything went ok, the return code is:
    • 100 - SUCCESS