ISAN API: SOAP Web Services4/137 ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013 ISAN...

.

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


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


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.


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


14/09/2007 2.2 Update the Client type and add the Web Service “setClientRegistrationCheck” Second Publication


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


15/11/2013 2.3 Add “deprecated” watermark. ISAN API users are invited to use the ISAN API RESTful web services.

3/137



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



4.7 Tr_IsanReferenceCompanyList_Type 24

4.8 Client_type 25

4.9 Tr_Client_Type 27

4.10 Tr_Sum_ClientList_Type 27

4.11 Sum_Client_Type 27

5 ISAN REGISTRATION ___________________________________________________________________ 28

5.1 WS-WM01: Register a single work 28

5.2 WS-WM02: Update a Single Work 31

5.3 WS-WM03: Register Serial Header 33

5.4 WS-WM04: Update Serial Header 35

5.5 WS-WM05: Register Episode 37

5.6 WS-WM06: Update Episode 40

5.7 WS-WM07: Get ISAN Metadata 43

5.8 WS-WM08: Get Serial Header Metadata 44

5.9 WS-WM09: List Episodes for a Serial 46

6 ISAN IN-DEV MANAGEMENT _____________________________________________________________ 48

6.1 WS-IM01: Register an In-dev ISAN for a Single Work 48

6.2 WS-IM02: Update Single In-dev Work 49

6.3 WS-IM03: Register an In-dev ISAN for an Episode 52

6.4 WS-IM04: Update In-dev Episode 53

6.5 WS-IM05: List In-dev ISAN 56

6.6 WS-IM06: Get ISAN In-dev Metadata 57

6.7 WS-IM07: Activate In-dev Works 59

7 CLIENT MANAGEMENT __________________________________________________________________ 61

7.1 WS-CM01: Create a new Client 61

7.2 WS-CM02: Update a Client 65

7.3 WS-CM03: Display the list of Clients 68

7.4 WS-CM04: Get Client information 70

7.5 WS-CM05: Activate/Desactivate Client 71

7.6 WS-CM06: Block/Unblock a Client 72

7.7 WS-CM07: Change a client’s Password 74

7.8 WS-CM08: Set client registration check 75

5/137



8 QUERY MANAGEMENT __________________________________________________________________ 78

8.1 WS-QM01: Search from work info 78

8.2 WS-QM02: Search ISAN From Title 80

8.3 WS-QM03 : Search Serial Header (by Title) 82

9 THESAURUS MANAGEMENT _____________________________________________________________ 84

9.1 WS-TH01: Search for Participant 84

9.2 WS-TH02: Search for Production Company 86

10 TRANSACTION RESULTS MANAGEMENT __________________________________________________ 88

10.1 WS-TR01: Get the status of a transaction 88

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



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



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



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



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



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



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


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



2.4 CLIENT MANAGEMENT

2.5 QUERY MANAGEMENT

2.6 TRANSACTION RESULT MANAGEMENT


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


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


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-TR05 getIsanMetadataTResult Retrieve ISAN Metadata values 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



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



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:

getSessionKey

getSessionKeyOnBehalf

checkSessionKey Web Service access:

Test Server

WSDL Address http://webservices.test.isan.org/Session/1.1/SessionServiceSoapHttpPort?WSDL

List of operations http://webservices.test.isan.org/Session/1.1/SessionServiceSoapHttpPort

3.1 WS-ID01: GET THE SESSION KEY

Name of the service: getSessionKey

Parameters:

Parameter name (type) Description Mandatory

String Login User’s name YES

String Password User’s password YES

http://webservices.test.isan.org/Session/1.1/SessionServiceSoapHttpPort?WSDL

http://webservices.test.isan.org/Session/1.1/SessionServiceSoapHttpPort

15/137



Response:

Parameter name (type) Description

String sessionKey Session key registered in DB and which is valid for a given period of time.

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.

SOAP Message Structure: Request <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body xmlns:ns1="http://www.isan.org/ISAN/Session.wsdl"> <ns1:getSessionKeyElement> <ns1:Login> xxxxx </ns1:Login> <ns1:Password> yyyyy </ns1:Password> </ns1:getSessionKeyElement> </soap:Body> </soap:Envelope>

Response <?xml version="1.0" encoding="UTF-8"?> <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://www.isan.org/ISAN/Session.wsdl">

<env:Body> <getSessionKeyResponseElement>

<result> C4F8CF7D4F3642AC66C01A0000A8B9D0 </result> </getSessionKeyResponseElement> </env:Body> </env:Envelope>

16/137



3.2 WS-ID02: GET THE SESSION KEY ON BEHALF OF A REGISTRANT

Name of the service: getSessionKeyOnBehalf This service allows an RA to log in on behalf of one of the RA’s client. Parameters:

Parameter name (type) Description Mandatory

String RALogin RA User name

YES

String RAPassword RA User password YES

String RegistrantOnBehalfLogin User name of the client to log on behalf (e.g: myclient.update) YES

Response:







SOAP Message Structure (example): Request <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body xmlns:ns1="http://www.isan.org/wsdl/Session/1.1/SessionService.wsdl"> <ns1:getSessionKeyOnbehalfElement> <ns1:RALogin> xxxxx </ns1:RALogin> <ns1:RAPassword> xxxxx </ns1:RAPassword> <ns1:RegistrantOnBehalfLogin> xxxxx </ns1:RegistrantOnBehalfLogin> </ns1:getSessionKeyOnbehalfElement> </soap:Body> </soap:Envelope>

17/137



Response <?xml version="1.0" encoding="UTF-8"?> <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://www.isan.org/wsdl/Session/1.1/SessionService.wsdl"> <env:Body>

<getSessionKeyOnbehalfResponseElement> <result> 9E9DC748944A8BE67EDDD41B28304143 </result>

</getSessionKeyOnbehalfResponseElement> </env:Body>

</env:Envelope>

3.3 WS-ID03: CHECK THE SESSION KEY

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:


String result 0: the session key is not active. 1: the session key is still active.





18/137



SOAP Message Structure: Request <? xml version="1.0" encoding="utf-8"?> <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> < checksessionkeyElement xmlns="http://www.isan.org/wsdl/Session/1.1/SessionService.wsdl/types/"> <sessionKey>45877C3BE6EC235C408A48C34594E4A</sessionKey> </checksessionkeyElement> </soap:Body> </soap:Envelope>

Response <?xml version="1.0" encoding="utf-8"?> < soap:Envelope xmlns:soap="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://www.isan.org/wsdl/Session/1.1/SessionService.wsdl/types/"> < soap:Body> <checksessionkeyResponseElement> <result>0</result> </checksessionkeyResponseElement> </ soap:Body> </ soap:Envelope>

http://schemas.xmlsoap.org/soap/envelope/

19/137



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



(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



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-


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-


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



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)


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


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



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)


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


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



4.6 TR_ISANREFPARTICIPANTLIST_TYPE

This is the type of result returned after a search by Participant (See WS-TH01: Search for Participant)


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



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

CoreData Information about the client

ClientType, SpokenLanguage, Rafields attributes Section

N/A

1

ClientType Client type

REG: The client is a Registrant (Can register AV works for ISANs) String

3

1

REA: The client is a Reader (Can only perform queries)

SpokenLanguage The language for all notifications that the system sends automatically to the client.

LanguageCodeISO639_2 attributes

Section

N/A 1

LangueCodeISO639_2 Language code ISO639_2 Language code (See the list of codes in Annex B) String 3 1

RegistrationAgency Registration Agency information RAName, RAFields, Sub-

Section N/A 0 or 1

RAName Name of the registration agency to be invoiced

Free text Read Only field.

String

100 1

RAFields A list of RA Specific Content. List of Rafield attributes Sub-

Section N/A 0 or 1

RAField Comment about the client Free Text String 200 1 to 3

Contacts A list of Contacts

List of Contact attributes. Section

N/A

2 to 4

Contact Contact Information ContactType, ContactKind, LastName, FirstName, Name, Acronym, Email, JobTitle, Address, PhoneList attributes

Sub Section

N/A N/A

http://www.isan.org/ISAN/Docs/isan-client_2.0.xsd.html#type_RegCheckCommentType

http://www.isan.org/ISAN/Docs/isan-client_2.0.xsd.html#type_RegistrationAgencyType

http://www.isan.org/ISAN/Docs/isan-client_2.0.xsd.html#type_RegistrationAgencyType

26/137



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



4.9 TR_CLIENT_TYPE

This is the type of result returned for WS-TR08 (getClientTResult).


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)


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


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



5 ISAN Registration

Web Service Access:

Test Server

WSDL Address http://webservices.test.isan.org/WorksServices/IsanWorksManagement/2.0/IsanWorksManagementWSSoapHttpPort?WSDL

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


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:


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.

http://webservices.test.isan.org/WorksServices/IsanWorksManagement/2.0/IsanWorksManagementWSSoapHttpPort?WSDL


http://webservices.test.isan.org/WorksServices/IsanWorksManagement/2.0/IsanWorksManagementWSSoapHttpPort


29/137



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>

<registerSingleWorkElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">

<SessionKey>04B91C0CC45C04B98A3ECC5019448EA2</SessionKey>

<IsanMetadata>

<IsanWork />

<WorkType>FF</WorkType>

<WorkKind>A</WorkKind>

<WorkYearOfReference>1994</WorkYearOfReference>

<WorkYearOfFirstPublication>1994</WorkYearOfFirstPublication>

<IsWorkComposite>YES</IsWorkComposite>

<RunningTime>

<TimeUnit>MIN</TimeUnit>

<TimeValue>89</TimeValue>

</RunningTime>

<IsWorkCoproduction>NO</IsWorkCoproduction>

<IsWorkColor>YES</IsWorkColor>

<IsWorkSilent>NO</IsWorkSilent>

<IsWorkSerial>SW</IsWorkSerial>

<ExternalIdList>

<ExternalId>

<Type>REGID</Type>

<Id>ff456</Id>

</ExternalId>

</ExternalIdList>

<ReferenceCountryList>

<ReferenceCountry>

<CountryCodeISO3166_1>AD</CountryCodeISO3166_1>

<RelatedAction>PRO</RelatedAction>

</ReferenceCountry>

<ReferenceCountry>

<CountryCodeISO3166_1>US</CountryCodeISO3166_1>

<RelatedAction>SHO</RelatedAction>

</ReferenceCountry>

</ReferenceCountryList>

<LanguageList>

<Language>

<LanguageCodeISO639_2>

<CodeISO639_2>ENG</CodeISO639_2>

</LanguageCodeISO639_2>

</Language>

<Language>


<CodeISO639_2>FRE</CodeISO639_2>


</Language>

</LanguageList>

<Titlelist>

<TitleDetail>

<Title>Snark</Title>




<TitleKind>ORIGINAL</TitleKind>

</TitleDetail>

</Titlelist>

<ParticipantList>

<Participant>

<FirstName>Said</FirstName>

<LastName>Diarra</LastName>

<ParticipantRoleCode>DIR</ParticipantRoleCode>

30/137



</Participant>

<Participant>

<FirstName>Arke</FirstName>

<LastName>Soderblom</LastName>

<ParticipantRoleCode>ACT</ParticipantRoleCode>

</Participant>

<Participant>

<FirstName>René</FirstName>

<LastName>Scholten</LastName>


</Participant>

<Participant>

<FirstName>Ruth</FirstName>

<LastName>Hussey</LastName>


</Participant>

</ParticipantList>

<IsanRefParticipantList />

<CompanyList>

<Company>

<CompanyName>Arte France</CompanyName>

</Company>

</CompanyList>

<IsanRefCompanyList />

<CompositeIsanList>

<CompositeIsan>

<IsanWork>0000-0000-06E8-0000-N-0000-0000-5</IsanWork>

</CompositeIsan>

</CompositeIsanList>

</IsanMetadata>

</registerSingleWorkElement>

</soap:Body>

</soap:Envelope>

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/IsanWorksManagementWS.wsdl/types/"> <env:Body> <registerSingleWorkResponseElement> <Result> <TransactionStatus>In Progress</TransactionStatus> <TransactionId>6526C193A51C84215C6B2B47D78AB27D</TransactionId> <TransactionResult>Your ISAN registration has been sent.</TransactionResult> <TransactionCode>P001</TransactionCode> </Result> </registerSingleWorkResponseElement> </env:Body> </env:Envelope>

31/137



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:




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:



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"?>




<soap:Body>

<updateSingleWorkElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">

