. Version 2.3, November 15, 2013 This document is provided for information purposes by the ISAN International Agency. It does not correspond to any contractual engagement by the ISAN International Agency. ISAN-IA 30, rue de Saint Jean CH-1203 Geneva Switzerland Tel: +41 22 545 10 00 Fax: +41 22 545 10 40 Email: [email protected]ISAN API: SOAP Web Services
137
Embed
ISAN API: SOAP Web Services4/137 ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013 ISAN API: SOAP Web Services 4.7 Tr_IsanReferenceCompanyList_Type 24 4.8 Client_type 25
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
.
Version 2.3, November 15, 2013 This document is provided for information purposes by the ISAN International Agency. It does not correspond to any contractual engagement by the ISAN International Agency.
ISAN-IA 30, rue de Saint Jean CH-1203 Geneva Switzerland Tel: +41 22 545 10 00 Fax: +41 22 545 10 40 Email: [email protected]
ISAN API: SOAP Web Services
2/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Scope This document provides information to project managers and developers implementing ISAN web services
Audience Technical
Author Régis Flad & Erica Ozonne - ISAN International Agency
Creation Date 14-Mar-07
Last Revision 15-Nov-13
Distribution ISAN users
Revision history
Date Ver. Description Participants
10/05/2007 1.0 First draft for diffusion Author: Erica Ozonne Review: Régis FLAD; Murat Kanmaz
21/05/2007 1.1 Second Draft: Update the type SumIsanMetadata and the diagram Annex D - Transaction Result Diagram: ISAN Works Management
Author: Erica Ozonne Review: Régis FLAD
08/06/2007 1.2 Third Draft: Update the API Version to 2.0 and minor editorial changes
Author: Erica Ozonne Review: Régis FLAD
28/06/2007 1.3 Add result code definition and update transaction result diagrams for “Update” web services that are now asynchronous. Update the SOAP messages.
Author: Erica Ozonne Review: Régis FLAD
05/07/2007 1.4 First Publication Author: Erica Ozonne Review: Régis FLAD
27/08/2007 2.0 Update the Type Client and SOAP messages for creation and update of client. Update parameters for setClientBlockStatus service.Update SOAP messages
Author: Erica Ozonne Review: Régis FLAD
14/09/2007 2.2 Update the Client type and add the Web Service “setClientRegistrationCheck” Second Publication
Author: Erica Ozonne Review: Régis FLAD
30/01/2008 2.2
Update Annex D : Add new Result Codes. Update Queries SOAP messages. Update Annex E – activateIndevIsanWork - was not described
as an asynchronous service. Add the service TR-14 getStatusFromRegPk
Author: Erica Ozonne Review: Régis FLAD
15/11/2013 2.3 Add “deprecated” watermark. ISAN API users are invited to use the ISAN API RESTful web services.
3/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Table of contents
1 ISAN WEB SERVICES API ________________________________________________________________ 7
1.1 Introduction 7
1.2 API Versions 7
1.3 Security 7
1.4 Web Services Functional Rules 8
1.5 Related documents 8
1.6 Normative References 8
1.7 Acronyms used in ISAN documents 8
1.8 Terms used in ISAN documents 9
2 LIST OF WEB SERVICES _________________________________________________________________ 11
2.1 User Identication 11
2.2 ISAN Registration 11
2.3 ISAN In-Dev Management 11
2.4 Client Management 12
2.5 Query Management 12
2.6 Transaction Result Management 12
2.7 Thesaurus Management 13
3 USER IDENTICATION ___________________________________________________________________ 14
3.1 WS-ID01: Get the session Key 14
3.2 WS-ID02: Get the Session Key on behalf of a registrant 16
3.3 WS-ID03: Check the session key 17
4 COMMON TYPES OF DATA ______________________________________________________________ 19
4.1 IsanMetadata_Type 19
4.2 TransactionResult_Type 22
4.3 Tr_Isan_Type 22
4.4 Tr_IsanMetadata_Type 22
4.5 Tr_Sum_IsanMetadataList_Type 23
4.6 Tr_IsanRefParticipantList_Type 24
4/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
10.2 WS-TR02: Get the result code of a transaction 89
10.3 WS-TR03: Get the number of item for a transaction list. 90
10.4 WS-TR04: Retrieve the ISAN Registration 91
10.5 WS-TR05: Retrieve the ISAN Metadata 93
10.6 WS-TR06: Retrieve a list of In-Dev works. 95
10.7 WS-TR07: Retrieve a list of serial header. 97
10.8 WS-TR08: Retrieve the client information result 101
10.9 WS-TR09: Retrieve a list of clients. 104
10.10 WS-TR10: Retrieve a list of participants. 106
10.11 WS-TR11: Retrieve a list of Production companies. 107
10.12 WS-TR12: Retrieve a list of ISAN Work Result. 110
10.13 WS-TR13: Retrieve a list of serial episodes. 112
10.14 WS-TR14: Get the status of a work from the registrant identifier 115
ANNEX A - LIST OF COUNTRY CODES _______________________________________________________ 118
ANNEX B – LIST OF LANGUAGE CODES ______________________________________________________ 120
ANNEX C – METADATA ENCODING GUIDELINES ______________________________________________ 124
Entering Titles 124
Entering Names 124
Stage Names 124
Middle Names 124
Last Names 124
6/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Production Companies – Not mandatory descriptive information 124
ANNEX D - RESULT CODE DEFINITION _______________________________________________________ 125
ANNEX E - TRANSACTION RESULT DIAGRAM: ISAN WORKS MANAGEMENT _______________________ 132
ANNEX F - TRANSACTION RESULT DIAGRAM: QUERIES MANAGEMENT __________________________ 134
ANNEX G - TRANSACTION RESULT DIAGRAM:CLIENTS MANAGEMENT ___________________________ 136
7/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
1 ISAN Web Services API
1.1 INTRODUCTION
The document provides information to project managers and developers implementing ISAN Web Services. The usage of ISAN Web Services is intended to RA interested to implement the AV Works management features offered by ISAN-IA as its own application. It can also be intended for RA interested to build over the ISAN Web Services their own web services bound for clients with large volume of queries like broadcaster. This specific use of the web services has to be clarified with ISAN-IA. The ISAN Web Services Application programming Interface is the interface provided by ISAN-IA to Registration Agencies in order to access the ISAN system through a list of Web Services. The API describes the list of published functions and their arguments. A version number is given to the API to ensure the stability of its behavior.
1.2 API VERSIONS
An API change is anything that changes the signature of a public or private method and which would possibly affect clients of the API. The ISAN Web Services API version ensures the compatibility with ISAN Web Services in regards of evolutions of the ISAN-IA System. When the API major version changes from version n to version n+1 all RA that have implemented the web services are informed of the new release, and are invited to upgrade their system to the version n+1. The API version n is kept on line as long as RA are using it and maintained until the version n+2 is ready. At the n+2 version release ISAN-IA can not guaranty the maintenance of the API version n.
1.3 SECURITY
The Web Services are secured on two levels:
Networking level: An IP restriction is applied between authorized clients (RA firewalls) and the ISAN servers firewall
Applicative level: The Web Services access is secured with a Session Key that identifies the user temporally. The Session Key is obtained by invoking a specific service, it is as required argument for each Web Service.
8/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
1.4 WEB SERVICES FUNCTIONAL RULES
The functional rules that apply will be checked by each method, the technical constraints as well as the bad parameter values will be checked at the Web Service level and return specific error messages. In general, unless stated otherwise, access control is defined like this:
An inactivated or inactive RA cannot perform activities with the web services.
A blocked client cannot perform billable tasks, doing otherwise will result in an error.
An inactivated or inactive client cannot perform any task; doing this will result in an error.
A reader client cannot perform registrant task, doing this will result in an error.
A blocked RA has limited access to the system.
1.5 RELATED DOCUMENTS
Additional documentation is available on-line from the “List of operations” page that is provided for each service. A user interface implementing each service is also available on-line from the “List of operations” page on the production server.
ISAN-IA documents:
- ISAN_WS_Validation.pdf (A service Web for ISAN validation) - ISANIA_WS_V-ISAN_v1.0.pdf (ISAN Version Web Services)
1.6 NORMATIVE REFERENCES
ISO 15706:2002, Information and Documentation – International Standard Audiovisual Number (ISAN) ISO 15706-2:2007, Information and Documentation – International Standard Audiovisual Number (ISAN) — Part 2: Version identifier
1.7 ACRONYMS USED IN ISAN DOCUMENTS
ISAN-IA or I-A ISAN International Agency
AV Audiovisual
DB Database
RA Registration Agency
9/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
WT Web Template
WS Web Services
SH Serial Header
RR Registration Rule
MD Metadata
MDV Metadata Validator. See the Term ISAN Validation Tool
MDL Metadata Loader
POID Purchase Order Identifier
QS Quality Stage
MPR Match Pending Resolution
RegPK The Registrant private ID for a work submitted in the ISAN database. Also knowns as REGID
REGID Same as RegPK
1.8 TERMS USED IN ISAN DOCUMENTS
Audiovisual work A work consisting of a sequence of related images with or without accompanying sound, which is intended to be made visible as a moving image and/or audible through the use of devices, regardless of the medium of initial or subsequent fixation.
False Negative The matching engine has missed the matching ISAN.
False Positive The matching engine has found a match that is not a match in the reality.
ISAN Validation Tool A tool that validates XML files for Massive ISAN Registration
ISAN Version ISAN Vesion number as defined in ISO15706-2. An ISAN Version identify a version of a work that is identified with an ISAN Work
ISAN Work ISAN number for a work as defined in ISO 15706:2002
Pending An audiovisual work candidate for ISAN registration ecognized by the ISAN Matching Engine as have probably already an ISAN. Pending need to be checked by human to decide if a new ISAN should be issued the audiovisual work.
Reader A reader is a client of a Registration Agency with the purpose of consultation of the central ISAN repository for identification or inventory management.
10/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Registrant Producer of an audiovisual work, authorized proxy of such producer, or other such entity or individual, registered with a designated ISAN registration agency for the purposes of obtaining ISAN for audiovisual works.
Registration Agency Agency appointed by the International Agency for the purposes of assigning ISAN to registrants.
Serial (Audiovisual) work
An audiovisual work produced in individual episodes or parts which bear a relationship to each other and, usually a common title for the whole series
Web Template The Web application to access the ISAN Database for ISAN registration and browsing the ISAN database.
XML The Extensible Markup Language (XML) is a markup language capable of describing many different kinds of data in a structured way. XML is a W3C-recommendation largely adopted by the industry.
XML Schema An XML schema expresses a set of rules to which an XML document must conform in order to be considered 'valid' according to that schema. XML Schema is a W3C-recommendation largely adopted by the industry.
11/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
2 List of Web Services
2.1 USER IDENTICATION
Code Name Description API WS-ID01 getSessionKey Get Session Key 1.1
WS-ID02 getSessionKeyOnBehalf Get Session Key On Behalf 1.1
WS-ID03 checkSessionKey Check Session Key 1.1
2.2 ISAN REGISTRATION
2.3 ISAN IN-DEV MANAGEMENT
Code Name Description API
WS-WM01 registerSingleWork Register a single Work 2.0 WS-WM02 updateSingleWork Update single Work 2.0 WS-WM03 registerSerialHeader Register Serial Header 2.0 WS-WM04 updateSerialHeader Update Serial Header 2.0 WS-WM05 registerEpisode Register Episode 2.0 WS-WM06 updateEpisode Update Episode 2.0 WS-WM07 getIsanMetadata Get ISAN Metadata 2.0 WS-WM08 getSerialHeaderMetadata Get Serial Header Metadata 2.0 WS-WM09 listSerialEpisodes List Episodes for a serial 2.0
Code Name Description API
WS-IM01 registerIndevIsanSingleWork Register an In-dev ISAN for a single work.
2.0
WS-IM02 updateIndevIsanSingleWork Update Single Indev Work. 2.0
WS-IM03 registerIndevIsanEpisode Register an In-dev ISAN for an Episode
2.0
WS-IM04 updateIndevIsanEpisode Update Indev Episode 2.0 WS-IM05 listIndevIsanWorks List Indev ISAN 2.0 WS-IM06 getIndevIsanMetadata Get ISAN Indev Metadata 2.0 WS-IM07 activateIndevIsanWorks Activate Indev Works 2.0
12/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
2.4 CLIENT MANAGEMENT
2.5 QUERY MANAGEMENT
2.6 TRANSACTION RESULT MANAGEMENT
Code Name Description API
WS-CM01 createClient Create a new Client 2.0
WS-CM02 updateClient
Update a Client 2.0
WS-CM03 getClientsList
Display the list of Clients 2.0
WS-CM04 getClientInformation
Get Client Information 2.0
WS-CM05 setClientActivationStatus
Activate/desactivate Client 2.0
WS-CM06 setClientBlockStatus Block/unblock a client 2.0
WS-CM07 changeClientPassword
Change a client’s password 2.0
WS-CM08 setClientRegistrationCheck Set Client registration check status 2.0
WS-TR08 getClientTResult Retrieve Client Information Result 2.0
WS-TR09 getClientListTResult Retrieve list of Client Result 2.0
Code Name Description API
WS-QM01 searchIsanByIsanMetadata Search from work info 2.0
WS-QM02 searchIsanByIsanTitle Search ISAN From Title 2.0
WS-QM03 searchSerialHeaderByTitle Search Serial Header (by Title) 2.0
Code Name Description API
WS-TR01 getTransactionStatus Get the status of an asynchronous operation (success / failed / In progress)
2.0
WS-TR02 getTransactionCode Get Error/Success message from Error/Success code
2.0
WS-TR03 getTransactionListCount Get the number of items for a Transaction List
2.0
WS-TR04 getIsanTResult Retrieve the ISAN Registration result 2.0
WS-TR06 getIndevWorkListTResult Retrieve the list of In-Dev 2.0
WS-TR07 getSerialHeaderListTResult Retrieve a list of results after a Serial Headers search
2.0
13/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
2.7 THESAURUS MANAGEMENT
WS-TR10 getParticipantListTResult Retrieve the list of participants after a search for participant
2.0
WS-TR11 getProdCompanyListTResult Retrieve the list of production companies after a Search for production companies
2.0
WS-TR12 getIsanWorksListTResult
Retrieve a List of results after a WS-QM01 and QM02 operation
2.0
WS-TR13 getSerialEpisodeListTResult Retrieve the list of Serial Episodes (after a WS-WM09 operation)
2.0
WS-TR14 getStatusFromRegPk Check the status of a registration from its registrant identifier , when its transaction has expired
1.0
Code Name Description API WS-TH01 searchParticipant Search a participant in the participant
list. The search criteria is: first_name% and / or last_name% (minimum 3 characters)
2.0
WS-TH02 searchProdCompany Search a production company in the production company list, the search criteria is company_name% (minimum 3 characters)
2.0
14/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
3 User Identication
This service is used to identify a client who wants to use the ISAN-IA web service platform. When logging into the security manager. A session key is delivered to the user as far he is registered in the ISAN System. The session key is a mandatory parameter for any web service invocation. The session key has a limited validity and is inactivated if no activity is detected after one hour. After inactivation, a new key should be requested. Requests:
Name of the service: checkSessionKey This service allows a RA or a client to check if the session key is still active. If the session key is active, the key valididy is reset to one hour. Input Parameters:
Parameter name (type) Description Mandatory String sessionKey Session key registered in DB and which is valid for a given period of time.
Response:
Parameter name (type) Description
String result 0: the session key is not active. 1: the session key is still active.
Errors: List of possible errors:
- SessionHasExpiredException : Session has expired please log.
- SessionNotExistException : Session does not exist please log before.
- UserNotAllowedException : User is not allowed to create ISAN version. please contact your administrator.
18/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
4 Common Types of data
4.1 ISANMETADATA_TYPE
Attributs Description Possible Values Type Max
Length Occurenc
e
IsanWork
ISAN of the work
16 hexadecimal digit followed with a check character (using Arabic numerals 0 to 9 and letters A to Z), followed by an 8 hexadecimal digit version segment, followed with a check character (using Arabic numerals 0 to 9 and letters A to Z). The ISAN is separated into groups after every four hexadecimal digit or check character using a hyphen. See exemple below: 0000-0000-6776-0000-8-0000-0000-D
string 33 0 or 1*
WorkType Work Type Code
AD advert CO compilation DO documentary ED educational FF Feature Film GA game NE news PF performance SE drama SH short SP sport TE other TV TF TV Movie
string 2 1
WorkKind Work Kind Code A: Animated L: Live Action LA: Live Action Animated
string 2 1
WorkYearOfReference Year of reference YYYY format, from 1896 to current year +1 string 4 1
WorkYearOfFirstPublication Year of 1st publication YYYY format, from 1896 to current year +1 String 4 0 or 1
IsWorkComposite
NO: This work is NOT a composite YES: This work IS a composite
String 3 0 or 1
RunningTime Duration of the Work TimeValue and TimeUnit elements Section N/A 1
TimeValue
Duration type
MIN SEC
String 3 1
TimeUnit Duration length in the specified unit A positive value that can neither be decimal nor 0 String 4 1
IsWorkCoproduction
Co-production flag
NO: This work is NOT a co-production YES: This work IS a co-production NOTE: If this field is set to NO then there is no need to provide a production company identified below (ProductionCompany). If this field is set to YES, then there must be two or more identified production companies.
String 3 1
IsWorkColor Color flag The valid values for this field are: NO: black and white. YES:Color
String 3 1
IsWorkSilent Sound flag
NO: the work is not silent. YES: the work is silent
String 3 1
IsWorkSerial Work serial flag
The valid values for this field are: SW:This is a Single Work SH: This is a Serial Header SE: This is an episode of a serial work
String 2 1
EpisodeDetail Episode details (Only for serial works)
SerialHeaderRegistrantId, SerialHeaderId, Season, Episode elements Section N/A 0 or 1
SerialHeaderRegistrantId
Reference to serial header (using work internal identifier)
This is the code value previously assigned to this particular series (through the Series Header) that is used to link all of the episodes together. Every episode of a particular series will have the same Serial Header ID. NOTE: If work is an episode, then this field or SerialHeaderId MUST be filled in. SerialHeaderRegistrantId and SerialHeaderId cannot be present at the same time.
String 20 1
SerialHeaderId Optional reference to serial header 16 hexadecimal digit followed with a check character (using Arabic numerals 0 to 9 String 33 0 or 1
20/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
(using ISAN) and letters A to Z), followed by an 8 hexadecimal digit version segment, followed with a check character (using Arabic numerals 0 to 9 and letters A to Z). The ISAN is separated into groups after every four hexadecimal digit or check character using a hyphen. See exemple below: 0000-0000-6776-0000-8-0000-0000-D
Season Season Number Usually non decimal numbers String 5 0 or 1
Episode Episode Number Usually non decimal numbers String 9 0 or 1
ExternalIdList List of other dentifier for the Work (Agicoa, private identifier, …).
A list of ExternalID elements (see definbition below). Section N/A 1
ExternalID Other work identifier information ExternalIdType and ID elements Sub-
section N/A 1
ExternalIdType Type of the work identifier
agicoa : AGICOA number that shall be encoded in the following way: <work_number>-<episode_number> For non episodic works or serial headers, the episode shall be set to ‘0’. Examples ‘1234-99’ is the episode number 99 of work 1234. ‘445-0’ is the work 445 (non-serial because of the ‘0’) registrant : Private ID used by registrants to identify their works. This identifier is usually unique across all the works submitted by a registrant during its Registrant lifetime.
String 20 1
ID Work identifier Any combination of numbers and characters String 20 1
ReferenceCountryList List of countries of reference List of ReferenceCoutry elements (See definition below). Section 20 0 or 1
ReferenceCountry Country of reference A reference country for Production, Publication or Shooting Sub-
section N/A 1 or more
RelatedAction Country Type
PRO : Production Company PUB : Publication Company SHO: Shooting Company
String 3 1
CountryCodeISO3166_1 Country Code See Annex A for the list of possible ISO3166-1 codes String 3 1
LanguageList List of Language(s) List of Language elements (See definition below) Section N/A 1
Language Original Language Original language of the Work
Sub-section
N/A 1 or more
LanguageCodeISO639_2 Language Code See Annex B for the list of possible ISO 639-2 codes String 3 1
TitleList List of Title(s) for the Work
TitleDetail elements.
Section N/A 1
TitleDetail Information about a title
You must provide at least one title per work. You are encouraged to provide every known title for the work (working titles, alternate foreign language titles, etc.). The titles do not have to be in the Latin alphabet (you can provide Chinese titles in Chinese characters, for instance). Each title has an associated language – this is the language of the title not of the work. For example, the title Das Boot would be identified as a German title while The Boat would be identified as an English title, even though they both refer to the same work.
Sub-section
N/A 1 or more
LanguageCodeISO639_2 Title’s language See Annex B for the list of possible language codes String 3 1
TitleKind The kind of title, whether Original or Alternate.
ORIGINAL : Original Title (At least 1 original Title is mandatory) String 12 1
ALTERNATE: Alternative Title
Title The Title
Title shall be written in the original form (for example particle cannot be put in the end: “Boat, the” is illegal. Title shall not be abbreviated Numbers should be used in the way that they appeared during work release (“SEVEN” is different from “7”). See Annex C for more recomendations
String 200 1
ParticipantList A list of participants of the AV Work
Participant elements. NOTE: If the same person performed more than one distinct function you may list them more than once, each time with a different ParticipantRoleCode. (If an actor played more than one role, only list them once with the ACT code.)
Section N/A 0 or 1**
Participant Participants information FirstName, LastName, ParticipantRoleCode elements. At least one Participant describing a director (DIR) must be present in the ParticipantList or in the IsanRefParticipant list.
Sub-Section
N/A 1 or more
FirstName Participant’s first name First Name of the Participant. Cannot include numbers, optional. Including middle name
String 50 1
LastName Participant’s last name Last Name of the Participant. Cannot include numbers, length must be greater than String 50 1
ParticipantRoleCode Character flag
ACT: Actor ANC: Anchor CAS: Cast CDES: Character Designer CREA: Creator CHA: Character COM: Composer DEV: Developer DIR: Director DIS: Distributor EPRO: Executive Producer GDES: Game Designer
String 10 1
21/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
GDIR: Game Director LPRO: Lead Programmer MUS: Music By PRO: Producer SCR: Screenwriter SPK: Speaker NAR: Narrator
IsanRefParticipantList
A list of Participant of the AV Work that are efenced with an ID in the ISAN database. This ID can be retrieved with WS-TH01
A list of IsanRefParticipant attributes Section N/A 0 or 1**
IsanRefParticipant Participants information ParticipantId, FirstName, LastName, ParticipantRoleCode elements. At least one Participant describing a director (DIR) must be present in the ParticipantList or in the IsanRefParticipant list.
Sub-section
N/A 1 or more
ParticipantId Id of the participant in the database The ID of the participant in the ISAN DB. This ID can be retrieved with WS-TH01. String 20 1
FirstName Participant’s first name First Name of the Participant. Only for informative purpose, the First Name refenced in the ISAN DB will be used
String 50 0 or 1
LastName Participant’s last name Last Name of the Participant. Only for informative purpose, the Last Name refenced in the ISAN DB will be used
String 50 0 or 1
ParticipantRoleCode
ACT: Actor ANC: Anchor CAS: Cast CDES: Character Designer CREA: Creator CHA: Character COM: Composer DEV: Developer DIR: Director DIS: Distributor EPRO: Executive Producer GDES: Game Designer GDIR: Game Director LPRO: Lead Programmer MUS: Music By PRO: Producer SCR: Screenwriter SPK: Speaker NAR: Narrator
String 10 1
CompanyList List of Production company(ies) A list of Company attributes Section N/A 0 or 1
Company Information about the Production Company
A CompanyName attribute Sub-
Section N/A 1 or more
CompanyName
The name of the production company, in mixed case with any appropriate accent marks. (This is not a Unicode field, so the Production Company Name must be presented in the standard Latin alphabet.) The following rules apply for production companies: - Use consistent naming (20th Century or Twentieth Century but not both) - Do not put distribution company, right owner or in case of merger new company, group, etc. Only put ORIGINAL production company
String 100 1
IsanRefCompanyList
A list of Production Companies refenced with an ID in the ISAN database. This ID can be retrieved with WS-TH02
A list of IsanRefCompany attributes Section N/A 0 or 1
IsanRefCompany A CompanyName and a CompanyId Attributes Sub-
Section N/A 1 or more
CompanyName
The name of the production company, in mixed case with any appropriate accent marks.
The following rules apply for production companies: - Use consistent naming (20th Century or Twentieth Century but not both) - Do not put distribution company, right owner or in case of merger new company, group, etc. Only put ORIGINAL production company Note: This is not a Unicode field, so the Production Company Name must be presented in the standard Latin alphabet.)
String 100 0 or 1
CompanyId Id of the production company in the database
String 20 1
CompositeIsanList List of Composite work reference
A list of CompositeIsan attributes. Only valid and mandatory when isWorkComposite = Yes. Refers to composite part that have an ISAN. The ISAN of the compite parts must be registered previousely in the ISAN system
Section N/A 0 or 1
CompositeIsan A Coposite ISAN reference An IsanWork attribute Sub-
Section N/A 1 or more
IsanWork ISAN of the composite
16 hexadecimal digit followed with a check character (using Arabic numerals 0 to 9 and letters A to Z), followed by an 8 hexadecimal digit version segment, followed with a check character (using Arabic numerals 0 to 9 and letters A to Z). The ISAN is separated into groups after every four hexadecimal digit or check character using a hyphen. See exemple below: 0000-0000-6776-0000-8-0000-0000-D
String 33 1
22/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
This is the type to describe the ISAN metadata, for a Single Work, a Serial Episode and a Serial Header. It is used as web service attribute, but also returned as result depending on the web service.
* For WS-WM01, WM03, WM05, IM01, IM03= 0, for WS-WM02, WM04, WM06, IM02, IM04 = 1, WS-TR05 = 1
4.2 TRANSACTIONRESULT_TYPE
4.3 TR_ISAN_TYPE
This is the type of result returned for WS-TR04 (getIsanTResult)
4.4 TR_ISANMETADATA_TYPE
This is the type of result returned for WS-TR05 (getIsanMetadataTResult)
Attributs Description Possible Values Type Max
Length Occurence
TransactionResult Transaction Result Cf. definition of TransactionResult_Type TransactionResult_Type N/A 1
IsanMetadata Isan Metadata Cf. definition of IIsanMetadata_Type IIsanMetadata_Type N/A 1
Attributs Description Possible Values Type Max Length Occurence
TransactionId Unique identifier of the transaction Letters and digits string 10 1
TransactionStatus Unique identifier of the transaction -1 : Aborted: Operation has aborted due to errors 0 : In Progress: Operation is still on going 1 : Finished: Operation has succeeded
string 1 1
TransactionCode Result code of the transaction EXX : Refers to an error code SXX : Refers to a success code
string 3 1
TransactionResult Result
Describe the result of the transaction or null if an error occurred. To have more detailed information about a successful result refer to the message associated to the success code
string 100 1
Attributs Description Possible Values Type Max
Length Occurence
TransactionResult Transaction Result Cf. definition of TransactionResult_Type TransactionResult_Type N/A 1
Isan Isan number
16 hexadecimal digit followed with a check character (using Arabic numerals 0 to 9 and letters A to Z), followed by an 8 hexadecimal digit version segment, followed with a check character (using Arabic numerals 0 to 9 and letters A to Z). The ISAN is separated into groups after every four hexadecimal digit or check character using a hyphen. See exemple below:
0000-0000-6776-0000-8-0000-
0000-D
string 33 1
23/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
4.5 TR_SUM_ISANMETADATALIST_TYPE
ISAN Metadata list in a summarized form. This is the type of result returned for WS-TR06, WS-TR07, WS-TR12, WS-TR13 (getIndevWorkListTResult, getSerialHeaderListTResult, getEpisodeListTResult, getIsanWorksListTResult)
Attributs Description Possible Values Type Max
Length Occurence
Tr_Sum_IsanMetadataList A list of ISAN metadata in a summarized form
A list of TR_Sum_IsanMetadata sub sections.
Section N/A 1
TR_Sum_IsanMetadata TransactionResult and SumIsanMetadata elements
Sub-Section N/A 1 or more
TransactionResult Transaction Result See TransactionResult_Type element TransactionResult_Type 1
SumIsanMetadata Isan Metadata in a summarized form.
See SumIsanMetadata_Type element definition below
SumIsanMetadata_Type 1
Attributs Description Possible Values Type Max
Length Occurence
SumIsanMetadata Sumarized form of IsanMetadata_Type
A WorkType, WorkYearOf Reference, and TiltleList attrubute
Section N/A 1
WorkType Work Type Code
AD advert CO compilation DO documentary ED educational FF Feature Film GA game NE news PF performance SE drama SH short SP sport TE other TV TF TV Movie
string 2 1
WorkYearOf Reference Year of Reference YYYY format, from 1896 to current year +1 string 4 1
TitleList List of Title(s) for the Work
TitleDetail elements. Section N/A 1
TitleDetail Information about a title A LanguageCodeISO639_2, TitleKind and Title attributes
Sub-section N/A 1 or more
LanguageCodeISO639_2 Title’s language See Annex B for the list of possible language codes
String 3 1
TitleKind
The kind of title, whether Original or Alternate.
ORIGINAL Original Title String 12 1
ALTERNATE Alternative Title
Title The Title Free text String 200 1
24/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
4.6 TR_ISANREFPARTICIPANTLIST_TYPE
This is the type of result returned after a search by Participant (See WS-TH01: Search for Participant)
Attributs Description Possible Values Type Max
Length Occurence
Tr_IsanRefParticipantList A list of participants referenced in the ISAN System
A list of Tr_ IsanRefParticipant sub-sections Section N/A 1
Tr_ IsanRefParticipant
An Item of the list. Describes a participant referenced in the ISAN database
TransactionResult and IsanRefParticipant elements
Sub Section N/A 1 or more
TransactionResult Transaction Result See definition of TransactionResult_Type TransactionResult_Type N/A 1
IsanRefParticipant Participant metadata
See definition of IsanRefParticipant_Type IsanRefParticipant_Type N/A 1
4.7 TR_ISANREFERENCECOMPANYLIST_TYPE
This is the type of result returned after a search by Production Company (See WS-TH02: Search for Production Company)
Attributs Description Possible Values Type
Max Length
Occurence
Tr_IsanReferenceCompanyList A list of companies referenced in the ISAN System
A listt of Tr_ IsanReferenceCompany Elements Section N/A 1
Tr_IsanReferenceCompany
An Item of the list. Describes a company referenced in the ISAN database
TransactionResult and IsanReferenceCompany elements
Sub-Section N/A 1 or
more
TransactionResult Transaction Result See definition of TransactionResult_Type TransactionResult_Type N/A 1
IsanReferenceCompany
Production Company metadata
See definition of IsanRefCompany_Type IsanReferenceCompany_Type
N/A 1
25/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
4.8 CLIENT_TYPE
This is the type of result used in WS-CM01, WS-CM02, WS-TR08 (getClientTResult)
Attribute Description Possible Values Type Max
Length Occurrence
Identifiers Client identification information ClientId, ClientNumber, ClientGroup, UserNamePrefix attributes
Section N/A 1
ClientId The ISAN-IA Client ID. This ID is provided by ISAN-IA and will be reported in invoices.
A string. Format is: CL.n.m.x
- n is the registration agency number of the client,
- m.x the identifier Should not be filled during registration.
String 25 0 or 1
ClientNumber For backward compatibilities, deprecated A number String 10 0 or 1
ClientGroup Client group information, read only
GroupId, DisplayContactInGroup attributes Sub-
Section N/A 0 or 1
GroupId ID of the client Group if the client is part of a group
A String. String 25 1
DisplayContactInGroup Is it allowed to display contact information for the group of client?
YES NO This field is mandatory if GroupId is filled in.
String 3 1
UserNamePrefix Client identifier, unique system prefix for user login
[\da-zA-Z\-]{5,10} String 10 1
ClientCheck Client check information, Read only.
AdmissionRight, BlockReason, RegCheck, RegCheckComment, Status attributes
Section N/A 0 or 1
AdmissionRight Specifies if the client has access to the ISAN services.
UNB
Unblocked :The client has access to the system
String
3
1 BLO Blocked: The client does not have access to the
system
BlockReason The reason of blocking a client
BR1 Payment issues
String
3 0 or 1*
BR2 ISAN Descriptive information quality problems
BR3 Registration issues
BR4 Other issues *This field is mandatory if AdmissionRight is set to BLOCKED.
BlockReasonComment Block reason comment *This field is mandatory if BlockReason is set to BR4 String 500 0 or 1*
RegCheck
Registration check
RC1 Membership in A/V trade association
String
3 1
RC2 Sponsorship by trade association
RC3 Verified declaration of activity in A/V industry
RC4 Other
RegCheckComment Registration check comment
*This field is mandatory if RegCheck is set to RC4. String
500 0 or 1*
Status
Current status of the client
ACT The client is active
String
3 1
INA The client is inactive
PEN The client is pending
REF The client is refused *This field should not be provided during registration or update
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
ContactType
Contact type
IND Individual client, If specified, FirstName and LastName are mandatory
String
3 1 LEG
Legal client, If specified, Name and Acronym are mandatory
This field should be INDIVIDUAL if Contact Kind is BILLING, MAIN or REGISTRATION
ContactKind
Contact kind
BIL Client’s billing contact
String
3 1
MAI Client’s main contact
OFF Client’s official contact
PUB Client’s public contact (Not Yet Implemented)
REG Client’s registration contact
To be registered, a client need to have at least an Official and a Main Contact .
FirstName FirstName of the client Free text *Mandatory when Contact Type is INDIVIDUAL If specified the LastName is mandatory
String
100 0 or 1*
LastName LastName of the client
Free text, *Mandatory when Contact Type is INDIVIDUAL If specified the FirstName is mandatory
String
100 0 or 1*
Name
Client’s Name. If specified, the Acronym is mandatory
Free text *Mandatory when Contact Type is LEGAL. This field should not be filled if Contact Kind is BILLING, MAIN or REGISTRATION.
String
100 0 or 1*
Acronym
Client’s Acronym. If specified, the Name is mandatory
Free text *Mandatory when Contact Type is LEGAL. This field should not be filled if Contact Kind is BILLING, MAIN or REGISTRATION.
String 100 0 or 1*
Email
Contact’s e-mail address
Must be valid in order to receive login information. No validity check is performed. *This field should not be filled if Contact Kind is OFFICIAL
String
100
0 or 1*
JobTitle Contact’s job title
Free text. *This field should not be filled if Contact Kind is OFFICIAL
String
50
0 or 1*
Address
Contact’s Address
AddressType, Street, Zip, City, Country attributes *This field should not be filled if Contact Kind is MAIN or REGISTRATION
Sub-Section
N/A
0 or 1*
Street The street address of the client Number and street of the client / to which invoices should be sent.
String
500 1
Zip The zip code of the client
Post code (zip code) of the client / to which invoices should be sent.
String 10 1
City The city of the client City of the client / to which invoices should be sent String 50 1
Country The country of the client / to which invoices should be sent
A country Label and CodeISO3166_1 attributes Section N/A 1
CodeISO3166_1 Country Code ISO 3166-1 country code See Annex A String 2 1
Label Country Label ISO 3166-1 country name
Read only field. String - 0 or 1
PhoneList A list of phone numbers A list of Phone attributes Sub-
Section N/A 0 or 1
Phone
Client phone information *OFFICIAL Contact should have between 1 and 2 Phone elements. *MAIN Contact should have between 1 and 3 Phone elements.
*BILLING, REGISTRATION Contacts should have between 0 and 3 Phone elements.
Sub-Section
N/A
1 to 3*
PhoneType
Phone type PHT1: General/central
String
4 1
PHT2: Fax PHT3: Mobile PHT4: Direct
PhonePrefix Country prefix for the phone number In the form: “+xx”, example “+41” for Switzerland String 3 1
PhoneNumber Phone number [0-9], space character String 15 1
Created Date of registration Read only field.
ISO 8601 in CET or CEST timezone. Format is: YYYY-MM-DDThh:mm:ss.mil+02:00 Y,M,D,h,m,s are decimal values in the range 0 to 9 YYYY Year 4 digit (e.g 2006) MM Month 2 digit (eg 06) DD Day 2 digit (eg. 21) T Letter T for Timezone hh Hour 2 digit (e.g 13) mm Minute 2digit (eg 02) Ss Mil
Second 2 digit (eg 55) Milliseconds 3 digits (eg 321)
String 29 0 or 1
27/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
4.9 TR_CLIENT_TYPE
This is the type of result returned for WS-TR08 (getClientTResult).
Attributs Description Possible Values Type Max
Length Occurence
TransactionResult Transaction Result See TransactionResult_Type definition TransactionResult_Type N/A 1
Client Client data See Client_Type definition
Client_type N/A 1
4.10 TR_SUM_CLIENTLIST_TYPE
Sumarized information about clients. This is the type of result returned for WS-TR09 (getClientListTResult)
Attributs Description Possible Values Type Max
Length Occurence
Tr_Sum_ClientList Summarized information about a list of client
List of Tr_Sum_Client elements Section N/A 1
Tr_Sum_Client Summarized information about a client
A TransactionResult and Sum_Client attribute Sub-Section N/A 1 or more
TransactionResult Transaction Result See TransactionResult definiton TransactionResult_Type N/A 1
Sum_Client Client Metadata in a summarized form.
See Sum_Client definition Sum_IsanMetadata_Type N/A 1
4.11 SUM_CLIENT_TYPE
Attributs Description Possible Values Type Max
Length Occurence
Sum_Client
N/A 1
Type Client type REA reader REG registrant
String 3 1
UsernamePrefix Client unique system prefix String 10 1
Status
Current status of the client
ACT The client is active INA The client is Inactive PEN The Client is Pending REF The client is Refused
String 3 1
Name Client Name String 100 1
Modified Date of last modification Read only field.
ISO 8601 in CET or CEST timezone. Format is: YYYY-MM-DDThh:mm:ss.mil+02:00 Y,M,D,h,m,s are decimal values in the range 0 to 9 YYYY Year 4 digit (e.g 2006) MM Month 2 digit (eg 06) DD Day 2 digit (eg. 21) T Letter T for Timezone hh Hour 2 digit (e.g 13) mm Minute 2digit (eg 02) Ss Mil
Second 2 digit (eg 55) Milliseconds 3 digits (eg 321)
String
29
0 or 1
28/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
List of operations http://webservices.test.isan.org/WorksServices/IsanWorksManagement/2.0/IsanWorksManagementWSSoapHttpPort
5.1 WS-WM01: REGISTER A SINGLE WORK
Name of the service: registerSingleWork This service allows to register a new single work in the ISAN database. Asynchronous service. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
IsanMetadata_Type metadata New metadata of the single work to register See IsanMetadata_Type definition
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. A valid purchase order set to “Invoiced” must exist. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanTResult to get the ISAN number with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined.
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
5.2 WS-WM02: UPDATE A SINGLE WORK
Name of the service: updateSingleWork
This service allows to update an existing single work. Asynchronous service. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
IsanMetadata_Type metadata Metadata to be updated See IsanMetadata_Type definition
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The Work must be in the client’s catalogue. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanTResult to get the ISAN number with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>Your ISAN update request has been sent.</TransactionResult>
<TransactionCode>P002</TransactionCode>
</Result>
</updateSingleWorkResponseElement>
</env:Body>
</env:Envelope>
5.3 WS-WM03: REGISTER SERIAL HEADER
Name of the service: registerSerialHeader This service allows to register a new serial header in the ISAN database. Asynchronous service.
34/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
IsanMetadata_Type metadata Metadata to be registered. Only the Serial Header specific metadata will be used (IsWorkSerial = SH, SerialHeaderRegistrantId, TitleList).
See IsanMetadata_Type definition
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. Response:
Parameter name (type) Description
TransactionResult_Type Call getIsanTResult to get the SerialHeaderId (formatted as an ISAN) that identifies the Serial Header with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>Your ISAN registration has been sent.</TransactionResult>
<TransactionCode>P001</TransactionCode>
</Result>
</ registerSerialHeaderResponseElement >
</env:Body>
</env:Envelope>
5.4 WS-WM04: UPDATE SERIAL HEADER
Name of the service: updateSerialHeader This service allows to update an existing serial header. Asynchronous service. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
IsanMetadata_Type metadata Metadata of the Serial Header to be updated. Only the Serial Header specific metadata will be used (IsWorkSerial = SH, SerialHeaderId, TitleList).
See IsanMetadata_Type definition
Yes
Conditions:
36/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanTResult to get the SerialHeaderId (formatted as an ISAN) that identifies the Serial Header with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>Your ISAN update request has been sent.</TransactionResult>
<TransactionCode>P002</TransactionCode>
</Result>
</updateSerialHeaderResponseElement>
</env:Body>
</env:Envelope>
5.5 WS-WM05: REGISTER EPISODE
Name of the service: registerEpisode This service allows to update register a new episode. Asynchronous service. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
IsanMetadata_Type metadata Metadata of the new episode See IsanMetadata_Type definition
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. A valid purchase order set to “Invoiced” must exist. The SerialHeaderId must exist.
38/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanTResult to get the ISAN number with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>Your ISAN registration has been sent.</TransactionResult>
<TransactionCode>P001</TransactionCode>
</Result>
</registerEpisodeResponseElement>
</env:Body>
</env:Envelope>
5.6 WS-WM06: UPDATE EPISODE
Name of the service: UpdateEpisode
This service allows to update an existing episode. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
IsanMetadata_Type metadata Metadata to be updated See IsanMetadata_Type definition
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The Episode must be in the client’s catalogue. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanTResult to get the ISAN number of the updated Episode with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined.
41/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
<TransactionResult>Your ISAN update request has been sent.</TransactionResult>
<TransactionCode>P002</TransactionCode>
</Result>
</updateEpisodeResponseElement>
</env:Body>
</env:Envelope>
5.7 WS-WM07: GET ISAN METADATA
Name of the service: getIsanMetadata
This service retrieve the metadata associated to a given ISAN number Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
String Isan ISAN number Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a reader or registrant. A RA user can also invoke this service. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanMetadataTResult to get the retrieved metadata with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure:
44/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
<TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult>
<TransactionCode>S006</TransactionCode>
</Result>
</getIsanMetadataResponseElement>
</env:Body>
</env:Envelope>
5.8 WS-WM08: GET SERIAL HEADER METADATA
Name of the service: getSerialHeaderMetadata
This service allows to get the metadata for a specific serial header. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
String Isan ISAN number of the serial header Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant.
45/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanMetadataTResult to get the retrieved metadata from the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>BillableISAN: One work retrieved to be billed : Do you wish to
continue anyway ?</TransactionResult>
<TransactionCode>S003</TransactionCode>
</Result>
</getSerialHeaderMetadataResponseElement>
</env:Body>
</env:Envelope>
46/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
5.9 WS-WM09: LIST EPISODES FOR A SERIAL
Name of the service: listSerialEpisodes
This service allows to list episodes for a specific serial. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
String IsanSerialHeader Serial Header ID formatted as an ISAN number Must exist in the database
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a reader or a registrant. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction Call getSerialEpisodeListTResult with this transaction id to retrieve the list
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request
List of operations http://webservices.test.isan.org/WorksServices/IsanWorksManagement/2.0/IsanWorksManagementWSSoapHttpPort
6.1 WS-IM01: REGISTER AN IN-DEV ISAN FOR A SINGLE WORK
Name of the service: registerIndevIsanSingleWork
This service registers an In-development ISAN for a single work. Input Parameters: Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. A valid purchase order set to “Invoiced” must exist. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction Call getIsanTResult to get the ISAN number with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined.
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
This service allows to update a single Indev work Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
IsanMetadata_Type metadata Metadata to be updated. All metadata defined here will replace the existing metadata.
See IsanMetadata_Type definition
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The indev must be in the client’s catalogue Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="UTF-8" standalone="no"?><SOAP-ENV:Envelope
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
<TransactionCode>S01</TransactionCode>
</result>
</ updateIsanSingleWorkResponseElement>
</env:Body>
</env:Envelope>
6.3 WS-IM03: REGISTER AN IN-DEV ISAN FOR AN EPISODE
Name of the service:registerIndevIsanEpisode
This service allows to register an Indev Episode. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String IsanSerialHeader Serial Header ID formatted as an ISAN number Must exist in the database
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction. Call getIsanMetadataTResult to get the retrieved metadata with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request
Name of the service:UpdateIsanIndevEpisode This service allows to update an Indev episode. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition Yes
IsanMetadata_Type metadata Metadata to be updated See IsanMetadata_Type definition
Yes
54/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The Indev must be part of the client’s catalogue. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction Call getIsanMetadataTResult to get the retrieved metadata with the transaction result Id.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="UTF-8" standalone="no"?><SOAP-ENV:Envelope
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
6.5 WS-IM05: LIST IN-DEV ISAN
Name of the service: listIndevIsanWorks
This service lists all In-dev works for a client. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction Call getIndevWorkListTResult from the transaction id to get the retrieved list.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="UTF-8" standalone="no"?> <SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema" xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://org/isan/IsanWorksManagementWS.wsdl" xmlns:tns0="http://org/isan/IsanWorksManagementWS.wsdl/types/" xmlns:soap11-enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAPSDK4="http://schemas.xmlsoap.org/wsdl/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <tlistIndevIsanWorksElement>
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="UTF-8" standalone="no"?> <SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema" xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://org/isan/IsanWorksManagementWS.wsdl" xmlns:tns0="http://org/isan/IsanWorksManagementWS.wsdl/types/" xmlns:soap11-enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAPSDK4="http://schemas.xmlsoap.org/wsdl/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <tgetIndevIsanMetadataElement> <tsessionKey xsi:type="xsd:tstring">9E9DC748944A8BE67EDDD41B28304143 </tsessionKey> <tisan xsi:type="xsd:tstring">0000-0001-5FD5-0000-E-0000-0000-W</tisan> </tgetIndevIsanMetadataElement> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
6.7 WS-IM07: ACTIVATE IN-DEV WORKS
Name of the service: activateIndevIsanWork
This service allows to activate an Indev Isan Work. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String IsanInDev The indev ISAN number of the work to activate Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The Indev must be part of the client’s catalogue Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined. SOAP Message Structure: Request <?xml version="1.0" encoding="UTF-8" standalone="no"?> <SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema" xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://org/isan/IsanWorksManagementWS.wsdl" xmlns:tns0="http://org/isan/IsanWorksManagementWS.wsdl/types/" xmlns:soap11-enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAPSDK4="http://schemas.xmlsoap.org/wsdl/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <tactivateIndevIsanWorkElement> <tsessionKey xsi:type="xsd:tstring">9E9DC748944A8BE67EDDD41B28304143</tsessionKey> <tIsanIndev xsi:type="xsd:tstring">0000-0001-5FD5-0000-E-0000-0000-W</tIsanIndev>
List of operations http://webservices.test.isan.org/ClientsServices/2.0/IsanClientsManagementServices
7.1 WS-CM01: CREATE A NEW CLIENT
Name of the service: createClient This service allows to create a new client Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
Client_Type The new client to create See Client_Type definition
Yes
Conditions: Only RA users can perform this operation Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. A list of all possible errors code and messages is being defined.
<TransactionResult>Client has been successfully updated.</TransactionResult>
<TransactionCode>S031</TransactionCode>
</TransactionResult>
</updateClientResponseElement>
</env:Body>
</env:Envelope>
7.3 WS-CM03: DISPLAY THE LIST OF CLIENTS
Name of the service: getClientsList This service allows to get the list of clients for a given RA. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
See sessionKey definition
Yes
Conditions: Only RA users can perform this operation Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction Call getClientsListTResult to retrieve a list of Tr_SumClient_type
69/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
Conditions: Only RA users can perform this operation The client must be registered in the RA Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction Call getClientTResult with this transactionId to get the result
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
String activationStatus The new client status (ACT:active, INA:inactive) Yes
Conditions: Only RA users can perform this operation The client must be registered in the RA Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction
72/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
String blockStatus The new client status (BLO: blocked, UNB: unblocked) Yes
String blockReason
Blockage reason (BR1: Payment issues, BR2: ISAN Descriptive information quality problems, BR3: Registration issues, BR4: Other issues)
Mandatory if the new client status is blocked: (BLO)
No
String blockReasonComment Block reason comment, mandatory if blockReason is BR4 (Other issues)
Mandatory if blockReason is BR4 (Other Issues)
No
Conditions: Only RA users can perform this operation The client must be registered in the RA Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>Client Block Status has been successfully
updated</TransactionResult>
<TransactionCode>S027</TransactionCode>
</result>
</setClientBlockStatusResponseElement>
</env:Body>
</env:Envelope>
7.7 WS-CM07: CHANGE A CLIENT’S PASSWORD
Name of the service: changeClientPassword
This service allows to change a client password Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String login Client login Yes
String oldPassword Old password No
String newPassword New password Yes
Conditions: Only RA users can perform this operation The client must be registered in the RA Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction
75/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>Password has been successfully changed.</TransactionResult>
<TransactionCode>S028</TransactionCode>
</result>
</changeClientPasswordResponseElement>
</env:Body>
</env:Envelope>
7.8 WS-CM08: SET CLIENT REGISTRATION CHECK
Name of the service: setClientRegistrationCheck
This service allows to set a client registration check status. Client registration check must be performed after a client creation and prior activating the client.
76/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String login Client login Yes
String regCheck
Registration check (RC1: Membership in A/V trade association, RC2: Sponsorship by trade association, RC3: Verified declaration of activity in A/V industry, RC4: Other)
Yes
String regCheckComment Registration check reason comment, mandatory if regCheck is RC4 (Other
Mandatory if regCheck is RC4 (Other)
No
Conditions: Only RA users can perform this operation The client must be registered in the RA Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
This service allows to search for a serial header by title Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String title The title of the serial header to find Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. Response:
Parameter name (type) Description
TransactionResult_Type Result of the current transaction Call getSerialHeaderListResult to retrieve a list of Tr_SumIsanMetadata
83/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <searchSerialHeaderByTitleElement xmlns="http://org/isan/QueriesManagementWS.wsdl/types/"> <SessionKey>447CAD8051C8DD2BAC0D51290F04E6E4</SessionKey> <Title>Dark</Title> </searchSerialHeaderByTitleElement> </soap:Body> </soap:Envelope>
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
9.2 WS-TH02: SEARCH FOR PRODUCTION COMPANY
Name of the service: searchProdCompany
This service allows to search a production company in the production company list. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String companyName Name of the company to find Yes
Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. Response:
Parameter name (type) Description
TransactionResult_Type
Result of the current transaction. Call getProdCompanyListTResult to retrieve the list of production companies
formatted in a list of Tr_IsanRefCompany
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="UTF-8" standalone="no"?> <SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema" xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://org/isan/QueriesManagementWS.wsdl" xmlns:soap11-enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAPSDK4="http://schemas.xmlsoap.org/wsdl/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body>
87/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
10 Transaction Results Management
Web Service Access:
Test Server
WSDL Address http://webservices.test.isan.org/WorkServices/TransactionManagementWS/2.0/TransactionManagementWSSoapHttpPort?WSDL and http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/2.0/TransactionListManagementWSSoapHttpPort?WSDL
List of operations http://webservices.test.isan.org/WorkServices/TransactionManagementWS/2.0/TransactionManagementWSSoapHttpPort and http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/2.0/TransactionListManagementWSSoapHttpPort
10.1 WS-TR01: GET THE STATUS OF A TRANSACTION
Name of the service:getTransactionStatus This service allows to get the status of a transaction. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: N/A Response:
Parameter name (type) Description
String transactionStatus status of the transaction
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getTransactionStatusElement xmlns="http://org/isan/TransactionManagementWS.wsdl/types/"> <SessionKey>04B91C0CC45C04B98A3ECC5019448EA2</SessionKey> <TransactionId>6526C193A51C84215C6B2B47D78AB27D</TransactionId> </getTransactionStatusElement> </soap:Body>
10.2 WS-TR02: GET THE RESULT CODE OF A TRANSACTION
Name of the service:getTransactionCode
This service allows to get the result code of a transaction. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: N/A
90/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Response:
Parameter name (type) Description
String transactionCode Result code of the transaction
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getTransactionCodeElement xmlns="http://org/isan/TransactionManagementWS.wsdl/types/"> <SessionKey>04B91C0CC45C04B98A3ECC5019448EA2</SessionKey> <TransactionId>6526C193A51C84215C6B2B47D78AB27D</TransactionId> </getTransactionCodeElement> </soap:Body> </soap:Envelope>
Name of the service:getIsanTResult This service allows to retrieve an Isan registration result from a transaction identifier.
92/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: The selected transaction must have a “finished” status Response:
Parameter name (type) Description
Tr_Isan_Type tr_isan Contains the Isan number : result of a registration The work status is describes in the result field.
Errors: If an error occurs, refers to the error code result of the transaction. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getIsanTResultElement xmlns="http://org/isan/TransactionManagementWS.wsdl/types/"> <SessionKey>04B91C0CC45C04B98A3ECC5019448EA2</SessionKey> <TransactionId>6526C193A51C84215C6B2B47D78AB27D</TransactionId> </getIsanTResultElement> </soap:Body>
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
10.5 WS-TR05: RETRIEVE THE ISAN METADATA
Name of the service:getIsanMetadataTResult This service allows to retrieve Isan Metadata values from a transaction identifier. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: The selected transaction must have a “finished” status Response:
Parameter name (type) Description
Tr_IsanMetadata_Type tr_IsanMetadata
The metadata retrieved associated to a transaction result. To get the work status, refer to the transactionResult field.
Errors: If an error occurs, the field IsanMetadata will be null, and the transactionResult field will contain the error code of the transaction. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getIsanMetadataTResultElement xmlns="http://org/isan/TransactionManagementWS.wsdl/types/"> <SessionKey>1214DCAABF5FD65948118DA17BD5DDDD</SessionKey> <TransactionId>7A159AA1615E1CC045B3A66C11AF3068</TransactionId> </getIsanMetadataTResultElement> </soap:Body> </soap:Envelope>
94/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
List of In-dev retrieved. Each row contains set of (TransactionResult, SumIsanMetadata).
Errors: If an error occurs, the list will only contain one item with a transactionResult containing the error code, and a sumIsanMetadata which is null. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getIndevWorkListTResultElement xmlns="http://org/isan/TransactionListManagementWS.wsdl/types/"> <sessionKey>9E9DC748944A8BE67EDDD41B28304143 </sessionKey> <transactionId>SRIip45784</transactionId> </getIndevWorkListTResultElement> </soap:Body> </soap:Envelope>
Name of the service:getSerialHeaderListTResult This service allows to retrieve a list of serialHeader after a Serial Header search. (Cf. WS-QM03 : Search Serial Header (by Title). Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
98/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Conditions: The selected transaction must have a finished status. Response:
List of serial headers retrieved. Each row contains set of (TransactionResult, SumIsanMetadata).
Errors: If an error occurs, the list will only contain one item with a transactionResult containing the error code, and a sumIsanMetadata which is null. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getSerialHeaderListTResultElement xmlns="http://org/isan/TransactionListManagementWS.wsdl/types/"> <SessionKey>447CAD8051C8DD2BAC0D51290F04E6E4</SessionKey> <TransactionId>970890AE90728F769F63A4447BD66A84</TransactionId> </getSerialHeaderListTResultElement> </soap:Body> </soap:Envelope>
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
<TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Dark Realm - Yr1 00/01</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail /> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>636B92E087D579DE26DDB1E3DBD53A34</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Tales From the Dark Side - Yr1 84/85</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail /> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>E01CB83A1EF70B9CFCE8A4CAFE32990D</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> </Resultlist> </Result> </getSerialHeaderListTResultResponseElement> </env:Body> </env:Envelope>
101/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
10.8 WS-TR08: RETRIEVE THE CLIENT INFORMATION RESULT
Name of the service:getClientTResult This service allows to retrieve information associated to a client from a transaction identifier. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: The selected transaction must have a finished status Response:
Parameter name (type) Description
Tr_IsanClient_Type tr_client The metadata retrieved associated to a transaction result.
Errors: If an error occurs, the field IsanClient will be null, and the transactionResult field will contain the error code of the transaction. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
<country>
<CountryCodeISO3166_1>FR</CountryCodeISO3166_1>
<Label>France</Label>
</country>
</Address>
<PhoneList>
<Phone>
<PhoneType>PHT4</PhoneType>
<PhonePrefix>+33</PhonePrefix>
<PhoneNumber>01 43 46 20 77</PhoneNumber>
</Phone>
<Phone>
<PhoneType>PHT2</PhoneType>
<PhonePrefix>+33</PhonePrefix>
<PhoneNumber>01 43 46 24 89</PhoneNumber>
</Phone>
</PhoneList>
</Contact>
</Contacts>
<Created>2005-04-19T19:31:11+02:00</Created>
<Modified>2007-09-14T16:48:17+02:00</Modified>
</client>
</result>
</getclienttresultResponseElement>
</env:Body>
</env:Envelope>
10.9 WS-TR09: RETRIEVE A LIST OF CLIENTS.
Name of the service:getClientsListTResult This service allows to retrieve a list of clients. (Cf. WS-CM03: Display the list of Clients). Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: The selected transaction must have a finished status. Response:
Parameter name (type) Description
RES_TRSumClientList_Type resultList
List of clients retrieved. Each row contains set of (TransactionResult, SumClient).
Errors:
105/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
If an error occurs, the list will only contain one item with a transactionResult containing the error code, and a sumClient which is null. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
<TransactionResult>ACTIVEClient: The client is active</TransactionResult>
<TransactionCode>S022</TransactionCode>
</TransactionResult>
<SumClient>
<Type>REG</Type>
<UserNamePrefix>pro001470</UserNamePrefix>
<Status>ACT</Status>
<Name> LITTLE BEAR </Name>
</SumClient>
</TRSumClient>
</resultlist>
</result>
</getclientslisttresultResponseElement>
</env:Body>
</env:Envelope>
10.10 WS-TR10: RETRIEVE A LIST OF PARTICIPANTS.
Name of the service:getParticipantListTResult This service allows to retrieve a list of Participants after a search for participants. (Cf. WS-TH01: Search for Participant) Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: The selected transaction must have a finished status. Response:
List of participants retrieved. Each row contains set of (TransactionResult, IsanRefParticipant).
Errors: If an error occurs, the list will only contain one item with a TransactionResult containing the error code, and an IsanRefParticipant which is null. SOAP Message Structure:
107/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
List of production companies retrieved. Each row contains set of (TransactionResult, IsanReferenceCompany).
Errors: If an error occurs, the list will only contain one item with a transactionResult containing the error code, and an IsanReferenceCompany which is null. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getProdCompanyListTResultElement xmlns="http://org/isan/TransactionListManagementWS.wsdl/types/"> <sessionKey>9E9DC748944A8BE67EDDD41B28304143 </sessionKey> <transactionId>DBCB17380C642C3BD8EC5A537D93BA11 </transactionId> </getProdCompanyListTResultElement> </soap:Body> </soap:Envelope>
List of works retrieved. Each row contains set of (TransactionResult, SumIsanMetadata).
Errors: If an error occurs, the list will only contain one item with a transactionResult containing the error code, and a sumIsanMetadata which is null. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?>
111/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
Response <?xml version="1.0" encoding="utf-16"?> <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns0="http://org/isan/TransactionListManagementWS.wsdl/types/"> <env:Body> <getIsanWorkListTResultResponseElement> <Result> <Resultlist> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Amici per la pelle</Title> <LanguageCodeISO639_2> <CodeISO639_2>ITA</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ALTERNATE</TitleKind> </TitleDetail> <TitleDetail> <Title>2 amis pour la vie</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>6E01B767177D9D146FE2C0291E46509D</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Amis et ennemis</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ALTERNATE</TitleKind> </TitleDetail> <TitleDetail> <Title>Friends and enemies</Title>
112/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
<LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>DF0FA73F17E86725CDC33E7B0836A5C9</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>With friends like these</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ALTERNATE</TitleKind> </TitleDetail> <TitleDetail> <Title>On a tres peu d'amis</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>B561835BA3397F226BEEFE13BE307999</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> </Resultlist> </Result> </getIsanWorkListTResultResponseElement> </env:Body> </env:Envelope>
10.13 WS-TR13: RETRIEVE A LIST OF SERIAL EPISODES.
Name of the service:getSerialEpisodeListTResult This service allows to retrieve a list of serial episodes (Cf.WS-WM09: List Episodes for a Serial). Input Parameters:
Parameter name (type) Description Conditions Mandatory
113/137
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String transactionId The transaction identifier Yes
Conditions: The selected transaction must have a finished status. Response:
List of episodes retrieved. Each row contains set of (TransactionResult, SumIsanMetadata).
Errors: If an error occurs, the list will only contain one item with a transactionResult containing the error code, and a sumIsanMetadata which is null. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getSerialEpisodeListTResultElement xmlns="http://org/isan/TransactionListManagementWS.wsdl/types/"> <SessionKey>7949872F4AB94B95711DD694AAE5B27D</SessionKey> <TransactionId>8A1613FEEA17641DEFAFA8643162CDA9</TransactionId> </getSerialEpisodeListTResultElement> </soap:Body> </soap:Envelope>
10.14 WS-TR14: GET THE STATUS OF A WORK FROM THE REGISTRANT IDENTIFIER
This following service concern any registration where the final status (Pending or Active) has not been returned and the transaction ID has expired. Considering that the transaction is not yet available, it’s not possible to use the services from WS-TR01 to WS-TR10. Web Service Access:
ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013
ISAN API: SOAP Web Services
Name of the service:getStatusFromRegPk
This service allows to check the status of a registration from its registrant identifier , when its transaction has expired. Input Parameters:
Parameter name (type) Description Conditions Mandatory
String sessionKey Session key registered in DB and which is valid for a given period of time.
Yes
String registrantID The registrant identifier Yes
Conditions: The registrant identifier must exist. Response:
Parameter name (type) Description
Tr_Isan_Type tr_isan Contains the Isan number : result of a registration The work status is describes in the result field.
Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <getStatusFromRegpkElement xmlns="http://org/isan/check/CheckWorkStatus.wsdl/types/"> <SessionKey>ECE8F620E1D81527D287F5819E827ECA</SessionKey> <RegistrantID>78</RegistrantID> </getStatusFromRegpkElement> </soap:Body> </soap:Envelope>
In order to maintain quality and consistency of descriptive information, the following rules apply when completing applications for ISAN allocation.
ENTERING TITLES
Titles shall not be written with the particle at the end: “Godfather, the” is not correct.
A Title should be formatted in mixed case (e.g. not UPPERCASE only), conforming with the style as it appears on the audiovisual work (including correct use of any numbers, without abbreviations, etc.).
For example, “Strictly Business” is correct – all other variants or forms should be considered incorrect.
ENTERING NAMES
Stage Names
When entering “Stage Names” (for example, Cher or Cedric the Entertainer), leave First Name field blank, and enter the stage name in full under Last Name field.
Middle Names
In the case where a middle name is applicable, it should be written in the First Name field.
Last Names
No Last Name can be accepted with only one (1) letter.
“None” or similar misleading information cannot be considered as a valid entry.
PRODUCTION COMPANIES – NOT MANDATORY DESCRIPTIVE INFORMATION
If a producer works for a production company, then the producer name goes under “participants” and the production company name goes under “production companies”. There may be cases where an individual (producer) is not attached to a company. Should it be very important for the Registrant to have that information, then the name of the individual should be entered in the Production Company field as well as the Participant field.
E932 IsWorkSerialValueException: IsWorkSerial Tag has an incorrect value.
E933 IsWorkSilentValueException: IsWorkSilent Tag has an incorrect value.
E934 IsWorkColorValueException: IsWorkColor Tag has an incorrect value.
E935 IsWorkCoproductionException: IsWorkCoproduction Tag has an incorrect value.
E936 IsWorkCompositeValueException: IsWorkComposite Tag has an incorrect value.
E937 WorkKindValueException: WorkKind Tag has an incorrect value.
E938 WorkTypeValueException: WorkType Tag has an incorrect value.
E939 WorkYearOfReferenceException: WorkYearOfReference Tag has an incorrect value. It should be greater than 1897 and lower than current year +1
E940 WorkYearOfFirstPubException:WorkYearOfFirstPublication Tag has an incorrect value. It should be greater than the year of reference and lower than current year +1
E941 TimeUnitException: TimeUnit in RunningTime element has an incorrect value. It should be either MIN or SEC
E942 TimeValueException: TimeValue in RunningTime element has an incorrect value. It should be a positive integer
E943 ExternalIdListIsNullException: ExternalIdList element should have at least one ExternalId element.
E944 ExternalIdValueException: Id in ExternalId element has an incorrect value.
E945 ExternalIdTypeException: Type in ExternalId element has an incorrect value. It should be either REGID or AGICOA.
E946 TooREGIDFoundException: you should have only one ExternalId element with type REGID in the ExternalIdList.
E947 TooAgicoaNumberFoundException: you should have only one ExternalId element with type AGICOA in the ExternalIdList.
E948 SerialHeaderIDsException: In EpisodeDetail element, you should provide at least one identifier : SerialHeaderRegistrantID or SerialHeaderID.
E949 SerialHeaderRegIDException: SerialHeaderRegistrantID in EpisodeDetail element provided has an incorrect value
E950 SerialHeaderIDException: SerialHeaderID in EpisodeDetail element provided has an incorrect value
E951 EpisodeNumberException: Episode in EpisodeDetail element provided has an incorrect value.
E952 SeasonNumberException: Episode in EpisodeDetail element provided has an incorrect value.
E953 EpisodeDetailException: EpisodeDetailElement should not be provided in this case. Check IsWorkSerial element: should be SE
E954 EpisodeDetailNullException: Work is a Serial the EpisodeDetail Element should be provided.
E955 LanguageListIsNullException: LanguageList Element can't be null, at least one Language should be provided.
E956 CodeISO639_2Exception: LanguageCodeISO639 Element has an incorrect value. It should have an ISO 639_2 code value.
E957 TitleListIsNullException: TitleList can' be null. It should have at least one TitleDetail element.
E958 OriginalTitleNotFoundException: At least one Original Title should be declared.
E959 TitleKindValueException: TitleKind in TitleDetail Element, has an incorrect value. It should be ALTERNATE or ORIGINAL.
E960 TitleTooLongException: Title in TitleDetail Element is too long, it can't have more then 200 characters.
E961 ParticipantListIsNullException: ParticipantList can be null, At least one Participant should be provided.
E962 ParticipantRoleCodeException: ParticipantRoleCode has an incorrect value.
E963 ParticipantFirstNameException: ParticipantFirstName is too long, it can't have more than 50 characters.
E964 ParticipantLastNameException: ParticipantLastName is too long, it can't have more than 50 characters.
E965 DirectorIsMissingException: ParticipantList element should have at least one Director Participant.
E966 CompanyListException: In case of Coproduction, at least 2 companies should be provided in CompanyList element.
E967 CompositeIsanListException: In case of Composite Work, at least 1 CompositeIsan should be provided in CompositeIsanList element.
E968 NotACompositeWorkException: Work is not a CompositeWork but a CompositeIsanList is provided, please check IsWorkComposite element.
E969 TitleValueException: Title in TitleDetail element has an incorrect value.
E970 CompanyNameValueException: Company Name in Company element has an incorrect value.
E971 PartLastNameIsMissingException: Particant LastName should be provided in ParticipantList element.
E972 RegistrantPKValueException: The Id value for the ExternalId element of type REGID is incorrect.
E979 WorkIsNullException: Work Metadata can't be null. This operation is discarded.
E980 NoREGIDFoundException: Your work can't be perform this operation without a registrant identifier. Please add An ExternalId element of type "REGID" in ExternalIdList.
E983 SerialHeaderNotFoundException: Serial Header not found. Please check EpisodeDetail data.
E986 CompanyListCountException: Work is not a coproduction, CompanyList should have only 1 Company element. Please check IsWorkCoproduction tag.
E987 DuplicateCompaniesException: One or more duplicates CompanyNames have been found in CompanyList.
E988 DuplicateTitleException: The same Title can't be declared several times in the same language. Please check TitleList element.
E989 DuplicateParticipantException: A Participant can't be declared several times with same names and types. Please check ParticipantList element.
E990 SerialWorkTypeException: It is not allowed to create an ISAN episode with the provided work type.
E917 WorkNotFoundException: Please check the Isan number
E984 WorkIsASerialHeaderException: This service is only valid for Episode or Single Works. Please use getSerialHeaderMetadata instead of getIsanMetadata.
E985 WorkIsSingleORSEException: This service is only valid for Serial Header Works. Please use getIsanMetadata instead of getSerialHeaderMetadata.
S002 InactiveISAN: The ISAN number has been inactivated
S003 BillableISAN: One work retrieved to be billed : Do you wish to continue anyway ?
S004 The ISAN number has a pending status
S005 IndevISAN:The Work is in development
S006 ActiveISAN:The ISAN number is active
S017 BillableInactiveISAN:The ISAN number has been inactivated. The work retrieved is billable.
S018 BillableIndevISAN:The Work retrieved is in development and is billable.
S046 BillablePendingSH:The SH Work retrieved doesn't have any episodes and is billable.
SEARCH WORKS LIST
CODE DESCRIPTION
E704 SearchParametersException: Parameter(s) is/are too short. (at least 3 characters).
E705 NoGroupFoundException: No group found for this client.
E706 SearchScopeException: Scope search is incorrect.
E930 SearchWorksException: An unexpected error occured during the search
S007 Your search has been successfully done
CLIENTS MANAGEMENT
CODE DESCRIPTION
E855 CityAddressException: City is compulsory.
E856 ZipAddressException: Zip code is compulsory.
E857 StreetAddressException: Street address is compulsory.
E858 ClientUpdateException: An unexpected error occurred during updateClient service. Please send this error to [email protected].
E859 MainContactEmailException: Email Address should be provided when Contact Kind is MAIN.
E860 IdentifiersException: Identifiers field has an incorrect value. UserNamePrefix is mandatory.
E863 SetClientBlockStatusException: An unexpected error occurred during SetClientBlockStatus operation.
E864 GetClientInformationException: An unexpected error occurred during getClientInformation operation.
E865 GroupNotFoundException: Group not found, please check the group identifier.
E866 DisplayContactInGroupException: DisplayContactInGroup field has an incorrect value, it should be YES or NO.
E867 ClientActivationException: An unexpected error occurred during activation.
E868 UserNamePrefixException: UserNamePrefix is malformed, should contain between 5 and 10 characters.
E869 UpdClientRegCheckException: An unexpected error occurred while updating client registration check
E870 ClientRegCheckStatusException: Client can't be activated without specifying a Registration Check. See RegCheck field in ClientCheck element
E871 ChangeUserPwdException: An unexpected error occurred during ChangeClientPassword operation.
E871 ClientCreationException: An unexpected error occurred during createClient service. Please send this error to [email protected].
E872 ClientIsNullException: Client element should not be null. Can't perform this operation.
E873 SpokenLanguageException: SpokenLanguage element should not be null. Please fill in the language code.
E874 CoraDataException: CoraData element should not be null. ClientType and SpokenLanguage are mandatories.
E875 TooManyREGContactsException: Client should not have more than one Registration Contact.
E876 TooManyBILLContactsException: Client should not have more than one Billing Contact.
E877 TooManyMAINContactsException: Client should not have more than one Main Contact.
E878 TooManyOFFContactsException: Client should not have more than one Official Contact.
E879 MainContactNotFoundException: Contacts list should contain a Main Contact (A Contact element with ContactKind field set to MAIN).
E880 OffContactNotFoundException: Contacts list should contain an Official Contact (A Contact element with ContactKind field set to OFF).
E881 ContactsExceptions: Contacts list should contain between 2 and 4 Contact elements.
E882 BIL_REG_PhoneListException: Billing or Registration Contact should have 0 to 3 PhoneNumbers.
E883 MAIN_PhoneListException: Main Contact should have at least 1 PhoneNumber and 3 PhoneNumbers maximum
E884 OFF_PhoneListException: Official Contact should have at least 1 PhoneNumber and 2 PhoneNumbers maximum
E885 PhoneNumberException: The format of the PhoneNumber is incorrect.
E886 PhoneTypeException: a PhoneType field has an incorrect value. It should be PHT1 (General), PHT2(Fax), PHT3(Mobile) or PHT4(Direct)
E887 CodeISO3166_1Exception: CodeISO3166_1 has an incorrect value. It should be an ISO 3166-1 code.
E888 AddressTypeException: An AddressType field is incorrect. It should be PHY (Physical), or BIL (Billing).
E890 ContactLastNameNullException: LastName should not be null when ContactType is Individual
E891 ContactFirstNameNullException:Main Contact should have a FirstName.
E892 ContacKindException:ContactKind field in Contact element, has an incorrect value, it should be BIL (Billing), MAI (Main), OFF(Official), PUB(Public), REG(Registration).
E893 ContactTypeException: ContactType field in Contact element, has an incorrect value, it should be IND (individual) or LEG(Legal).
E894 ClientTypeException: ClientType field in CoreData element, has an incorrect value, it should be either REG (Registrant) or REA(Reader).
E895 ClientCheckStatusException: The Status field is incorrect, it should be ACT (Active),INA (Inactive),PEN(Pending), or REF(Refused)
E896 RCCommentTooLongException: RegCheckComment is too long; it should not contain more than 500 characters.
E897 RCCommentMissingException: RegCheckComment field is compulsory when RegCheck is set to RC4 (Other).