# paths./iswc/merge.post.summary
Merge ISWC meta-data associated with a provided list of ISWCs or Society Work Codes and as part of the merge have an ISWC designated as preferred.

# paths./iswc/merge.post.requestBody.content.application/xml.example
<MergeRequest> <iswcs>string</iswcs> <agencyWorks> <agencyCode>string</agencyCode> <agencyWorkCode>string</agencyWorkCode> </agencyWorks> </MergeRequest>

# paths./iswc/merge.post.responses.204.description
ISWC Metadata merged and ISWC designated as preferred

# paths./iswc/merge.delete.summary
Delete a set of incorrect metadata from a single Preferred ISWC that was incorrectly merged / matched previously.

# paths./iswc/merge.delete.description
Delete a set of incorrect metadata from a single Preferred ISWC that was incorrectly merged / matched previously.

# paths./iswc/merge.delete.parameters[].description
Agency internal workcode for work as previously submitted

# paths./iswc/searchByIswc.get.responses.200.content.application/xml.example
string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string

# paths./iswc/searchByIswc/batch.post.requestBody.content.application/xml.example
<SearchBatch> <SearchBatch> <iswc>string</iswc> </SearchBatch> </SearchBatch>

# paths./iswc/searchByIswc/batch.post.responses.207.content.application/xml.example
0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# paths./iswc/searchByAgencyWorkCode.get.summary
Find ISWC metadata for specified Agency and WorkCode

# paths./iswc/searchByAgencyWorkCode.get.parameters[].description
The Agency WorkCode of the ISWC submission

# paths./iswc/searchByAgencyWorkCode.get.parameters[].description
Allow the return of limited ISWC metadata

# paths./iswc/searchByAgencyWorkCode.get.responses.200.content.application/xml.example
string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string

# paths./iswc/searchByAgencyWorkCode/batch.post.summary
Find ISWC metadata for specified batch of Agency and WorkCodes

# paths./iswc/searchByAgencyWorkCode/batch.post.requestBody.description
Array of Agency Work Code search objects

# paths./iswc/searchByAgencyWorkCode/batch.post.requestBody.content.application/xml.example
<SearchBatch> <SearchBatch> <agency>string</agency> <workCode>string</workCode> </SearchBatch> </SearchBatch>

# paths./iswc/searchByAgencyWorkCode/batch.post.responses.207.content.application/xml.example
0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# paths./iswc/searchByTitleAndContributor.post.summary
Find ISWC metadata for specified Titles and Contributors

# paths./iswc/searchByTitleAndContributor.post.requestBody.content.application/xml.example
string
CT string string 0 string string CA N

# paths./iswc/searchByTitleAndContributor.post.responses.200.content.application/xml.example
string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string

# paths./submission.post.summary
Add a new ISWC submission to the database

# paths./submission.post.description
Add a new ISWC submission to the database

# paths./submission.post.requestBody.description
ISWC submission object that needs to be added to the ISWC Database

# paths./submission.post.requestBody.content.application/xml.example
string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string true true true full

# paths./submission.post.responses.201.content.application/xml.example
0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string 0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string

# paths./submission.put.requestBody.description
ISWC submission object that needs to be updated in the ISWC Database

# paths./submission.put.requestBody.content.application/xml.example
string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string true true true full

# paths./submission.put.responses.200.content.application/xml.example
0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string 0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string

# paths./submission.delete.parameters[].description
Agency internal workcode for work as previously submitted

# paths./submission.delete.parameters[].description
Format - int32. SourceDb of ISWC submission to delete

# paths./submission/batch.post.summary
Add a batch of new ISWC submissions to the database

# paths./submission/batch.post.description
Add a batch of new ISWC submissions to the database

# paths./submission/batch.post.requestBody.description
Array of ISWC submission objects that need to be added to the ISWC Database

# paths./submission/batch.post.requestBody.content.application/xml.example
0 string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string true true true full string string string string

# paths./submission/batch.post.responses.207.content.application/xml.example
0 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string 0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string

# paths./submission/batch.put.summary
Update a batch of existing ISWC submissions

# paths./submission/batch.put.requestBody.description
ISWC submission objects that need to be updated in the ISWC Database

# paths./submission/batch.put.requestBody.content.application/xml.example
0 string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string true true true full string string string string

# paths./submission/batch.put.responses.207.content.application/xml.example
0 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string 0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string

# paths./iswc/workflowTasks.get.summary
Retrieve a list of outstanding Workflow Tasks associated with an Agency

# paths./iswc/workflowTasks.get.description
Retrieve a list of outstanding Workflow Tasks associated with an Agency

# paths./iswc/workflowTasks.get.parameters[].description
Workflows assigned to or created by my Agency

# paths./iswc/workflowTasks.get.parameters[].description
Format - int32. Number of records to return

