Administrative APIs | REST

Version:
Download Open API Specification

https://api.wealthcare.com/system/Services/Employer/{tpaId}/CopyReportSchedule

Initiates the process of copying a report schedule from one employer to another, identified by their unique employer IDs. This operation is useful for maintaining consistency in reporting across different employers within the system.

Request

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • originEmployerId string

    Employer ID for the employer where the report schedule currently exists.

    Min Length: 0
    Max Length: 18
  • destinationEmployerId string

    Employer ID for the employer where the new report schedule will be created.

    Min Length: 0
    Max Length: 18
  • scheduleName string

    Name of the report schedule that exists for the Origin Employer which will be copied to the Destination Employer.

    Min Length: 0
    Max Length: 50
  • deliveryOption enum<string>

    Delivery method for the report.

    Possible values: UIDownload UIDownloadEmail UIDownloadFTP UIDownloadEmailFTP Adminisource
  • emailOfRecipient string

    Recipient's email address.

    Min Length: 0
    Max Length: 250
  • emailOfSender string

    Sender's email address.

    Min Length: 0
    Max Length: 250

Response

  • ErrorCode integer <int32>
  • ErrorDescription string

AI Assistant Preview

Generating response...