public interface

IExternalAttachment

com.cbs.ctr3ws.iservices.IExternalAttachment
Known Indirect Subclasses

Class Overview

description: the interface contains the CTR2-DWL-Attachment soap webservices.

Summary

Public Methods
abstract boolean deleteAttachment(String nationalID, Long attachmentID, String deleteReason)
Delete a DWL attachement.
abstract WSAttachment downloadAttachment(String nationalID, Long attachmentId)
Download an attachment file from the CTR registry.
abstract WSAttachment downloadOfferAttachment(Long offerId, Long attachmentId)
Download a shared attachment file that is linked to an offer.
abstract List<WSAttachmentInfo> findAttachments(String nationalId, List<WSLookup> attachMentLocations)
Find a patient's attachment information, optionally the search results can be filtered by attachment section.
abstract List<WSAttachmentInfo> findOfferAttachments(Long offerId, List<WSLookup> attachmentLocations)
For a specified DWL offer, the methods finds the donor and recipient attachments.
abstract WSAttachmentInfo updateAttachment(WSAttachmentInfoCore attachmentInfoCore)
Update an existing attachment's information.
abstract WSAttachmentInfo uploadAttachment(WSAttachmentInfoCore attachmentInfoCore, WSAttachment wsAttachment)
Upload an attachment document to the CTR registry.

Public Methods

public abstract boolean deleteAttachment (String nationalID, Long attachmentID, String deleteReason)

Delete a DWL attachement.
note: This method is not supported when the attachment's section is offer cross match (OFFERS_XM).

Sample soap requests: deleteAttachment

Parameters
nationalID the CTR2 patient ID.
required: TRUE
see: nationalId info
attachmentID description: the unique attachment identifier.
required = TRUE
see: id field info
deleteReason description: the reason the attachment was deleted.
required = TRUE
see: free format text, max L=500
Returns
  • a flag indicating that the attachment delete operation was successful.
Throws
SoapException

public abstract WSAttachment downloadAttachment (String nationalID, Long attachmentId)

Download an attachment file from the CTR registry.
note: This method is not supported when the attachment's section is offer cross match (OFFERS_XM).

Sample soap requests:downloadAttachment

Parameters
nationalID the CTR2 patient ID.
required: TRUE
see: nationalId info
attachmentId description: the unique attachment identifier.
required = TRUE
see: id field info
Returns
Throws
SoapException

public abstract WSAttachment downloadOfferAttachment (Long offerId, Long attachmentId)

Download a shared attachment file that is linked to an offer.

Sample soap requests:downloadOfferAttachment

Parameters
offerId description: the unique offer identifier.
required = TRUE
see: id field info
attachmentId description: the unique attachment identifier.
required = TRUE
see: id field info
Returns
Throws
SoapException

public abstract List<WSAttachmentInfo> findAttachments (String nationalId, List<WSLookup> attachMentLocations)

Find a patient's attachment information, optionally the search results can be filtered by attachment section.
note: This method is not supported when the attachment's section is offer cross match (OFFERS_XM).

Sample soap requests:findAttachments

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
attachMentLocations the output filter: a list of patient sections( attachment locations) to include in output.
required: FALSE
see: LT_USER_COMMENT_SECTION
Returns
Throws
SoapException

public abstract List<WSAttachmentInfo> findOfferAttachments (Long offerId, List<WSLookup> attachmentLocations)

For a specified DWL offer, the methods finds the donor and recipient attachments. Optionally the search results can be filtered by section.
note: only attachments that are shared (side-by-side flag = TRUE) are listed.

Sample soap requests:findOfferAttachments

Parameters
offerId description: the unique offer identifier.
required = TRUE
see: id field info
attachmentLocations the output filter: a list of patient sections( attachment locations) to include in output.
required: FALSE
see: LT_USER_COMMENT_SECTION
Returns
Throws
SoapException

public abstract WSAttachmentInfo updateAttachment (WSAttachmentInfoCore attachmentInfoCore)

Update an existing attachment's information.
note: This method is not supported when the attachment's section is offer cross match (OFFERS_XM).

Sample soap requests:updateAttachment

Parameters
attachmentInfoCore the attachment's info to be updated.
required: TRUE
see: WSAttachmentInfoCore
Returns
Throws
SoapException

public abstract WSAttachmentInfo uploadAttachment (WSAttachmentInfoCore attachmentInfoCore, WSAttachment wsAttachment)

Upload an attachment document to the CTR registry.
note: This method is not supported when the attachment's section is offer cross match (OFFERS_XM).

Sample soap requests:uploadAttachment

Parameters
attachmentInfoCore the attachment's information.
required: TRUE
see: WSAttachmentInfoCore
wsAttachment the attachment document.
required: TRUE
see: WSAttachment
Returns
Throws
SoapException