<SessionKey>04B91C0CC45C04B98A3ECC5019448EA2</SessionKey>

<IsanMetadata>

<IsanWork>0000-0001-F450-0000-5-0000-0000-M</IsanWork>

<WorkType>FF</WorkType>

<WorkKind>A</WorkKind>



32/137




<RunningTime>



</RunningTime>

<IsWorkCoproduction>NO</IsWorkCoproduction>



<IsWorkSerial>SW</IsWorkSerial>

<ExternalIdList>

<ExternalId>

<Type>REGID</Type>

<Id>ff456</Id>

</ExternalId>

</ExternalIdList>


<ReferenceCountry>



</ReferenceCountry>

<ReferenceCountry>

<CountryCodeISO3166_1>US</CountryCodeISO3166_1>

<RelatedAction>SHO</RelatedAction>

</ReferenceCountry>


<LanguageList>

<Language>




</Language>

<Language>




</Language>

<Language>


<CodeISO639_2>SPA</CodeISO639_2>


</Language>

</LanguageList>

<Titlelist>

<TitleDetail>

<Title>Snark</Title>





</TitleDetail>

</Titlelist>

<ParticipantList>

<Participant>

<FirstName>Said</FirstName>

<LastName>Diarra</LastName>


</Participant>

<Participant>

<FirstName>Arke</FirstName>

<LastName>Soderblom</LastName>


</Participant>

<Participant>

<FirstName>René</FirstName>

<LastName>Scholten</LastName>


</Participant>

<Participant>

33/137



<FirstName>Ruth</FirstName>

<LastName>Hussey</LastName>


</Participant>

</ParticipantList>

<IsanRefParticipantList />

<CompanyList>

<Company>

<CompanyName>Arte France</CompanyName>

</Company>

</CompanyList>


<CompositeIsanList>

<CompositeIsan>


</CompositeIsan>


</IsanMetadata>

</updateSingleWorkElement>

</soap:Body>

</soap:Envelope>

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/IsanWorksManagementWS.wsdl/types/">

<env:Body>

<updateSingleWorkResponseElement>

<Result>

<TransactionStatus>In Progress</TransactionStatus>

<TransactionId>5BFA7271B56AC03BF8C8FDB68458AB09</TransactionId>

<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



Input Parameters:




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:


TransactionResult_Type Call getIsanTResult to get the SerialHeaderId (formatted as an ISAN) that identifies the Serial Header with the transaction result Id.





<soap:Body>

<registerSerialHeaderElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">

<SessionKey>447CAD8051C8DD2BAC0D51290F04E6E4</SessionKey>

<IsanMetadata>

<IsanWork/>

<WorkType/>

<WorkKind/>

<WorkYearOfReference/>

<WorkYearOfFirstPublication/>

<IsWorkComposite/>

<RunningTime/>

<IsWorkCoproduction/>

<IsWorkColor/>

<IsWorkSilent/>

<IsWorkSerial>SH</IsWorkSerial>

<ExternalIdList>

<ExternalId>

<Type>REGID</Type>

<Id>Mys-0</Id>

</ExternalId>

</ExternalIdList>

<ReferenceCountryList/>

<LanguageList/>

<Titlelist>

<TitleDetail>

<Title>Mystère</Title>

35/137







</TitleDetail>

</Titlelist>

<ParticipantList/>

<CompanyList/>


<CompositeIsanList/>

</IsanMetadata>

</registerSerialHeaderElement>

</soap:Body>

</soap:Envelope>





<env:Body>

< registerSerialHeaderResponseElement >

<Result>


<TransactionId> 357D1788081B4540DB05026C4A097783 </TransactionId>

<TransactionResult>Your ISAN registration has been sent.</TransactionResult>


</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:




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).


Yes

Conditions:

36/137



The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. Response:


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.





<soap:Body>

< updateSerialHeaderElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">


<IsanMetadata>

<IsanWork> 0000-0001-F451-0000-A-0000-0000-7 </IsanWork> <WorkType/>

<WorkKind/>

<WorkYearOfReference/>

<WorkYearOfFirstPublication/>

<IsWorkComposite/>

<RunningTime/>

<IsWorkCoproduction/>

<IsWorkColor/>

<IsWorkSilent/>

<IsWorkSerial>SH</IsWorkSerial>

<ExternalIdList>

<ExternalId>

<Type>REGID</Type>

<Id>Mys-0</Id>

</ExternalId>

</ExternalIdList>

<ReferenceCountryList/>

<LanguageList/>

<Titlelist>

<TitleDetail>

<Title>Mystère</Title>





</TitleDetail>

</Titlelist>

<ParticipantList/>

<CompanyList/>


<CompositeIsanList/>

</IsanMetadata>

</ updateSerialHeaderElement >

37/137



</soap:Body>

</soap:Envelope>





<env:Body>

<updateSerialHeaderResponseElement>

<Result>


<TransactionId>5BFA7271B56AC03BF8C8FDB68458AB09</TransactionId>



</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:




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



Response:







<soap:Body>

<registerEpisodeElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">


<IsanMetadata>

<IsanWork />

<WorkType>SE</WorkType>

<WorkKind>L</WorkKind>




<RunningTime>



</RunningTime>

<IsWorkCoproduction>YES</IsWorkCoproduction>



<IsWorkSerial>SE</IsWorkSerial>

<Episodedetail>

<SerialHeaderRegistrantId>Myst-0</SerialHeaderRegistrantId>

<SerialHeaderId />

<Season>1</Season>

<Episode>1</Episode>

</Episodedetail>

<ExternalIdList>

<ExternalId>

<Type>REGID</Type>

<Id>Myst-1</Id>

</ExternalId>

</ExternalIdList>


<ReferenceCountry>



</ReferenceCountry>

<ReferenceCountry>

<CountryCodeISO3166_1>BE</CountryCodeISO3166_1>


</ReferenceCountry>

<ReferenceCountry>

<CountryCodeISO3166_1>SU</CountryCodeISO3166_1>


39/137



</ReferenceCountry>


<LanguageList>

<Language>




</Language>

</LanguageList>

<Titlelist>

<TitleDetail>

<Title>Mystère - Episode 1</Title>





</TitleDetail>

</Titlelist>

<ParticipantList>

<Participant>

<FirstName>Arnaud</FirstName>

<LastName>Binard</LastName>


</Participant>

<Participant>

<FirstName>Babsie</FirstName>

<LastName>Steger</LastName>


</Participant>

<Participant>

<FirstName>Toinette</FirstName>

<LastName>Laquière</LastName>


</Participant>

<Participant>

<FirstName>Didier</FirstName>

<LastName>Albert</LastName>


</Participant>

</ParticipantList>

<CompanyList>

<Company>

<CompanyName>Alma</CompanyName>

</Company>

<Company>

<CompanyName>Tf1</CompanyName>

</Company>

<Company>

<CompanyName>Tsr</CompanyName>

</Company>

</CompanyList>

<CompositeIsanList>

<CompositeIsan>


</CompositeIsan>


</IsanMetadata>

</registerEpisodeElement>

</soap:Body>

</soap:Envelope>

40/137







<env:Body>

<registerEpisodeResponseElement>

<Result>


<TransactionId>F22F28EF3E1A3CD0C1E8BC1C303839E7</TransactionId>

<TransactionResult>Your ISAN registration has been sent.</TransactionResult>


</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:




Yes


Yes

Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The Episode must be in the client’s catalogue. Response:


TransactionResult_Type Result of the current transaction. Call getIsanTResult to get the ISAN number of the updated Episode with the transaction result Id.


41/137







<soap:Body>

<updateEpisodeElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">


<IsanMetadata>

<IsanWork>0000-0001-F451-0001-8-0000-0000-D</IsanWork>

<WorkType>SE</WorkType>

<WorkKind>L</WorkKind>



<IsWorkComposite>NO</IsWorkComposite>

<RunningTime>



</RunningTime>

<IsWorkCoproduction>YES</IsWorkCoproduction>



<IsWorkSerial>SE</IsWorkSerial>

<Episodedetail>

<SerialHeaderRegistrantId>Myst-0</SerialHeaderRegistrantId>

<SerialHeaderId />

<Season>1</Season>

<Episode>1</Episode>

</Episodedetail>

<ExternalIdList>

<ExternalId>

<Type>REGID</Type>

<Id>Myst-1</Id>

</ExternalId>

</ExternalIdList>


<ReferenceCountry>



</ReferenceCountry>

<ReferenceCountry>

<CountryCodeISO3166_1>BE</CountryCodeISO3166_1>


</ReferenceCountry>

<ReferenceCountry>

<CountryCodeISO3166_1>SU</CountryCodeISO3166_1>


</ReferenceCountry>


<LanguageList>

<Language>




</Language>

</LanguageList>

<Titlelist>

<TitleDetail>

<Title>Mystère - Episode 1</Title>




42/137




</TitleDetail>

</Titlelist>

<ParticipantList>

<Participant>

<FirstName>Arnaud</FirstName>

<LastName>Binard</LastName>


</Participant>

<Participant>

<FirstName>Babsie</FirstName>

<LastName>Steger</LastName>


</Participant>

<Participant>

<FirstName>Toinette</FirstName>

<LastName>Laquière</LastName>


</Participant>

<Participant>

<FirstName>Didier</FirstName>

<LastName>Albert</LastName>


</Participant>

</ParticipantList>

<IsanRefParticipantList>

<IsanRefParticipant>

<ParticipantId />

<FirstName />

<LastName />


</IsanRefParticipant>

</IsanRefParticipantList>

<CompanyList>

<Company>

<CompanyName>Alma</CompanyName>

</Company>

<Company>

<CompanyName>Tf1</CompanyName>

</Company>

<Company>

<CompanyName>Tsr</CompanyName>

</Company>

</CompanyList>

<IsanRefCompanyList>

<IsanRefCompany>

<CompanyId />

<CompanyName />

</IsanRefCompany>

</IsanRefCompanyList>

<CompositeIsanList>

<CompositeIsan/>


</IsanMetadata>

</updateEpisodeElement>

</soap:Body>

</soap:Envelope>





<env:Body>

<updateEpisodeResponseElement>

43/137



<Result>


<TransactionId>7516719E593202AF262476C4E2741311</TransactionId>



</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:




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:


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



Request <?xml version="1.0" encoding="utf-16"?>




<soap:Body>

<getIsanMetadataElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">

<SessionKey>1214DCAABF5FD65948118DA17BD5DDDD</SessionKey>

<Isan>0000-0000-12EA-0000-P-0000-0000-0</Isan>

</getIsanMetadataElement>

</soap:Body>

</soap:Envelope>





<env:Body>

<getIsanMetadataResponseElement>

<Result>

<TransactionStatus>Finished</TransactionStatus>

<TransactionId>1C9565ED3FBB05C50554AC3136799F5D </TransactionId>

<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:




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



Response:


TransactionResult_Type Result of the current transaction. Call getIsanMetadataTResult to get the retrieved metadata from the transaction result Id.





<soap:Body>

<getSerialHeaderMetadataElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">

<SessionKey>7949872F4AB94B95711DD694AAE5B27D</SessionKey>

<Isan>0000-0001-F2DB-0000-Q-0000-0000-X</Isan>

</getSerialHeaderMetadataElement>

</soap:Body>

</soap:Envelope>

Response

<?xml version="1.0" encoding="utf-16"?>




<env:Body>

<getSerialHeaderMetadataResponseElement>

<Result>


<TransactionId>6B49CA254128871254AA83BAF06CC7BE</TransactionId>

<TransactionResult>BillableISAN: One work retrieved to be billed : Do you wish to

continue anyway ?</TransactionResult>


</Result>

</getSerialHeaderMetadataResponseElement>

</env:Body>

</env:Envelope>

46/137



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:




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:


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





<soap:Body>

<listSerialEpisodesElement xmlns="http://org/isan/IsanWorksManagementWS.wsdl/types/">

<SessionKey>7949872F4AB94B95711DD694AAE5B27D</SessionKey>

<IsanSerialHeader>0000-0001-F2DB-0000-Q-0000-0000-X</IsanSerialHeader>

</listSerialEpisodesElement>

</soap:Body>

</soap:Envelope>

47/137







<env:Body>

<listSerialEpisodesResponseElement>

<Result>


<TransactionId>118148EEE619FB76EA8A7E2BB3AE787B</TransactionId>

<TransactionResult>4 Works found</TransactionResult>


</Result>

</listSerialEpisodesResponseElement>

