Additional web-service operations since v5.0

Content

Additional web-service operations since v5.0

getAllCorridors operations

General

This operation should be used to retrieve the corridors.

Response

getAllCorridors operation returns a response consisted of the following:

  • corridors - if the operation runs successfully, list of corridors with the following structure is returned: id, code, cossId, returnCapacityPeriod, rnecName, rfcName, isRfcValid
  • status – description for the response. The list of error codes can be found in the Appendix A

getAllCatalogs operations

General

In the initial plan this operation was foreseen for the IM users to retrieve all RFC catalogs where their agency is involved. Since the structure of RFC differs from other catalog types, the usage of this function was extended for all catalogs types including RNE-C and CT catalogs. This operation can be used by IMs only.

Request

Several input parameters are planned for this operation:

  • ttpId – mandatory parameter
  • dossiertypeId
  • processtypeId
  • dossierstatusId
  • corridorId
  • imId

Response

getAllCatalogs operation returns a response consisted of the following:

  • catalogs – if the operation runs successfully, list of catalog dossiers with the following structure is exposed: id, dossiertypeId, processtypeId, dossierstatusId, corridorId, papId. The list can be empty if no dossier match the search criteria.
  • status – description for the response. The list of error codes can be found in the Appendix A

getCatalog operation

General

You should use this operation to get the full catalog dossier xml payload in order to prepare the catalog for update. This operation can be used by IMs only.

Request

getCatalog request is consisted of one element:

  • dossierId – mandatory parameter

Response

getCatalog operation returns a response consisted of the following:

  • Catalog dossier – if the operation runs successfully, the returned value is the catalog dossier data. It is expected that the returned data will be extended to adhere to updateCatalog implementation. 
  • status – description for the response. The list of error codes can be found in the Appendix A 

getCatalogWithReferenceIds

General

This operation represents alternative for getCatalog web service operation. In this variant, PCS Core attempts to:

  • use reference ids instead of PCS-specific operation point ids whenever possible (i.e. not all operation points have reference ids)
  • use agency uic codes instead of PCS-specific agency ids whenever possible (i.e. not all agencies have agency uic codes)

This operation can be used by IMs only.

Request

getCatalogWithReferenceIds request is consisted of following elements:

  • dossierId – mandatory parameter
  • usePcsOpPointIdInOperationPointLocal

Response

getCatalogWithReferenceIds operation returns a response consisted of the following:

  • Catalog dossier – if the operation runs successfully, the returned value is the catalog dossier data. It is expected that the returned data will be extended to adhere to updateCatalog implementation. 
  • status – description for the response. The list of error codes can be found in the Appendix A 

updateCatalog

General

You should use this operation to update catalog dossier. This operation can be used by IMs only.

Access rights of the IMs are in line with PCS Core.

Updating of the train parameters goes according to following rules:

  • IM updates the common parameters and sends back the original parameter set code - if the parameters are changed, the reference with parameter set code is broken
  • IM updates the common parameters and sends back another parameter set code (but still not the same as he defines with the parameters) - if the parameters are changed, the reference with parameter set code is broken. No new relationship is established with the received parameter set code.
  • Parameter set code is not set to new added path sections

Request

In the request, PCS IP system always expects the entire catalog dossier xml that was received as a response from getCatalog / getCatalogWithReferenceIds operation.

Response

updateCatalog 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

getObservationTypes

General

This operation should be used to retrieve the observation types.

Response

getObservationTypes operation returns a response consisted of the following:

  • observationTypes - if the operation runs successfully, list of observation types with the following structure is returned: observationTypeId, observationTypeDescription
  • status – description for the response. The list of error codes can be found in the Appendix A