# paths./iswc/workflowTasks.get.parameters[].description
Format - YYYY-MM-DD. Left bound on date range

# paths./iswc/workflowTasks.get.parameters[].description
Format - YYYY-MM-DD. Right bound on date range

# paths./iswc/workflowTasks.get.parameters[].description
Filter by Agency Work Codes - seperated by \';\'

# paths./iswc/workflowTasks.get.responses.200.content.application/xml.example
0 UpdateApproval Outstanding string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string

# paths./iswc/workflowTasks.patch.summary
Update the status of an outstanding Workflow Tasks associated with an Agency

# paths./iswc/workflowTasks.patch.description
Update the status of an outstanding Workflow Tasks associated with an Agency

# paths./iswc/workflowTasks.patch.requestBody.content.application/xml.example
<IswcWorkflowTasksPatchRequest-2> <taskId>0</taskId> <workflowType>UpdateApproval</workflowType> <status>Outstanding</status> <workflowMessage>string</workflowMessage> </IswcWorkflowTasksPatchRequest-2>

# paths./iswc/workflowTasks.patch.responses.207.content.application/xml.example
0 UpdateApproval Outstanding string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string

# paths./allocation/batch.post.summary
Allocate a batch of new ISWC submissions

# paths./allocation/batch.post.description
Allocate a batch of new ISWC submissions

# paths./allocation/batch.post.requestBody.description
Array of ISWC allocation objects that need to be added to the ISWC Database

# paths./allocation/batch.post.requestBody.content.application/xml.example
0 string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string true true true full string string string string

# paths./allocation/batch.post.responses.207.content.application/xml.example
0 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string 0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string

# paths./resolution/batch.post.requestBody.description
Array of ISWC submission objects that need to be resolved in the ISWC Database

# paths./resolution/batch.post.requestBody.content.application/xml.example
0 string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string true true true full string string string string

# paths./resolution/batch.post.responses.207.content.application/xml.example
0 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string 0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string string string string string

# paths./agent/notification.get.summary
Retrieve a list of CSN notifications associated with an Agency

# paths./agent/notification.get.description
Retrieve a list of CSN notifications associated with an Agency

# paths./agent/notification.get.parameters[].description
Format - YYYY-MM-DD. The date from which to retrieve notifications

# paths./agent/notification.get.parameters[].description
Format - int32. Number of records to return

# paths./agent/notification.get.responses.200.content.application/xml.example
string string string string string MER string Outstanding string string string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# paths./agent/run.post.summary
Notify ISWC when an agent run starts and ends

# paths./agent/run.post.description
Notify ISWC when an agent run starts and ends

# paths./agent/run.post.requestBody.content.application/xml.example
<AgentRun> <agentVersion>string</agentVersion> <agencyCode>string</agencyCode> <runId>string</runId> <updateRecordCount>0</updateRecordCount> <newRecordCount>0</newRecordCount> <overallRejected>0</overallRejected> <overallSent>0</overallSent> <successfulCount>0</successfulCount> <businessRejectionCount>0</businessRejectionCount> <technicalRejectionCount>0</technicalRejectionCount> </AgentRun>

# paths./agent/run.post.responses.200.content.application/xml.example
<CsnNotification> <runId>string</runId> </CsnNotification>

# paths./thirdParty/searchByIswc/batch.post.summary
Third Party - Find ISWC metadata for specified ISWCs

# paths./thirdParty/searchByIswc/batch.post.requestBody.content.application/xml.example
<SearchBatch> <SearchBatch> <iswc>string</iswc> </SearchBatch> </SearchBatch>

# paths./thirdParty/searchByIswc/batch.post.responses.207.content.application/xml.example
0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# paths./thirdParty/searchByAgencyWorkCode/batch.post.summary
Third Party - Find ISWC metadata for specified batch of Agency and WorkCodes

# paths./thirdParty/searchByAgencyWorkCode/batch.post.requestBody.description
Array of Agency Work Code search objects

# paths./thirdParty/searchByAgencyWorkCode/batch.post.requestBody.content.application/xml.example
<SearchBatch> <SearchBatch> <agency>string</agency> <workCode>string</workCode> </SearchBatch> </SearchBatch>

# paths./thirdParty/searchByAgencyWorkCode/batch.post.responses.207.content.application/xml.example
0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# paths./thirdParty/searchByTitleAndContributor/batch.post.summary
Third Party - Find ISWC metadata for specified Titles and Contributors

# paths./thirdParty/searchByTitleAndContributor/batch.post.requestBody.content.application/xml.example
string
CT string string 0 string string CA N

# paths./thirdParty/searchByTitleAndContributor/batch.post.responses.207.content.application/xml.example
0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# paths./iswc/searchByTitleAndContributor/batch.post.summary
Find ISWC metadata for specified batch of Titles and Contributors