</env:Body>

</env:Envelope>

48/137



6 ISAN In-Dev Management

Web Service Access:

Test Server

WSDL Address http://webservices.test.isan.org/WorksServices/IsanWorksManagement/2.0/IsanWorksManagementWSSoapHttpPort?WSDL

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


Yes

Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. A valid purchase order set to “Invoiced” must exist. Response:


TransactionResult_Type Result of the current transaction Call getIsanTResult to get the ISAN number with the transaction result Id.






http://webservices.test.isan.org/WorksServices/IsanWorksManagement/1.0/IsanWorksManagementWSSoapHttpPort?operation=registerIndevIsanSingleWork&bindingPrefix=registerIndevIsanSingleWork&bindingLocalName=&bindingNameSpace=&servicePrefix=&serviceLocalName=IsanWorksManagementWS&serviceNameSpace=http%3A%2F%2Forg%2Fisan%2FIsanWorksManagementWS.wsdl&portPrefix=&portLocalName=IsanWorksManagementWSSoapHttpPort&portNameSpace=http%3A%2F%2Forg%2Fisan%2FIsanWorksManagementWS.wsdl

49/137



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> <tregisterIndevIsanSingleWorkElement> <tsessionKey xsi:type="xsd:tstring">9E9DC748944A8BE67EDDD41B28304143 </tsessionKey ></tregisterIndevIsanSingleWorkElement> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Response <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/IsanWorksManagementWS.wsdl/types/"> <env:Body> <registerIndevIsanSingleWorkResponseElement> <result> <TransactionStatus>0</TransactionStatus> <TransactionId>SRIip45784</TransactionId> <TransactionResult>registerIndevIsanSingleWork</TransactionResult> <TransactionCode>S01</TransactionCode> </result> </registerIndevIsanSingleWorkResponseElement> </env:Body> </env:Envelope>

6.2 WS-IM02: UPDATE SINGLE IN-DEV WORK

Name of the service:updateIndevIsanSingleWork

http://schemas.xmlsoap.org/wsdl/soap/

http://www.w3.org/2001/XMLSchema

50/137



This service allows to update a single Indev work Input Parameters:




Yes

IsanMetadata_Type metadata Metadata to be updated. All metadata defined here will replace the existing metadata.


Yes

Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The indev must be in the client’s catalogue Response:


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:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

<SOAP-ENV:Body>

<tupdateIsanSingleWorkElement>

<tsessionKey xsi:type="xsd:tstring">9E9DC748944A8BE67EDDD41B28304143 </tsessionKey>

<tIsanMetadata>

<tLanguageList>

<tLanguage>

<tLanguageCodeISO639_2>

<tCodeISO639_2 xsi:type="xsd:tstring">FR</tCodeISO639_2>

</tLanguageCodeISO639_2>

http://schemas.xmlsoap.org/soap/encoding/

51/137



</tLanguage>

</tLanguageList>

<tWorkType xsi:type="xsd:tstring">FF</tWorkType>

</tIsanReferenceCompanyList>

<tTitleList>

<tTitleDetail>

<tTitle xsi:type="xsd:tstring">Snark (FRE)</tTitle>


<tCodeISO639_2 xsi:type="xsd:tstring">FRE</tCodeISO639_2>


</tTitleDetail>

</tTitleList>

<tWorkYearOfFirstPublication xsi:type="xsd:tstring">1993</tWorkYearOfFirstPublication>

<tIsWorkCoproduction>NO</tIsWorkCoproduction>

<tRunningTime>

<tTimeUnit>SEC</tTimeUnit>

<tTimeValue xsi:type="xsd:tstring">29</tTimeValue>

</tRunningTime>

<tIsWorkSerial>SI</tIsWorkSerial>

<tIsWorkColor>YES</tIsWorkColor>

<tParticipantList>

<tParticipant>

<tLastName xsi:type="xsd:tstring">Pierre</tLastName>

<tParticipantRoleCode xsi:type="xsd:tstring">DIR</tParticipantRoleCode>

<tFirstName xsi:type="xsd:tstring">Jean</tFirstName>

</tParticipant>

</tParticipantList>

<tWorkYearOfReference xsi:type="xsd:tstring">1994</tWorkYearOfReference>

</tIsanRefParticipantList>

<tReferenceCompanyList>

<tReferenceCompany>

<tCompanyName xsi:type="xsd:tstring">Arte France</tCompanyName>

</tReferenceCompany>

</tReferenceCompanyList>

</tCompositeIsanList>

<tWorkKind xsi:type="xsd:tstring">DO</tWorkKind>

<tReferenceCountryList>

<tReferenceCountry>

<tRelatedAction xsi:type="xsd:tstring">SHO</tRelatedAction>

<tCountryCodeISO3166_1 xsi:type="xsd:tstring">FR</tCountryCodeISO3166_1>

</tReferenceCountry>

</tReferenceCountryList>

<tEpisodeDetail></tEpisodeDetail>

<tIsWorkComposite>NO</tIsWorkComposite>

<tExternalIdList></tExternalIdList>

<tIsanMetadata>

</tupdateIsanSingleWorkElement>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Response <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"



xmlns:ns0="http://org/isan/IsanWorksManagementWS.wsdl/types/">

<env:Body>< updateIsanSingleWorkResponseElement>

<result>

<TransactionStatus>0</TransactionStatus>

<TransactionId>SRIip45784</TransactionId>

<TransactionResult>updateIsanSingleWorkElement </TransactionResult>

52/137




</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:



Yes

String IsanSerialHeader Serial Header ID formatted as an ISAN number Must exist in the database

Yes



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



xmlns:SOAPSDK3=http://schemas.xmlsoap.org/soap/encoding/


53/137














<SOAP-ENV:Body>

<tregisterIndevIsanEpisodeElement>

<sessionKey>9E9DC748944A8BE67EDDD41B28304143 </sessionKey>

<IsanSerialHeader>0000-0001-F36B-0002-E-0000-0000-W</IsanSerialHeader>

</t registerIndevIsanElement>

</SOAP-ENV:Body></SOAP-ENV:Envelope>





<env:Body>< registerIndevIsanElement >

<result>



<TransactionResult> registerIndevIsanElement </TransactionResult>


</result>

</ registerIndevIsanElement >

</env:Body>

</env:Envelope>

6.4 WS-IM04: UPDATE IN-DEV EPISODE

Name of the service:UpdateIsanIndevEpisode This service allows to update an Indev episode. Input Parameters:



See sessionKey definition Yes


Yes

54/137



Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a registrant. The Indev must be part of the client’s catalogue. Response:


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



xmlns:SOAPSDK3=”http://schemas.xmlsoap.org/soap/encoding/”












<SOAP-ENV:Body>

<t updateIndevIsanEpisodeElement > <tsessionKey xsi:type="xsd:tstring">9E9DC748944A8BE67EDDD41B28304143 </tsessionKey>

<tIsanMetadata>

<tLanguageList>

<tLanguage>


<tCodeISO639_2 xsi:type="xsd:tstring">FR</tCodeISO639_2>


</tLanguage>

</tLanguageList>

<tWorkType xsi:type="xsd:tstring">FF</tWorkType>

</tIsanReferenceCompanyList>

<tTitleList>

<tTitleDetail>

<tTitle xsi:type="xsd:tstring">Snark (FRE)</tTitle>


<tCodeISO639_2 xsi:type="xsd:tstring">FRE</tCodeISO639_2>


</tTitleDetail>

</tTitleList>

<tWorkYearOfFirstPublication xsi:type="xsd:tstring">1993</tWorkYearOfFirstPublication>

<tIsWorkCoproduction>NO</tIsWorkCoproduction>

<tRunningTime>

<tTimeUnit>MIN</tTimeUnit>


55/137



<tTimeValue xsi:type="xsd:tstring">29</tTimeValue>

</tRunningTime>

<tIsWorkSerial>SE</tIsWorkSerial>

<tIsWorkColor>YES</tIsWorkColor>

<tParticipantList>

<tParticipant>

<tLastName xsi:type="xsd:tstring">Inconnu</tLastName>

<tParticipantRoleCode xsi:type="xsd:tstring">DIR</tParticipantRoleCode>

<tFirstName xsi:type="xsd:tstring">Inconnu</tFirstName>

</tParticipant>

</tParticipantList>

<tWorkYearOfReference xsi:type="xsd:tstring">1993</tWorkYearOfReference>

</tIsanRefParticipantList>

<tReferenceCompanyList>

<tReferenceCompany>

<tCompanyName xsi:type="xsd:tstring">Arte France</tCompanyName>

</tReferenceCompany>

</tReferenceCompanyList>

</tCompositeIsanList>

<tWorkKind xsi:type="xsd:tstring">DO</tWorkKind>

<tReferenceCountryList>

<tReferenceCountry>

<tRelatedAction xsi:type="xsd:tstring">SHO</tRelatedAction>

<tCountryCodeISO3166_1xsi:type="xsd:tstring">FR</tCountryCodeISO3166_1 >

</tReferenceCountry>

</tReferenceCountryList>

<tEpisodeDetail>

<tSeason xsi:type="xsd:tstring"></tSeason>

</tSerialHeaderRegistrantId xsi:type="xsd:tstring">

<tSerialHeaderId xsi:type="xsd:tstring">0000-0001-F36B-0011-C-0000-0000-1</tSerialHeaderId>

<tEpisode xsi:type="xsd:tstring">11</tEpisode>

</tEpisodeDetail>

<tIsWorkComposite>NO</tIsWorkComposite>

<tExternalIdList></ tExternalIdList>

<tIsanMetadata>

</t updateIndevIsanEpisodeElement> </SOAP-ENV:Body></SOAP-ENV:Envelope>





<env:Body><updateIndevIsanEpisodeResponseElement>

<result>



<TransactionResult>registerEpisode</TransactionResult>


</result>

</updateEpisodeResponseElement>

</env:Body>

</env:Envelope>

56/137



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:




Yes



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>

http://webservices.test.isan.org/WorksServices/IsanWorksManagement/1.0/IsanWorksManagementWSSoapHttpPort?operation=listIndevIsanWorks&bindingPrefix=listIndevIsanWorks&bindingLocalName=&bindingNameSpace=&servicePrefix=&serviceLocalName=IsanWorksManagementWS&serviceNameSpace=http%3A%2F%2Forg%2Fisan%2FIsanWorksManagementWS.wsdl&portPrefix=&portLocalName=IsanWorksManagementWSSoapHttpPort&portNameSpace=http%3A%2F%2Forg%2Fisan%2FIsanWorksManagementWS.wsdl

http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/1.0/TransactionListManagementWSSoapHttpPort?operation=getindevworklisttresult&bindingPrefix=getindevworklisttresult&bindingLocalName=&bindingNameSpace=&servicePrefix=&serviceLocalName=TransactionListManagementWS&serviceNameSpace=http%3A%2F%2Forg%2Fisan%2FTransactionListManagementWS.wsdl&portPrefix=&portLocalName=TransactionListManagementWSSoapHttpPort&portNameSpace=http%3A%2F%2Forg%2Fisan%2FTransactionListManagementWS.wsdl

57/137



<tsessionKey xsi:type="xsd:tstring">9E9DC748944A8BE67EDDD41B28304143 </tsessionKey> </tlistIndevIsanWorksElement> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Response <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/IsanWorksManagementWS.wsdl/types/"> <env:Body> <listIndevIsanWorksResponseElement> <result> <TransactionStatus>0</TransactionStatus> <TransactionId>SRIip45784</TransactionId> <TransactionResult>Call GetIndevWorkListTResult with this transaction id </TransactionResult> <TransactionCode>S01</TransactionCode> </result> </ listIndevIsanWorksResponseElement> </env:Body> </env:Envelope>

6.6 WS-IM06: GET ISAN IN-DEV METADATA

Name of the service: getIndevIsanMetadata

This service allows to get the Indev Metadata for a Single Work or an Episode Input Parameters:



Yes

String isan ISAN number of the indev work 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:


TransactionResult_Type Result of the current transaction Call getIsanMetadataTResult from the transaction id to get the retrieved Isan number.

http://www.w3.org/2001/XMLSchema




http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/1.0/TransactionListManagementWSSoapHttpPort?operation=getindevworklisttresult&bindingPrefix=getindevworklisttresult&bindingLocalName=&bindingNameSpace=&servicePrefix=&serviceLocalName=TransactionListManagementWS&serviceNameSpace=http%3A%2F%2Forg%2Fisan%2FTransactionListManagementWS.wsdl&portPrefix=&portLocalName=TransactionListManagementWSSoapHttpPort&portNameSpace=http%3A%2F%2Forg%2Fisan%2FTransactionListManagementWS.wsdl

