| IdRef for developers |
For example:
envoiClient ("Personal name",
"Matias Martinez",
« « ,
"",
"Languages",
"ger",
"Type of record/Person",
"Martinez",
"Matias",
"ger",
"20100101",
"Source text",
"true"
);
The values must be entered in the order shown above.
The names and values of the search indexes and filters are identical to those that are displayed in the IdRef Web Interface.
Index1. The main index. The possible values are:
|
Index1 = main search index | |
|
Value |
Significance |
|
Personal name | |
|
Corporate body name | |
|
Topical subject |
Rameau or MeSH |
|
Geographic name | |
|
Family | |
|
Title |
Uniform title |
|
Name and Title | |
|
Trademark | |
|
Ppn |
Record identifier |
|
Rcr |
RCR Codes of Sudoc libraries |
|
All |
All indexes taken together |
Index1Value: value of this index
For example: Index1:"Topical subject",Index1Value:zola
Index2: Not currently used
Index1Value: value of Index2.
Index3. Currently, the only value possible for Index3 is: Languages
Index2Value. The possible values are the ISO 639-2 language codes (of three characters).
For example: Index3:"Languages",Index3Value:fre
The passage across the filters must follow the rules that we find in the web interface. Effectively, depending on the index chosen, certain filters must not be valued.
4 filters are defined:
Filter1
Filter2
Filter3
Filter4
For example: Filter1:"Record type /Rameau"
For example: Filter2:"Heading/Yes"
|
Alive | |
|
Value |
Significance |
|
No |
Dead person or inactive Corporate body |
|
Yes |
Living person (or date of death not specified) or active Corporate body (or date of inactivity not specified) |
|
Heading | |
|
Value |
Significance |
|
Yes |
Useable at the start of the heading |
|
No |
Not useable at the start of the heading |
|
As subdivisions | |
|
Value |
Signification |
|
Yes |
Useable as a subdivision |
|
No |
Not useable as a subdivision |
|
Type of record | |
|
Value |
Significance |
|
Person | |
|
Corporate Body | |
|
Family | |
|
Name and title | |
|
Chronology | |
|
Rameau | |
|
FMeSH | |
|
Geographic | |
|
Title |
Uniform title |
|
Rcr |
RCR code of the Sudoc library |
|
Trademark | |
If the authority record to be linked does not yet exist in the IdRef base, it may be necessary to create a new record. To render this task easier, the client application can send the data that serve to complete the cataloguing form to IdRef.
These data must be consistent with the values expected from the Sudoc cataloguing format. [1]
To identify a UNIMARC field to fill-in, it suffices to respect the following convention:
z{field code}_{sub-field code}
z103_a
For example:
The z103_a:"20100101" parameter allows the Date of birth field to be completed in the cataloguing form. Effectively, the 103 $a sub-field contains a date according to the YYYYMMDD syntax.
For example:
The z810_a:"text" parameter allows the Source Data Found field to be completed, which corresponds to 810$a in UNIMARC.
For example:
The z101_a:"ace" parameter allows the Language of the entity field to be completed, which corresponds to 101$a in UNIMARC. The "ace" value is an ISO language code.
The AutoClick parameter must always be present at the end of the parameters.
It takes as a value true or false.
It allows (or prevents) searches in IdRef to be automatically triggered.
Examples:
AutoClick:"true"
AutoClick:"false"