# paths./iswc/searchByTitleAndContributor/batch.post.requestBody.content.application/xml.example
string
CT string string 0 string string CA N

# paths./iswc/searchByTitleAndContributor/batch.post.responses.207.content.application/xml.example
0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# paths./iswc/usage/searchByTitleAndContributor/batch.post.summary
Usage Search - Find ISWC metadata for specified batch of Titles and Contributors

# paths./iswc/usage/searchByTitleAndContributor/batch.post.requestBody.content.application/xml.example
string
CT string string 0 string string CA N

# paths./iswc/usage/searchByTitleAndContributor/batch.post.responses.207.content.application/xml.example
0 string string string string string string
string
CT string string 0 string string CA N 0 true true string string string string string string string 0 string DOM true DIT string Background ModifiedVersion string
string
string string string string string string 0 string string string string string string string
string
CT string string 0 string string CA N string string string string string string string string

# components.schemas.ISWCMetadata.allOf[].properties.parentISWC.description
A preferred ISWC of a parent of this ISWC. Presence of this field indicates that the ISWC merged to the parent.

# components.schemas.ISWCMetadata.allOf[].properties.linkedISWC.description
All linked preferred ISWCs. Presence of this field indicates that those ISWCs merged to this ISWC.

# components.schemas.ISWCMetadata.allOf[].properties.overallParentISWC.description
The preferred ISWC that is at the top of the chain of ISWCs.

# components.schemas.ISWCMetadataBatch.properties.searchId.description
A unique identifier for this request. The same identifier will be populated for the ISWC Metadata request in the response.

# components.schemas.Submission.allOf[].properties.previewDisambiguation.description
If this field is set to true, the submission will not be saved to the ISWC database if there are multiple matches. If this field is set to false or is not provided, the submission will be saved to the ISWC database.

# components.schemas.Submission.allOf[].properties.disableAddUpdateSwitching.description
If this field is set to true, the submission will be rejected if a submission already exists for the provided Agency Work Code.

# components.schemas.Submission.allOf[].properties.allowProvidedIswc.description
If this field is set to false, the submission will be rejected if the preferredIswc value cannot be found in the database. If this field is set to true and the preferredIswc value cannot be found in the database, a new ISWC record will be created with the value provided.

# components.schemas.Submission.allOf[].properties.detailLevel.description
Allow the return of limited ISWC metadata

# components.schemas.SubmissionBatch.properties.submissionId.description
A unique submission identifier for this request. The same identifier will be populated for the submission in the response.

# components.schemas.VerifiedSubmission.properties.id.description
An unique identifier assigned by the system

# components.schemas.VerifiedSubmission.properties.iswcEligible.description
Indicator of a submitter being Iswc Eligible

# components.schemas.VerifiedSubmission.properties.deleted.description
Indicator of a submission being logically deleted on CSINET

# components.schemas.VerifiedSubmission.properties.linkedFrom.description
The ISWC record that this is linked from

# components.schemas.VerifiedSubmission.properties.overallParentISWC.description
The preferred ISWC that is at the top of the chain of ISWCs.

# components.schemas.VerifiedSubmissionBatch.properties.submissionId.description
The value of the submissionID from the request submission.

# components.schemas.CommonSubmissionAttributes.properties.cisnetCreatedDate.description
Date and time when this metadata was created on CISNET

# components.schemas.CommonSubmissionAttributes.properties.cisnetLastModifiedDate.description
Date and time when this metadata last modified on CISNET

# components.schemas.CommonSubmissionAttributes.properties.additionalIdentifiers.description
Optional list of additional identifiers that can be supplied with the submission.

# components.schemas.CommonISWCMetadata.properties.agency.description
A CISAC code of a submitting agency that allocated this ISWC

# components.schemas.CommonISWCMetadata.properties.otherTitles.description
Other titles associated with musical composition (aka alternative titles)

# components.schemas.CommonISWCMetadata.properties.interestedParties.description
Interested party associated with musical composition, such as :composers, lyricist, translator, original and sub publishers

# components.schemas.CommonSystemAttributes.properties.lastModifiedDate.description
Data and time of the latest update in the system

# components.schemas.CommonSystemAttributes.properties.lastModifiedBy.description
Identifier of the last update in the system

# components.schemas.InterestedParty.properties.role.description
The role will be rolled up to the corresponding CISAC Role as per the following mapping: C(C,A,CA), MA(AR,SR), TA(AD,SA,TR) E(E,AM)

# components.schemas.BVLTR.description
Background, Logo, Theme, Visual or Rolled Up Cue

# components.schemas.DerivedWorkType.description
Derived Work Type- if not provided then this isn't a derived work

# components.schemas.AgencyWorkCodeSearchModel.properties.workCode.description
The Agency WorkCode of the ISWC submission