58/137



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>

Response <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/IsanWorksManagementWS.wsdl/types/"> <env:Body> <getIndevIsanMetadataResponseElement> <result> <TransactionStatus>1</TransactionStatus> <TransactionId>SRIip45784</TransactionId> <TransactionResult>Call GetIsanMetadataTResult with this transaction id</TransactionResult> <TransactionCode>S03</TransactionCode> </result> </getIndevIsanMetadataResponseElement> </env:Body> </env:Envelope>

59/137



6.7 WS-IM07: ACTIVATE IN-DEV WORKS

Name of the service: activateIndevIsanWork

This service allows to activate an Indev Isan Work. Input Parameters:



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:



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>

http://webservices.test.isan.org/WorksServices/IsanWorksManagement/1.0/IsanWorksManagementWSSoapHttpPort?operation=activateIndevIsanWork&bindingPrefix=activateIndevIsanWork&bindingLocalName=&bindingNameSpace=&servicePrefix=&serviceLocalName=IsanWorksManagementWS&serviceNameSpace=http%3A%2F%2Forg%2Fisan%2FIsanWorksManagementWS.wsdl&portPrefix=&portLocalName=IsanWorksManagementWSSoapHttpPort&portNameSpace=http%3A%2F%2Forg%2Fisan%2FIsanWorksManagementWS.wsdl

60/137



</tactivateIndevIsanWorkElement> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Response <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/IsanWorksManagementWS.wsdl/types/"> <env:Body><activateIndevIsanWorkResponseElement> <result> <TransactionStatus>In Progress</TransactionStatus> <TransactionId>789A660F83728D7F54A68223FB4BBAE2 </TransactionId> <TransactionResult> Your In-Dev Activation request has been sent </TransactionResult> <TransactionCode>P003</TransactionCode> </result> </activateIndevIsanWorkResponseElement> </env:Body> </env:Envelope>

61/137



7 Client Management

Web Service Access:

Test Server

WSDL Address http://webservices.test.isan.org/ClientsServices/2.0/IsanClientsManagementServices?WSDL

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:




Yes

Client_Type The new client to create See Client_Type definition

Yes

Conditions: Only RA users can perform this operation Response:




http://webservices.test.isan.org/ClientsServices/2.0/IsanClientsManagementServices?WSDL

http://webservices.test.isan.org/ClientsServices/2.0/IsanClientsManagementServices

http://webservices.test.isan.org/ClientsServices/2.0/IsanClientsManagementServices?operation=createClient&bindingPrefix=createClient&bindingLocalName=&bindingNameSpace=&servicePrefix=&serviceLocalName=IsanClientsManagementWS&serviceNameSpace=http%3A%2F%2Forg%2Fisan%2Fclient%2FIsanClientsManagementWS.wsdl&portPrefix=&portLocalName=IsanClientsManagementWSSoapHttpPort&portNameSpace=http%3A%2F%2Forg%2Fisan%2Fclient%2FIsanClientsManagementWS.wsdl

62/137







<soap:Body>

<createClientElement xmlns="http://org/isan/client/IsanClientsManagementWS.wsdl/types/">


<client>

<Identifiers>

<ClientId/>

<ClientNumber/>

<ClientGroup />

<UserNamePrefix>pro001129</UserNamePrefix>

</Identifiers>

<ClientCheck/>

<CoreData>

<ClientType>REG</ClientType>

<SpokenLanguage>




</SpokenLanguage>

<RegistrationAgency>

<RAName/>

<RAFields>

<RAField>

<RAField>1129</RAField>

</RAField>

<RAField>

<RAField />

</RAField>

<RAField>

<RAField />

</RAField>

</RAFields>

</RegistrationAgency>

</CoreData>

<Contacts>

<Contact>

<ContactType>LEG</ContactType>

<ContactKind>OFF</ContactKind>

<FirstName />

<LastName />

<Name>GOLMANT</Name>

<Acronym />

<Email />

<JobTitle />

<Address>

<street>3 AVENUE CHARLES DE GAULLE</street>

<zip>94200</zip>

<city>IVRY SUR SEINE</city>

<country>

<CountryCodeISO3166_1>FR</CountryCodeISO3166_1>

<Label>France</Label>

</country>

</Address>

<PhoneList>

<Phone>

<PhoneType>PHT1</PhoneType>

<PhonePrefix>+33</PhonePrefix>

<PhoneNumber>01 42 46 30 00</PhoneNumber>

63/137



</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>

<ContactType>IND</ContactType>

<ContactKind>MAI</ContactKind>

<FirstName>Jean</FirstName>

<LastName>Pinault</LastName>

<Name />

<Acronym />

<Email>[email protected]</Email>

<JobTitle />

<Address />

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>


<ContactKind>REG</ContactKind>



<Name />

<Acronym />

<Email> [email protected] </Email>

<JobTitle />

<Address />

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>


<ContactKind>BIL</ContactKind>



<Name />

<Acronym />


<JobTitle />

<Address>

<street>11 bis rue Jean Gougeon</street>

<zip>75008</zip>

<city>PARIS</city>

<country>

64/137





</country>

</Address>

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

</Contacts>

</client>

</createClientElement>

</soap:Body>

</soap:Envelope>




instance" xmlns:ns0="http://org/isan/client/IsanClientsManagementWS.wsdl/types/">

<env:Body>

<createClientResponseElement>

<result>


<TransactionId>0</TransactionId>

<TransactionResult>Client has been successfully created.</TransactionResult>


</result>

</createClientResponseElement>

</env:Body>

</env:Envelope>

65/137



7.2 WS-CM02: UPDATE A CLIENT

Name of the service: updateClient This service allows to update information of a client Input Parameters:




Yes

Client_Type client Client information to update See Client_Type definition

Yes

Conditions: Only RA users can perform this operation The client must be registered in the RA Response:



Errors: If an error occurred, the transaction result will contain the error code in its “TransactionCode” attribute. SOAP Message Structure: Request





<soap:Body>

<updateClientElement xmlns="http://org/isan/client/IsanClientsManagementWS.wsdl/types/">


<client> <Identifiers>

<ClientId/>

<ClientNumber/>

<ClientGroup />

<UserNamePrefix>deo2345</UserNamePrefix>

</Identifiers>

<ClientCheck/>

66/137



<CoreData>


<SpokenLanguage>




</SpokenLanguage>


<RAName>AGENCE FRANCAISE ISAN</RAName>

<RAFields>

<RAField>


</RAField>

<RAField> created by service web

<RAField />

</RAField>

<RAField>

<RAField />

</RAField>

</RAFields>


</CoreData>

<Contacts>

<Contact>



<FirstName />

<LastName />

<Name>GOLMANT</Name>

<Acronym />

<Email />

<JobTitle />

<Address>


<zip>94200</zip>


<country>



</country>

</Address>

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>





<Name />

<Acronym />


<JobTitle />

<Address />

<PhoneList>

<Phone>



67/137




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>





<Name />

<Acronym />


<JobTitle />

<Address />

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>





<Name />

<Acronym />


<JobTitle />

<Address>


<zip>75008</zip>

<city>PARIS</city>

<country>



</country>

</Address>

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

</Contacts>

</client>

68/137



</updateClientElement>

</soap:Body>

</soap:Envelope>





<env:Body>

<updateClientResponseElement>

<TransactionResult>



<TransactionResult>Client has been successfully updated.</TransactionResult>


</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:




Yes

Conditions: Only RA users can perform this operation Response:


TransactionResult_Type Result of the current transaction Call getClientsListTResult to retrieve a list of Tr_SumClient_type

69/137



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:Body>

<getClientsListElement xmlns="http://org/isan/client/IsanClientsManagementWS.wsdl/types/">


</getClientsListElement>

</soap:Body>

</soap:Envelope>





<env:Body>

<getClientsListResponseElement>

<result>


<TransactionId>6FFBBEE4B4AE9933C86A1522FE85BB21</TransactionId>

<TransactionResult>3 Clients found</TransactionResult>


</result>

</getClientsListResponseElement>

</env:Body>

</env:Envelope>

70/137



7.4 WS-CM04: GET CLIENT INFORMATION

Name of the service: getClientInformation

This service allows to get information associated to a specified client. Input Parameters:



Yes

String clientId Client identifier (userNamePrefix) Yes



TransactionResult_Type Result of the current transaction Call getClientTResult with this transactionId to get the result





<soap:Body>

<getclientinformationElement

xmlns="http://org/isan/client/IsanClientsManagementWS.wsdl/types/">

<SessionKey>AEAA392B5EE18543CA0CD7E298B506BC</SessionKey>

<ClientId>gro002299</ClientId>

</getclientinformationElement>

</soap:Body>

</soap:Envelope>

71/137







<env:Body>

<getclientinformationResponseElement>

<result>


<TransactionId>ABAD677C57B480BE7AF2B3B7F112B2B8</TransactionId>

<TransactionResult>ACTIVEClient: The client is active</TransactionResult>


</result>

</getclientinformationResponseElement>

</env:Body>

</env:Envelope>

7.5 WS-CM05: ACTIVATE/DESACTIVATE CLIENT

Name of the service: setClientActivationStatus

This service allows to activate or desactivate a client. Note that after a client creation you need always to activate the client. Input Parameters:



Yes


String activationStatus The new client status (ACT:active, INA:inactive) Yes




72/137







<soap:Body>

<setclientactivationstatusElement


<SessionKey>AEAA392B5EE18543CA0CD7E298B506BC</SessionKey>

<ClientId>gro001129</ClientId>

<ActivationStatus>ACT</ActivationStatus>

</setclientactivationstatusElement>

</soap:Body>

</soap:Envelope>





<env:Body>

<setclientactivationstatusResponseElement>

<result>



<TransactionResult>Client Status has been successfully updated</TransactionResult>


</result>

</setclientactivationstatusResponseElement>

</env:Body>

</env:Envelope>

7.6 WS-CM06: BLOCK/UNBLOCK A CLIENT

Name of the service: setClientBlockStatus

This service allows to block or unblock a client. Note that after a client creation you need always to unblock the client.

73/137



Input Parameters:



Yes


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








<soap:Body>

<setClientBlockStatusElement



<clientId>gro000912</clientId>

<blockStatus>BLO</blockStatus>

<blockReason>BR1</blockReason>

<blockReasonComment/>

</setClientBlockStatusElement>

</soap:Body>

</soap:Envelope>

74/137







<env:Body>

<setClientBlockStatusResponseElement>

<result>



<TransactionResult>Client Block Status has been successfully

updated</TransactionResult>


</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:



Yes

String login Client login Yes

String oldPassword Old password No

String newPassword New password Yes




75/137







<soap:Body>

<changeClientPasswordElement



<clientId>gro000912.update</clientId>

<oldPassword>dddeer</oldPassword>

<newPassword>sederr487</newPassword>

</changeClientPasswordElement>

</soap:Body>

</soap:Envelope>





<env:Body>

<changeClientPasswordResponseElement>

<result>



<TransactionResult>Password has been successfully changed.</TransactionResult>


</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



Input Parameters:



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








<soap:Body>

<setclientregistrationcheckElement


<SessionKey>B2AAA6D883C727D8DF2A2B1B9BDCEEE6</SessionKey>

<ClientId>tprod01</ClientId>

<RegCheck>RC1</RegCheck>

<RegCheckComment />

</setclientregistrationcheckElement>

</soap:Body>

</soap:Envelope>





77/137



<env:Body>

<setclientregistrationcheckResponseElement>

<result>



<TransactionResult>Client Registration Check has been successfully

updated.</TransactionResult>


</result>

</setclientregistrationcheckResponseElement>

</env:Body>

</env:Envelope>

78/137



8 Query Management

Web Service Access:

Test Server

WSDL Address http://webservices.test.isan.org/WorkServices/QueriesManagement/2.0/QueriesManagementWSSoapHttpPort?WSDL

List of operations http://webservices.test.isan.org/WorkServices/QueriesManagement/2.0/QueriesManagementWSSoapHttpPort

8.1 WS-QM01: SEARCH FROM WORK INFO

Name of the service: SearchIsanByIsanMetadata

This service allows to search for Isan works by Isan metadata arguments. This signature is not definitive and is subject to changes. Input Parameters:



Yes

IsanMetadata_Type Search criteria Yes

Catalogue

Possible values: REGISTRANT RA GROUP ALL

Yes

Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a reader or a registrant.

http://webservices.test.isan.org/WorkServices/QueriesManagement/2.0/QueriesManagementWSSoapHttpPort?WSDL


http://webservices.test.isan.org/WorkServices/QueriesManagement/2.0/QueriesManagementWSSoapHttpPort


79/137



Response:


TransactionResult_Type Result of the current transaction Call getIsanWorksListTResult 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. 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> <searchIsanByIsanMetadataElement xmlns="http://org/isan/QueriesManagementWS.wsdl/types/"> <SessionKey>5E93CF13D0E8E8E4FC8009EBD917407A</SessionKey> <IsanMetadata> <LanguageList> <Language> <LanguageCodeISO639_2> <CodeISO639_2>SPA</CodeISO639_2> </LanguageCodeISO639_2> </Language> </LanguageList> <TitleList> <TitleDetail> <Title>Noche</Title> </TitleDetail> </TitleList> </IsanMetadata> <Catalogue>ALL</Catalogue> </searchIsanByIsanMetadataElement> </soap:Body> </soap:Envelope>

Response <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/QueriesManagementWS.wsdl"> <SOAP-env:Body> <searchIsanByIsanMetadataResponseElement> <result> <TransactionStatus>Finished</TransactionStatus> <TransactionId>9C593050D78E4DF85152F9B79B77BCCE</TransactionId> <TransactionResult>3 Works found</TransactionResult> <TransactionCode>S007</TransactionCode> </result> </searchIsanByIsanMetadataResponseElement> </env:Body> </env:Envelope>

80/137



8.2 WS-QM02: SEARCH ISAN FROM TITLE

Name of the service:SearchIsanByIsanTitle

This service allows to search for Isan works from title

81/137



Input Parameters:



Yes

String title The title to search Yes

Catalogue

Possible values: REGISTRANT RA GROUP ALL

Yes

Conditions: The Client must be ACTIVE, UNBLOCKED and logged in as a reader or a registrant. Response:


TransactionResult_Type Result of the current transaction Call getIsanWorksListTResult 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. 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> <searchIsanByIsanTitleElement> <sessionKey xsi:type="xsd:string">9E9DC748944A8BE67EDDD41B28304143 </sessionKey> <Title xsi:type="xsd:string">Snork</Title> </searchIsanByIsanTitleElement> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

82/137



Response <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/QueriesManagementWS.wsdl"> <env:Body> <searchIsanByIsanTitleResponseElement> <result> <TransactionStatus>Finished</TransactionStatus> <TransactionId>9C593050D78E4DF85152F9B79B77BCCE</TransactionId> <TransactionResult>3 Works found</TransactionResult> <TransactionCode>S007</TransactionCode> </result> </searchIsanByIsanTitleResponseElement> </env:Body> </env:Envelope>

8.3 WS-QM03 : SEARCH SERIAL HEADER (BY TITLE)

Name of the service:searchSerialHeaderByTitle

This service allows to search for a serial header by title Input Parameters:



Yes

String title The title of the serial header to find Yes



TransactionResult_Type Result of the current transaction Call getSerialHeaderListResult to retrieve a list of Tr_SumIsanMetadata

83/137



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>

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/QueriesManagementWS.wsdl/types/"> <env:Body> <searchSerialHeaderByTitleResponseElement> <Result> <TransactionStatus>Finished</TransactionStatus> <TransactionId>970890AE90728F769F63A4447BD66A84</TransactionId> <TransactionResult>6 Works found</TransactionResult> <TransactionCode>S007</TransactionCode> </Result> </searchSerialHeaderByTitleResponseElement> </env:Body> </env:Envelope>

84/137



9 Thesaurus Management

Web Service Access:

Test Server

WSDL Address http://webservices.test.isan.org/WorkServices/QueriesManagement/2.0/QueriesManagementWSSoapHttpPort?WSDL

List of operations http://webservices.test.isan.org/WorkServices/QueriesManagement/2.0/QueriesManagementWSSoapHttpPort

9.1 WS-TH01: SEARCH FOR PARTICIPANT

Name of the service:searchParticipant This service allows to search a participant in the participant list. Input Parameters:



Yes

String participantFirstName Participant first name No

String participantLastName Participant last name Yes



TransactionResult_Type

Result of the current transaction Call getParticipantListTResult to retrieve the list of participant formatted in a

list of Tr_IsanRefParticipant





85/137



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> <searchParticipantElement> <sessionKey xsi:type="xsd:string">9E9DC748944A8BE67EDDD41B28304143</sessionKey> <ParticipantFirstName xsi:type="xsd:string">Jack</ParticipantFirstName> <ParticipantLastName xsi:type="xsd:string">Aaron</ParticipantLastName> </searchParticipantElement> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Response <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/QueriesManagementWS.wsdl"> <env:Body> <searchParticipantResponseElement> <result> <TransactionStatus>Finished</TransactionStatus> <TransactionId>E732A17B04F49BB22E1DFC8352502B92</TransactionId> <TransactionResult> 1 Participants found </TransactionResult> <TransactionCode>S007</TransactionCode> </result> </searchParticipantResponseElement> </env:Body> </env:Envelope>

86/137



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:



Yes

String companyName Name of the company to find Yes



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



<searchProdCompanyElement> <sessionKey xsi:type="xsd:string">9E9DC748944A8BE67EDDD41B28304143</sessionKey> <CompanyName xsi:type="xsd:string">Tf 1</CompanyName> </searchProdCompanyElement> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Response <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/QueriesManagementWS.wsdl"> <env:Body> <searchProdCompanyResponseElement> <result> <TransactionStatus>Finished</TransactionStatus> <TransactionId> DBCB17380C642C3BD8EC5A537D93BA11 </TransactionId> <TransactionResult> 3 Companies found </TransactionResult> <TransactionCode>S007</TransactionCode> </result> </searchProdCompanyResponseElement> </env:Body> </env:Envelope>

88/137



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:



Yes

String transactionId The transaction identifier Yes

Conditions: N/A Response:


String transactionStatus status of the transaction

http://webservices.test.isan.org/WorkServices/TransactionManagementWS/2.0/TransactionManagementWSSoapHttpPort?WSDL

http://webservices.test.isan.org/WorkServices/TransactionManagementWS/2.0/TransactionManagementWSSoapHttpPort?WSDL

http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/2.0/TransactionListManagementWSSoapHttpPort?WSDL

http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/2.0/TransactionListManagementWSSoapHttpPort?WSDL

http://webservices.test.isan.org/WorkServices/TransactionManagementWS/2.0/TransactionManagementWSSoapHttpPort

http://webservices.test.isan.org/WorkServices/TransactionManagementWS/2.0/TransactionManagementWSSoapHttpPort

http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/2.0/TransactionListManagementWSSoapHttpPort

http://webservices.test.isan.org/WorkServices/TransactionListManagementWS/2.0/TransactionListManagementWSSoapHttpPort

89/137



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>

</soap:Envelope>

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/TransactionManagementWS.wsdl/types/"> <env:Body> <getTransactionStatusResponseElement> <Result>Finished</Result> </getTransactionStatusResponseElement> </env:Body>

</env:Envelope>

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:



Yes


Conditions: N/A

90/137



Response:


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>

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/TransactionManagementWS.wsdl/types/"> <env:Body> <getTransactionCodeResponseElement> <Result>S001</Result> </getTransactionCodeResponseElement> </env:Body> </env:Envelope>

10.3 WS-TR03: GET THE NUMBER OF ITEM FOR A TRANSACTION LIST.

Name of the service:getTransactionListCount This service allows to get the total number of items in a transaction list. Input Parameters:



Yes


91/137



Conditions: N/A Response:


String result Contains the number of items in the transaction list.

Errors: 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> <getTransactionListCountElement xmlns="http://org/isan/TransactionListManagementWS.wsdl/types/"> <sessionKey>9E9DC748944A8BE67EDDD41B28304143 </sessionKey>

<transactionId>118148EEE619FB76EA8A7E2BB3AE787B </transactionId>

</getTransactionListCountElement> </soap:Body> </soap:Envelope>

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> <getTransactionListCountResponseElement> <result>4</result> </getTransactionListCountResponseElement> </env:Body> </env:Envelope>

10.4 WS-TR04: RETRIEVE THE ISAN REGISTRATION

Name of the service:getIsanTResult This service allows to retrieve an Isan registration result from a transaction identifier.

92/137



Input Parameters:



Yes


Conditions: The selected transaction must have a “finished” status Response:


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>

</soap:Envelope>

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/TransactionManagementWS.wsdl/types/"> <env:Body> <getIsanTResultResponseElement> <Result> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>6526C193A51C84215C6B2B47D78AB27D</TransactionId> <TransactionResult>ISAN successfully allocated</TransactionResult> <TransactionCode>S001</TransactionCode> </TransactionResult> <IsanWork>0000-0001-F450-0000-5-0000-0000-M</IsanWork> </Result> </getIsanTResultResponseElement> </env:Body>

</env:Envelope>

93/137



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:



Yes


Conditions: The selected transaction must have a “finished” status Response:


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



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/TransactionManagementWS.wsdl/types/"> <env:Body> <getIsanMetadataTResultResponseElement> <Result> <IsanMetadata> <IsanWork>0000-0000-12EA-0000-P-0000-0000-0</IsanWork> <WorkType>FF</WorkType> <WorkKind>L</WorkKind> <WorkYearOfReference>1967</WorkYearOfReference> <WorkYearOfFirstPublication>1967</WorkYearOfFirstPublication> <IsWorkComposite>NO</IsWorkComposite> <RunningTime> <TimeUnit>MIN</TimeUnit> <TimeValue>84</TimeValue> </RunningTime> <IsWorkCoproduction>NO</IsWorkCoproduction> <IsWorkColor>YES</IsWorkColor> <IsWorkSilent>NO</IsWorkSilent> <IsWorkSerial>SW</IsWorkSerial> <Episodedetail /> <ExternalIdList /> <ReferenceCountryList> <ReferenceCountry> <RelatedAction /> <CountryCodeISO3166_1>IT</CountryCodeISO3166_1> </ReferenceCountry> </ReferenceCountryList> <LanguageList> <Language> <LanguageCodeISO639_2> <CodeISO639_2>ITA</CodeISO639_2> </LanguageCodeISO639_2> </Language> </LanguageList> <TitleList> <TitleDetail> <Title>Due once di piombo</Title> <LanguageCodeISO639_2> <CodeISO639_2>ITA</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail> <Title>Jonny madock</Title> <LanguageCodeISO639_2> <CodeISO639_2>GER</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ALTERNATE</TitleKind> </TitleDetail> </TitleList> <ParticipantList> <Participant> <FirstName>Maurizio</FirstName> <LastName>Lucidi</LastName> <ParticipantRoleCode>DIR</ParticipantRoleCode> </Participant> <Participant> <FirstName>Lucia</FirstName> <LastName>Modugno</LastName> <ParticipantRoleCode>ACT</ParticipantRoleCode>

95/137



</Participant> <Participant> <FirstName>Peter</FirstName> <LastName>Carsten</LastName> <ParticipantRoleCode>ACT</ParticipantRoleCode> </Participant> <Participant> <FirstName>Norman</FirstName> <LastName>Clark</LastName> <ParticipantRoleCode>ACT</ParticipantRoleCode> </Participant> <Participant> <FirstName>Robert</FirstName> <LastName>Woods</LastName> <ParticipantRoleCode>ACT</ParticipantRoleCode> </Participant> <Participant> <FirstName>Kristine</FirstName> <LastName>Josani</LastName> <ParticipantRoleCode>ACT</ParticipantRoleCode> </Participant> </ParticipantList> <IsanRefParticipantList /> <CompanyList> <Company> <CompanyName>Italcine</CompanyName> </Company> </CompanyList> <IsanRefCompanyList /> <CompositeIsanList /> </IsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>1C9565ED3FBB05C50554AC3136799F5D</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Result> </getIsanMetadataTResultResponseElement> </env:Body> </env:Envelope>

10.6 WS-TR06: RETRIEVE A LIST OF IN-DEV WORKS.

Name of the service:getIndevWorkListTResult This service allows to retrieve a list of In-dev works. (Cf. WS-IM05: List In-dev ISAN). Input Parameters:



Yes


96/137



Conditions: The selected transaction must have a finished status. Response:


TR_SumIsanMetadataList_Type tr_sumIsanMetadataList

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>

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> <getIndevWorkListTResultResponseElement> <result> <ResultList> <Tr_Sum_IsanMetadata> <Sum_IsanMetadata> <WorkYearOfReference>2007</WorkYearOfReference> <MainTitle> <Title>Friends</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> </MainTitle> </Sum_IsanMetadata> <TransactionResult> <TransactionStatus>0</TransactionStatus> <TransactionId>SRIip45784</TransactionId> <TransactionResult>GetIndevWorkListTResult[1]</TransactionResult> <TransactionCode>S02</TransactionCode>

97/137



</TransactionResult> </Tr_Sum_IsanMetadata> <Tr_Sum_IsanMetadata> <Sum_IsanMetadata> <WorkYearOfReference>2005</WorkYearOfReference> <MainTitle> <Title>Amigos</Title> <LanguageCodeISO639_2> <CodeISO639_2>SPA</CodeISO639_2> </LanguageCodeISO639_2> </MainTitle> </Sum_IsanMetadata> <TransactionResult> <TransactionStatus>0</TransactionStatus> <TransactionId>SRfr45784</TransactionId> <TransactionResult>GetIndevWorkListTResult[2]</TransactionResult> <TransactionCode>S02</TransactionCode> </TransactionResult> </Tr_Sum_IsanMetadata> <Tr_Sum_IsanMetadata> <Sum_IsanMetadata> <WorkYearOfReference>2006</WorkYearOfReference> <MainTitle> <Title>Amis</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> </MainTitle> </Sum_IsanMetadata> <TransactionResult> <TransactionStatus>0</TransactionStatus> <TransactionId>ewfr45784</TransactionId> <TransactionResult>GetIndevWorkListTResult[3]</TransactionResult> <TransactionCode>S02</TransactionCode> </TransactionResult> </Tr_Sum_IsanMetadata> </ResultList> </result> </getIndevWorkListTResultResponseElement> </env:Body> </env:Envelope>

10.7 WS-TR07: RETRIEVE A LIST OF SERIAL HEADER.

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:



Yes


98/137






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>

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> <getSerialHeaderListTResultResponseElement> <Result> <Resultlist> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Dark Shadows</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail /> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>64FF1B105334F38416696ED5661A3BD5</TransactionId>

99/137



<TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Dark Angel</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail /> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>9F31C07372B03751572934E7354A5487</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Dark Skies (series)</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail /> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>4C20C5226678B1C858528385B320684B</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference /> <WorkType /> <TitleList> <TitleDetail> <Title>Dark Justice - Yr3 92/93</Title> <LanguageCodeISO639_2> <CodeISO639_2>ENG</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail /> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>7609C78DD6D4212F0D0E65A1A3835E55</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult>

100/137



<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



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:



Yes


Conditions: The selected transaction must have a finished status Response:


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"?>




<soap:Body>

<getclienttresultElement



<TransactionId>3D497ACA5F645ACB7DFA873DBE2C4C98</TransactionId>

</getclienttresultElement>

</soap:Body>

</soap:Envelope>





<env:Body>

102/137



<getclienttresultResponseElement>

<result>

<TransactionResult>


<TransactionId>3D497ACA5F645ACB7DFA873DBE2C4C98</TransactionId>




<client>

<Identifiers>

<ClientId>CL001.98911.B</ClientId>

<ClientNumber>135242</ClientNumber>

<ClientGroup />

<UserNamePrefix>gro001129</UserNamePrefix>

</Identifiers>

<ClientCheck>

<AdmissionRight>UNB</AdmissionRight>

<BlockReason />

<BlockReasonComment />

<RegCheck>RC3</RegCheck>

<RegCheckComment />

<Status>ACT</Status>

</ClientCheck>

<CoreData>


<SpokenLanguage>




</SpokenLanguage>


<RAName>AGENCE FRANCAISE ISAN</RAName>

<RAFields>

<RAField>


</RAField>

<RAField>

<RAField />

</RAField>

<RAField>

<RAField />

</RAField>

</RAFields>


</CoreData>

<Contacts>

<Contact>



<FirstName />

<LastName />

<Name>GAUMONT</Name>

<Acronym />

<Email />

<JobTitle />

<Address>


<zip>94200</zip>


<country>



</country>

</Address>

<PhoneList>

<Phone>



103/137




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>





<Name />

<Acronym />


<JobTitle />

<Address />

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>





<Name />

<Acronym />


<JobTitle />

<Address />

<PhoneList>

<Phone>




</Phone>

<Phone>




</Phone>

</PhoneList>

</Contact>

<Contact>





<Name />

<Acronym />


<JobTitle />

<Address>


<zip>75008</zip>

<city>PARIS</city>

104/137



<country>



</country>

</Address>

<PhoneList>

<Phone>




</Phone>

<Phone>




</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:



Yes




RES_TRSumClientList_Type resultList

List of clients retrieved. Each row contains set of (TransactionResult, SumClient).

Errors:

105/137



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"?>




<soap:Body>

<getclientslisttresultElement


<SessionKey>B2AAA6D883C727D8DF2A2B1B9BDCEEE6</SessionKey>

<TransactionId>6FFBBEE4B4AE9933C86A1522FE85BB21</TransactionId>

</getclientslisttresultElement>

</soap:Body>

</soap:Envelope>





<env:Body>

<getclientslisttresultResponseElement>

<result>

<resultlist>

<TRSumClient>

<TransactionResult>


<TransactionId>1765914E21685FF502BC65B03A04C2AE</TransactionId>




<SumClient>

<Type>REG</Type>

<UserNamePrefix> gro001127</UserNamePrefix>


<Name> GARANCE (LJ)</</Name>

</SumClient>

</TRSumClient>

<TRSumClient>

<TransactionResult>


<TransactionId>BE9011DEC49D18756E57F9BF775C6C5D</TransactionId>




<SumClient>

<Type>REG</Type>



<Name> POISSY FILMS </Name>

</SumClient>

</TRSumClient>

<TRSumClient>

<TransactionResult>


106/137



<TransactionId>5D079AF040D4573D8DD7E378FB6B895C</TransactionId>




<SumClient>

<Type>REG</Type>



<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:



Yes




TR_IsanRefParticipantList_Type tr_isanRefParticipantList

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



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> <getParticipantListTResultElement xmlns="http://org/isan/TransactionListManagementWS.wsdl/types/"> <sessionKey>9E9DC748944A8BE67EDDD41B28304143 </sessionKey> <transactionId>E732A17B04F49BB22E1DFC8352502B92</transactionId> </getParticipantListTResultElement> </soap:Body> </soap:Envelope>

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> <getParticipantListTResultResponseElement> <result> <ResultList> <Tr_IsanRefParticipant> <TransactionResult> <TransactionStatus> </TransactionStatus> <TransactionId> </TransactionId> <TransactionResult></TransactionResult> <TransactionCode> </TransactionCode> </TransactionResult> <IsanRefParticipant> <LastName>Aaron</LastName> <ParticipantId>P.956456.P</ParticipantId> <ParticipantRoleCode>ACT</ParticipantRoleCode> <FirstName>Jack</FirstName> </IsanRefParticipant> </Tr_IsanRefParticipant> </ResultList> </result> </getParticipantListTResultResponseElement> </env:Body> </env:Envelope>

10.11 WS-TR11: RETRIEVE A LIST OF PRODUCTION COMPANIES.

Name of the service:getProdCompanyListTResult This service allows to retrieve a list of production companies after a search for production companies.

108/137



(Cf. WS-TH02: Search for Production Company.)

109/137



Input Parameters:



Yes




Tr_IsanReferenceCompanyList_Type tr_IsanReferenceCompanyList

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>

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> <getProdCompanyListTResultResponseElement> <result> <ResultList> <Tr_IsanRefCompany> <TransactionResult/> <IsanReferenceCompany> <CompanyId> P.760123.M</CompanyId> <CompanyName> Tf 1</CompanyName> </IsanReferenceCompany> </Tr_IsanRefCompany>

110/137



<Tr_IsanRefCompany> <TransactionResult/> <IsanReferenceCompany> <CompanyId> P.871234.N</CompanyId> <CompanyName> Tf 1 Films Prod</CompanyName> </IsanReferenceCompany> </Tr_IsanRefCompany> <Tr_IsanRefCompany> <TransactionResult/> <IsanReferenceCompany> <CompanyId> P.982345.O</CompanyId> <CompanyNameTf 1 Paris</CompanyName> </IsanReferenceCompany> </Tr_IsanRefCompany> </ResultList> </result> </getProdCompanyListTResultResponseElement> </env:Body> </env:Envelope>

10.12 WS-TR12: RETRIEVE A LIST OF ISAN WORK RESULT.

Name of the service:getIsanWorkListTResult This service allows to retrieve a list of Isan works result Input Parameters:



Yes


Conditions: The selected transaction must have a “finished” status. Response:



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



<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> <getIsanWorkListTResultElement xmlns="http://org/isan/TransactionListManagementWS.wsdl/types/"> <sessionkey>9E9DC748944A8BE67EDDD41B28304143 </sessionkey> <transactionId>9C593050D78E4DF85152F9B79B77BCCE</transactionId> </getIsanWorkListTResultElement> </soap:Body> </soap:Envelope>

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



<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:


113/137




Yes





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>

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> <getSerialEpisodeListTResultResponseElement> <Result> <Resultlist> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference>1988</WorkYearOfReference> <WorkType>SE</WorkType> <TitleList> <TitleDetail> <Title>Champagne charlie 1</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail>

114/137



<TitleDetail> <Title>Champagne charlie</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>94C07C04255A06FA286147B7698AF6EE</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference>1988</WorkYearOfReference> <WorkType>SE</WorkType> <TitleList> <TitleDetail> <Title>Champagne charlie 2</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail> <Title>Champagne charlie</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>E2D151396B7F369FB060B3FD74D07DC0</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference>1988</WorkYearOfReference> <WorkType>SE</WorkType> <TitleList> <TitleDetail> <Title>Champagne charlie 3</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail> <Title>Champagne charlie</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> </TitleList>

115/137



</SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>2BC1E20B71B00C8734C6BCF5D6B10823</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> <Tr_SumIsanMetadata> <SumIsanMetadata> <WorkYearOfReference>1988</WorkYearOfReference> <WorkType>SE</WorkType> <TitleList> <TitleDetail> <Title>Champagne charlie 4</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> <TitleDetail> <Title>Champagne charlie</Title> <LanguageCodeISO639_2> <CodeISO639_2>FRE</CodeISO639_2> </LanguageCodeISO639_2> <TitleKind>ORIGINAL</TitleKind> </TitleDetail> </TitleList> </SumIsanMetadata> <TransactionResult> <TransactionStatus>Finished</TransactionStatus> <TransactionId>43161E62495490526D3C6F5641240744</TransactionId> <TransactionResult>ActiveISAN:The ISAN number is active</TransactionResult> <TransactionCode>S006</TransactionCode> </TransactionResult> </Tr_SumIsanMetadata> </Resultlist> </Result> </getSerialEpisodeListTResultResponseElement> </env:Body>

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:

Test Server

WSDL Address http://webservices.test.isan.org/IsanWorksManagement/1.0/CheckWorkStatusSoapHttpPort?WSDL

List of operations http://webservices.test.isan.org/IsanWorksManagement/1.0/CheckWorkStatusSoapHttpPort

http://webservices.test.isan.org/IsanWorksManagement/1.0/CheckWorkStatusSoapHttpPort?WSDL

http://webservices.test.isan.org/IsanWorksManagement/1.0/CheckWorkStatusSoapHttpPort?WSDL

116/137



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:



Yes

String registrantID The registrant identifier Yes

Conditions: The registrant identifier must exist. Response:


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>

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/check/CheckWorkStatus.wsdl/types/"> <env:Body> <ns0:getStatusFromRegpkResponseElement> <ns0:result>

117/137



<ns0:TransactionResult> <ns0:TransactionStatus>Finished</ns0:TransactionStatus> <ns0:TransactionID>0</ns0:TransactionID> <ns0:TransactionResult>PendingISANallocation_RA:Your work is matching with already registered works. Please contact your Registration Agency.</ns0:TransactionResult> <ns0:TransactionCode> S015 </ns0:TransactionCode> </ns0:TransactionResult> <ns0:ISANWork/> </ns0:result> </ns0:getStatusFromRegpkResponseElement> </env:Body> </env:Envelope>

118/137



Annex A - List of Country Codes

AF Afghanistan

AL Albania

DZ Algeria

AS American Samoa

AD Andorra

AO Angola

AI Anguilla

AQ Antarctica

AG Antigua and Barbuda

AR Argentina

AM Armenia

AW Aruba

AU Australia

AT Austria

AZ Azerbaijan

BS Bahamas

BH Bahrain

BD Bangladesh

BB Barbados

BY Belarus

BE Belgium

BZ Belize

BJ Benin

BM Bermuda

BT Bhutan

BO Bolivia

BA Bosnia and Herzegovina

BW Botswana

BV Bouvet Island

BR Brazil

IO British Indian Ocean Territory

BN Brunei Darussalam

BG Bulgaria

BF Burkina Faso

BI Burundi

KH Cambodia

CM Cameroon

CA Canada

CV Cape Verde

KY Cayman Islands

CF Central African Republic

TD Chad

CL Chile

CN China

CX Christmas Island

CC Cocos (Keeling) Islands

CO Colombia

KM Comoros

CG Congo

CD Congo, the Demotratic Republic of the

CK Cook Islands

CR Costa Rica

CI Côte d'Ivoire

HR Croatia (local name Hrvatska)

CU Cuba

CY Cyprus

CZ Czech Republic

DK Denmark

DJ Djibouti

DM Dominica

DO Dominican Republic

EC Ecuador

EG Egypt

SV El Salvador

GQ Equatorial Guinea

ER Eritrea

EE Estonia

ET Ethiopia

FK Falkand Islands (Malvinas)

FO Faroe Islands

FJ Fiji

FI Finland

FR France

GF French Guiana

PF French Polynesia

TF French Southern Territories

GA Gabon

GM Gambia

GE Georgia

DE Germany

GH Ghana

GI Gibraltar

GR Greece

GL Greenland

GD Grenada

GP Guadeloupe

GU Guam

GT Guatemala

GN Guinea

GW Guinea-Bissau

GY Guyana

HT Haiti

HM Heard Island and McDonald Islands

VA Holy See (Vatican City State)

HN Honduras

HK Hong Kong

HU Hungary

IS Iceland

IN India

ID Indonesia

IR Iran, Islamic Republic Of

IQ Iraq

IE Ireland

IL Israel

IT Italy

JM Jamaica

JP Japan

JO Jordan

KZ Kazakstan

KE Kenya

KI Kiribati

KP Korea, Demotratic People's Republic Of

KR Korea, Republic of

KW Kuwait

KG Kyrgyzstan

LA Lao Peoples's Democratic Republic

LV Latvia

LB Lebanon

LS Lesotho

LR Liberia

LY Libyan Arab Jamahiriya

119/137



LI Liechtenstein

LT Lithuania

LU Luxembourg

MO Macau

MK Macedonia, the Former Yugoslav Republic of

MG Madagascar

MW Malawi

MY Malaysia

MV Maldives

ML Mali

MT Malta

MH Marshall Islands

MQ Martinique

MR Mauritania

MU Mauritius

YT Mayotte

MX Mexico

FM Micronesia, Federated States of

MD Moldova, Republic of

MC Monaco

MN Mongolia

MS Montserrat

MA Morocco

MZ Mozambique

MM Myanmar

NA Namibia

NR Nauru

NP Nepal

NL Netherlands

AN Netherlands Antilles

NC New Caledonia

NZ New Zealand

NI Nicaragua

NE Niger

NG Nigeria

NU Niue

NF Norfolk Island

MP Northern Mariana Islands

NO Norway

OM Oman

PK Pakistan

PW Palau

PS Palestinian territory, occupied

PA Panama

PG Papua New Guinea

PY Paraguay

PE Peru

PH Philippines

PN Pitcairn

PL Poland

PT Portugal

PR Puerto Rico

QA Qatar

RE Reunion

RO Romania

RU Russian Federation

RW Rwanda

SH Saint Helena

KN Saint Kitts and Nevis

LC Saint Lucia

PM Saint Pierre and Miquelon

VC Saint Vincent and the Grenadines

WS Samora

SM San Marino

ST Sao Tome and Principe

SA Saudi Arabia

SN Senegal

SC Seychelles

SL Sierra Leone

SG Singapore

SK Slovakia

SI Slovenia

SB Solomon Islands

SO Somalia

ZA South Africa

GS South Georgia and the South Sandwich Islands

SU Soviet Union

ES Spain

LK Sri Lanka

SD Sudan

SR Suriname

SJ Svalbard and Jan Mayen

SZ Swaziland

SE Sweden

CH Switzerland

SY Syrian Arab Republic

TW Taiwan, Province of China

TJ Tajikistan

TZ Tanzania, United Republic of

TH Thailand

TL Timore-Leste / Timor-Leste

TG Togo

TK Tokelau

TO Tonga

TT Trinidad and Tobago

TN Tunisia

TR Turkey

TM Turkmenistan

TC Turks and Caicos Islands

TV Tuvalu

UG Uganda

UA Ukraine

AE United Arab Emirates

GB United Kingdom

US United States

UM United States Minor Outlying Islands

UY Uruguay

UZ Uzbekistan

VU Vanuatu

VE Venezuela

VN Vietnam

VG Virgin Islands, British

VI Virgrin Islands, U.S.

WF Wallis and Futuna

EH Western Sahara

YE Yemen

YU Yugoslavia

ZM Zambia

ZW Zimbabwe

Annex B – List of Language Codes

ABK Abkhazian

ACE Achinese (Aceh)

ACH Acoli

ADA

Adangme (One of the Ghana language)

AAR Afar

AFH Afrihili

AFR Afrikaans

AFA Afro-Asiatic (Other)

AKA

Akan (One of the Ghana language)

AKK Akkadian (Babylonian)

ALB Albanian

ALE

Aleut (an Eskimo language from Aleutian Islands)

ALG Algonquian languages

TUT Altaic (Other)

AMH

Amharic (or Abyssinian, main language of Ethiopia)

APA Apache languages

ARA Arabic

ARC Aramaic (Syria)

ARP Arapaho

ARN Araucanian (S. Central Chile)

ARW Arawak

ARM Armenian (Hayeren)

ART Artificial (Other)

ASM

Assamese (Indo-Iranian subfamily)

ATH Athapascan languages

AUS Australian languages

MAP

Austronesian (Other, Malayo-Polynesian)

AVA Avaric

AVE Avestan

AWA Awadhi

AYM

Aymara (language from indigenous people near lake Titicaca basin in Peru and Bolivia)

AZE Azerbaijani (Azeri)

NAH Aztec (Nahuatl)

BAN Balinese

BAT Baltic (Other)

BAL Baluchi

BAM Bambara

BAI Bamileke languages

BAD Banda

BNT Bantu (Other)

BAS Basa

BAK Bashkir

BAQ Basque

BTK Batak (Indonesia)

BEJ

Beja (spoken near Ethiopia and ajoining regions)

BEL Belarussian (white russian)

BEM Bemba

BEN Bengali (Bangla)

BER Berber (Other)

BHO Bhojpuri

BIH Bihari (an east indic language)

BIK Bikol

BIN Bini

BIS

Bislama (one of the major Vanuatu language)

BRA Braj

BRE Breton (Brez)

BUG Buginese (Bugi)

BUL Bulgarian

BUA Buriat

BUR

Burmese (Myanmasa) (belonging to the Tibeto-Burman subfamily)

CAD Caddo

XCA

Cantonese (Chinese dialect from Guangzhou)

CAR Carib

XCS Caspian

CAT Catalan

CAU Caucasian (Other)

CEB Cebuano

CEL Celtic (Other)

CAI

Central American Indian (Oth.)

XCH

Chadic (spoken in Chad, northern Cameroon and northern Nigeria)

CHG Chagatai

CMC Chamic languages

CHA

Chamorro (Guam and Northern Mariana Islands)

CHE Chechen

CHR Cherokee

CHY Cheyenne

CHB Chibcha (Colombia)

CHI Chinese (Zhongwen)

CHN Chinook jargon

CHP Chipewyan

CHO Choctaw

CHU Church Slavic

CHK Chuukese

CHV Chuvash

COP Coptic

COR Cornish

COS Corsican

CRE Cree

MUS Creek (Muskogee)

CRP Creoles and pidgins (Other)

CPE

Creoles and pidgins, English-based (Other)

CPF

Creoles and pidgins, French-based (Other)

CPP

Creoles and pidgins, Portuguese-based (Other)

SCR Croatian

CUS Cushitic (Other)

CZE Czech

DAK Dakota

DAN Danish

DAY Dayak

DEL Delaware

DIN Dinka

DIV Divehi (Maldives)

DOI Dogri

DGR Dogrib

DRA Dravidian (Other)

DUA Duala

DUT Dutch

DUM Dutch, Middle (ca. 1050-1350)

DYU Dyula

DZO Dzongkha (=Bhutani)

EFI Efik

EGY Egyptian (Ancient)

EKA Ekajuk

ELX Elamite

ENG English

ENM English, Middle (1100-1500)

ANG English, Old (ca. 450-1100)

EPO Esperanto

121/137



EST Estonian (Eesti)

EWE

Ewe (main language of Togo)

EWO Ewondo

FAN

Fang (Equatorial Guinea and Gabon)

FAT

Fanti (One of the Ghana language)

FAO

Faroese (Faeroese Island)

FIJ Fijian

FIN Finnish (Suomi)

FIU

Finno-Ugrian (Lapland language)

FON

Fon (Official language of Benin with French)

FRE French

FRM French, Middle (ca. 1400-1600)

FRO French, Old (ca. 842-1400)

FRY Frisian (Frysk)

FUR Friulian

FUL

Fulah (From Senegal to eastern Sudan)

GAA Ga

GLA Gaelic (Scots)

GLG

Gallegan (Galician, Galego)

LUG

Ganda (or Baganda, Uganda)

GAY Gayo

GBA Gbaya

GEZ Geez (classical Ethiopic)

GEO Georgian (Kartuli)

GER German

GMH

German, Middle High (ca. 1050-1500)

GOH

German, Old High (ca. 750-1050)

GEM Germanic (Other)

GIL Gilbertese (Kiribati)

GON Gondi

GOR Gorontalo

GOT Gothic

GRB Grebo

GRC Greek, Ancient (to 1453)

GRE

Greek, Modern (1453-) (Ellinika)

GRN

Guarani (bolivia, paraguay, and south of Brezil)

GUJ

Gujarati (northwest india)

GWI Gwich'in

HAI Haida

HAU Hausa (Nigeria)

HAW Hawaiian

HEB Hebrew (Iwrith)

HER Herero (Namibia)

HIL Hiligaynon

HIM Himachali

HIN

Hindi (official language of northern India)

HMO Hiri Motu

HIT Hittite

HMN Hmong

HUN Hungarian (Magyar)

HUP Hupa

IBA Iban

ICE Icelandic

IBO Igbo

IJO Ijo

ILO Iloko

INC Indic (Other)

INE Indo-European (Other)

IND Indonesian

INA

Interlingua (International Auxilary Language Association)

ILE Interlingue

IKU Inuktitut

IPK Inupiak

IRA Iranian (Other)

GLE Irish

MGA Irish, Middle (900-1200)

SGA Irish, Old (to 900)

IRO Iroquoian languages

ITA Italian

JPN Japanese (Nihongo)

JAV Javanese

JRB Judeo-Arabic

JPR Judeo-Persian

KAB Kabyle

KAC Kachin

KAL Kalaallisut (or Greenlandic)

KAM Kamba (Kenya)

KAN Kannada

KAU Kanuri

KAA Kara-Kalpak

KAR Karen

KAS Kashmiri

KAW Kawi

KAZ Kazakh

KHA Khasi

KHM Khmer (Cambodian)

KHI

Khoisan (Other) (Namibia and West South Africa)

KHO

Khotanese (or Saka, East Iranian)

KIK

Kikuyu (Northern Kenya)

KMB Kimbundu (Angola)

KIN Kinyarwanda (Rwanda)

KIR Kirghiz

KOM Komi

KON Kongo

KOK Konkani (south indic)

KOR Korean

KOS Kosraean

KPE Kpelle

KRO Kru

KUA Kuanyama

KUM Kumyk

KUR Kurdish

KRU Kurukh

KUT Kutenai

LAD Ladino

LAH Lahnda

LAM Lamba

LAO Lao (= Laothian)

LAT Latin

LAV Latvian (= lettish, letonian)

XLA Laz

LTZ

Letzeburgesch (luxembourg low german dialect)

LEZ Lezghian

LIN Lingala

LIT Lithuanian

LOZ Lozi

LUB Luba-Katanga

LUA Luba-Lulua (Central Zaire)

LUI Luiseno

LUN Lunda

LUO Luo (Kenya and Tanzania)

LUS Lushai

MAC Macedonian

MAD Madurese

MAG Magahi

MAI Maithili

MAK Makasar

MLG Malagasy

MAY Malay

MAL Malayalam

MLT Maltese

MDR Mandar

XAA Mandarin dialect

MAN

Mandingo (spoken in Sierra Leone, Liberia, Guinea, Ivory Coast, Mali and Burkina Faso)

MNI Manipuri

MNO Manobo languages

GLV Manx

MAO Maori

MAR Marathi

CHM Mari

MAH Marshall

MWR Marwari

MAS

Masai (Nomadic people of East Africa, Kenya and Tanzania)

MYN Mayan languages

MEN Mende (Sierra Leone)

MIC Micmac

MIN Minangkabau

MIS Miscellaneous languages

122/137



MOH Mohawk

MOL Moldavian

MKH Mon-Khmer (Other)

LOL Mongo

MON Mongolian

MOS Mossi (More)

MUL Multiple languages

MUN Munda languages

XMU Mute film

NAU Nauru

NAV Navajo

NDE

Ndebele, North (Zimbabwe, Botswana)

NBL

Ndebele, South (Zimbabwe, Botswana)

NDO Ndonga

NEP Nepali

NEW Newari

NIA Nias

NIC

Niger-Kordofanian (Other)

SSA Nilo-Saharan (Other)

NIU Niuean (Niue Island)

NON Norse, Old

NAI North American Indian (Other)

NOR Norwegian

NUB Nubian languages

NYM Nyamwezi

NYA Nyanja

NYN Nyankole

NYO Nyoro

NZI Nzima

OCI Occitan (post 1500)

OJI Ojibwa

ORI Oriya

ORM

Oromo (Galla or Afan) (West and South Ethiopia and Kenya)

OSA Osage

OSS Ossetic

OTO Otomian languages

PAL Pahlavi

PAU

Palauan (Palau Island in Micronesia)

PLI Pali

PAM Pampanga

PAG Pangasinan

PAN

Panjabi (language of Punjab)

PAP Papiamento

PAA Papuan (Other)

PER Persian (=Farsi)

PEO

Persian, Old (ca. 600-400 B.C.)

PHI Philippine (Other)

PHN Phoenician

PON Pohnpeian

POL Polish

POR Portuguese

PRA Prakrit languages

PRO Provencal, Old (to 1500)

PUS Pushto (or Pachto, Afghan)

XPY Pygmies language

QUE

Quechua (Bolivia, Peru and Ecuador)

ROH Raeto-Romance

RAJ Rajasthani

RAP Rapanui

RAR Rarotongan

ROA Romance (Other)

RUM Romanian

ROM Romany (Gipsy language)

RUN Rundi (or Kirundi)

RUS Russian

SAL Salishan languages

SAM Samaritan Aramaic

SMI Sami languages

SMO Samoan

SAD Sandawe

SAG

Sango (Central African Republic)

SAN Sanskrit

SAT Santali

SRD Sardinian

SAS Sasak

SCO Scots

SEL Selkup

SEM Semitic (Other)

SCC Serbian

SRR Serer

SHN Shan

SNA Shona

SID Sidamo

BLA Siksika (Blackfoot)

SND Sindhi

SIN Sinhalese (Sri Lanka)

SIT Sino-Tibetan (Other)

SIO Siouan languages

DEN Slave (Athapascan)

SLA Slavic (Other)

SLO Slovak

SLV Slovenian

SOG Sogdian

NSO Sohto, Northern

SOM Somali

SON Songhai

SNK Soninke

WEN Sorbian languages

SOT

Sotho (Southern, language of the Lesotho)

SAI South American Indian (Other)

SPA Spanish

SUK Sukuma

SUX Sumerian

SUN Sundanese

SUS Susu (Guinea)

SWA

Swahili (a bantu language over much of east Africa and the Congo region)

SSW

Swati (= Siswant, Siswati)

SWE Swedish

XCD Swiss German dialect

XCI Swiss Italian dialect

SYR Syriac

TGL Tagalog (Philipines)

TAH Tahitian

TAI Tai (Other)

TGK Tajik

TMH Tamashek

TAM

Tamil (part of India and Sri Lanka)

TAT Tatar

TEL Telugu

TER Tereno

TET Tetum

THA Thai

TIB Tibetan (Bodskad)

TIG Tigre

TIR Tigrinya

TEM Timne

TIV Tiv

TLI Tlingit

TPI Tok Pisin

TKL Tokelau

TOG Tonga (Nyasa)

TON Tonga (Tonga Islands)

TSI Tsimshian

TSO Tsonga

TSN Tswana (= Setswana)

TUM Tumbuka

TUR Turkish

OTA

Turkish, Ottoman (1500-1928)

TUK Turkmen

TVL Tuvalu

TYV Tuvinian

TWI Twi

ZZZ UNKNOWN

UGA Ugaritic

UIG Uighur

UKR Ukrainian

UMB Umbundu

URD Urdu (=Pakistanian)

UZB Uzbek

VAI Vai

VEN Venda (South africa)

VIE Vietnamese

VOL Volapuk

VOT Votic

WAK Wakashan languages

WAL Walamo

XWA Wallon

WAR Waray

WAS Washo

123/137



WEL Welsh

WOL

Wolof (niger-congo language of senegambia)

XHO

Xhosa (Lesotho, Bantustan, South Africa)

SAH Yakut

YAO Yao

YAP Yapese

YID Yiddish

YOR

Yoruba (South West Nigeria and Benin)

YPK Yupik languages

ZND Zande

ZAP Zapotec

ZEN Zenaga

ZHA Zhuang

ZUL Zulu

ZUN Zuni

124/137

ISAN API: SOAP Web Services © ISAN International Agency Version: 2.2 | November 15, 2013


Annex C – Metadata Encoding Guidelines

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.

125/137



Annex D - Result Code Definition

CHECK WORK METADATA

CODE DESCRIPTION

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.

126/137



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.

127/137



ISAN REGISTRATION

CODE DESCRIPTION

E921 WorkMatchedRAException: Your work is matching with already registered works. Please contact your Registration Agency

E923 WorkMatchedException: Your work is matching strongly with already registered works. Please check the information entered

E978 CreateWorkException:Your work with title {0} has not been successfully created. Please resubmit your registration.

E981 RegistrantPKException: The registrant identifier of this work already exists in ISAN database for the same client.

P001 Your ISAN registration has been sent.

S001 ISAN successfully allocated

S014 PendingISANallocation_Reg:Your work is matching strongly with already registered works. Please check the information entered.

S015 PendingISANallocation_RA:Your work is matching with already registered works. Please contact your Registration Agency.

S016 Your Serial Header is matching with already registered serial headers. Please contact your Registration Agency.

S019 Your Serial Header has been successfully created.

ISAN UPDATE

CODE DESCRIPTION

E913 UpdateSingleWorkException: Unexpected error occured during this operation.

E914 Your work with title {0} has not been successfully updated. Please resubmit your update.

E924 UpdateEpisodeException: Unexpected error occured during this operation. The update has been discarded

E926 UpdateSerialHeaderException: Unexpected error occured during this operation. The update has been discarded

E973 WorkIsBeingUpdatingException: This work is already beeing updating, Please retry later.

E974 BadWorkOwnerException: This work doesn't belong to current client, it can't be updated.

P002 Your ISAN update request has been sent.

S008 Your Single Work has been successfully updated

S009 Your Episode has been successfully updated.

S010 Your Serial Header has been successfully updated.

SESSION

CODE DESCRIPTION

E919 SessionNotExistException : Session does not exist please log before.

E920 UserNotAllowedException : User is not allowed to perform this operation. please contact your administrator.

E922 SessionException: An unexpected session error occured.

E925 SessionHasExpiredException : Session has expired please log.

128/137



ISAN VALIDATION

CODE DESCRIPTION

E906 ISANMalformedException: ISAN is malformed.

E907 ISAN_NotExistException: ISAN does not exist.

E908 ISANNotExistMalformedException: ISAN does not exist or is malformed.

E909 ISANMalformedCheck2Exception: ISAN is malformed, check2 is not correct.

E910 ISANMalformedCheck1Exception: ISAN is malformed, check1 is not correct.

S021 ISAN exists and is valid.

SEARCH WORK FROM ISAN

CODE DESCRIPTION

E916 IncorrectIsanNumberException:Incorrect Isan number!

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.

E861 UserNamePrefixExists: UserNamePrefix already exists.

E862 SetClientRegCheckException: An unexpected error occurred during SetClientRegistrationCheck operation.

129/137



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).

130/137



E898 ClientRegCheckException: RegCheck field has an incorrect value, it should be RC[1..4].

E899 BRCommentMissingException: BlockReasonComment field is compulsory when BlockReason is set to BR4 (Other issue).

E900 BRCommentTooLongException: BlockReason field is too long; it should not contain more than 500 characters.

E901 WrongUserLoginException: Login or Password are incorrect.

E902 InvalidPasswordException: Password should contain between 8 and 20 characters.

E903 UpdClientBlockStatusException: An unexpected error occurred while updating client block status.

E904 UpdClientStatusException: An unexpected error occurred while updating client status

E905 ClientBlockStatusException: The Block status or AdmissionRight field is invalid, it should be BLO (Blocked) or UNB (Unblocked).

E996 GetClientsListException: An unexpected error occurred during the search.

E997 ClientNotFoundException: Client Not found, please check the client identifier.

E998 ClientActivateStatusException: The Activation status is invalid, it should be ACT(activate) or INA (inactivate)

E999 ClientBlockReasonException: The BlockReason parameter is invalid, it should be BR[1..4].

S022 ACTIVEClient: The client is active

S023 INACTIVEClient: The client is inactive

S024 PENDINGClient: The client is pending

S025 REFUSEDClient: The client is refused

S026 Client Status has been successfully updated

S027 Client Block Status has been successfully updated

S028 Password has been successfully changed.

S029 Client Registration Check has been successfully updated.

S030 Client has been successfully created.

S031 Client has been successfully updated.

CHECK WORK STATUS

CODE DESCRIPTION

S001 ISAN successfully allocated

S002 InactiveISAN: The ISAN number has been inactivated

E708 RegIDNotFoundException :The RegistrantID does not exist

P001 Your ISAN registration has been sent.

P003 Your In-Dev Activation request has been sent.

S014 PendingISANallocation_Reg:Your work is matching strongly with already registered works. Please check the information entered.

S015 PendingISANallocation_RA:Your work is matching with already registered works. Please contact your Registration Agency.

S045 Work rejected, the ISAN was already registered.

TRANSACTION

CODE DESCRIPTION

E927 TransactionException: Unexpected exception occured during transaction management.

E928 TransactionNotFoundException: Transaction does not exists - please check the identifier.

E929 TransactionIsExpiredException: Transaction expired and is not yet available.

E931 WrongTransactionIdException:Please check the transaction identifier.

131/137



WEB SERVICES

CODE DESCRIPTION

E911 WebServicesException: Unexpected error occured during this call.

E912 WorkIsNotASingleException: You can't perform this operation on a non Single Work. SerialWorkType value should be 'SW'.

E918 UserIsNotARegistrantException: User not allowed to update/create a work if not connected as registrant. The update has been discarded

E975 WorkIsInDevException: You can't use this operation on In Dev works.

E976 WorkIsNotSerialHeaderException: You are trying to perform this operation on a non Serial Header Work.SerialWorkType value should be 'SH'.

E977 WorkIsNotAnEpisodeException: You can't perform this operation on a non Episode Work. SerialWorkType value should be 'SE'.

E982 UnknownErrorException:



132/137

132/137

Annex E - Transaction Result Diagram: ISAN Works Management

133/137 ISAN API: SOAP Web Services


Annex F - Transaction Result Diagram: Queries Management



Annex G - Transaction Result Diagram:Clients Management


Date post:	28-Jun-2020
Category:	Documents
Upload:	others
View:	6 times
Download:	0 times

ISAN API: SOAP Web Services4/137 ISAN API: SOAP Web Services Version: 2.2 | November 15, 2013 ISAN...

Documents