Person

A schema:Person object represents a web resource about a person. For example, this could be a composer or performer.

Creating objects

To create a Person object, use the CreatePerson mutation

trompace.mutations.person.mutation_create_person(*, title: str, contributor: str, creator: str, source: str, format_: str, language: str = None, name: str = None, family_name: str = None, given_name: str = None, gender: str = None, birth_date: str = None, death_date: str = None, description: str = None, image: str = None, publisher: str = None, honorific_prefix: str = None, honorific_suffix: str = None, job_title: str = None)

Returns a mutation for creating a Person

Parameters

  • title – The title of the resource indicated by source (dcterms:title)

  • contributor – The main URL of the site where the information about this Person was taken from (dcterms:contributor)

  • creator – The person, organization or service who is creating this Person (e.g. URL of the software) (dcterms:creator)

  • source – The URL of the web resource where information about this Person is taken from (dcterms:source)

  • language – The language the metadata is written in. Currently supported languages are en,es,ca,nl,de,fr (dcterms:language)

  • format_ – The mimetype of the resource indicated by source (dcterms:format)

  • name – The name of the person (schema:name)

  • family_name (optional) – The family name of the person (schema:familyName)

  • given_name (optional) – The given name of the person (schema:givenName)

  • gender (optional) – The person’s gender (schema:gender)

  • birth_date (optional) – The birth date of the person, formatted as yyyy, yyyy-mm or yyyy-mm-dd (schema:birthDate)

  • death_date (optional) – The date of death of the person , formatted as yyyy, yyyy-mm or yyyy-mm-dd (schema:deathDate)

  • description (optional) – A biographical description of the person (dcterms:description)

  • image (optional) – URL to an image associated with the person (schema:image)

  • publisher (optional) – An entity responsible for making the resource available (dcterms:publisher)

  • honorific_prefix (optional) – An honorific prefix (schema:honorificPrefix)

  • honorific_suffix (optional) – An honorific suffix (schema:honorificSuffix)

  • job_title (optional) – The person’s job title. (schema:jobTitle)

Returns

The string for the mutation for creating the person.

Raises

  • UnsupportedLanguageException – if language is not one of the supported languages.

  • ValueError – if gender is not a value supported by the CE

  • NotAMimeTypeException – if format_ is not a valid mimetype.

To update a Person object, use the UpdatePerson mutation

trompace.mutations.person.mutation_update_person(identifier: str, *, title: str = None, contributor: str = None, creator: str = None, source: str = None, language: str = None, format_: str = None, name: str = None, family_name: str = None, given_name: str = None, gender: str = None, birth_date: str = None, death_date: str = None, description: str = None, image: str = None, publisher: str = None, honorific_prefix: str = None, honorific_suffix: str = None, job_title: str = None)

Returns a mutation for updating a Person

Parameters

  • identifier – The identifier of the person in the CE to be updated

  • title – The title of the resource indicated by source (dcterms:title)

  • contributor – The main URL of the site where the information about this Person was taken from (dcterms:contributor)

  • creator – The person, organization or service who is creating this Person (e.g. URL of the software) (dcterms:creator)

  • source – The URL of the web resource where information about this Person is taken from (dcterms:source)

  • language – The language the metadata is written in. Currently supported languages are en,es,ca,nl,de,fr (dcterms:language)

  • format_ – The mimetype of the resource indicated by source (dcterms:format)

  • name – The name of the person (schema:name)

  • family_name (optional) – The family name of the person (schema:familyName)

  • given_name (optional) – The given name of the person (schema:givenName)

  • gender (optional) – The person’s gender (schema:gender)

  • birth_date (optional) – The birth date of the person, formatted as yyyy, yyyy-mm or yyyy-mm-dd (schema:birthDate)

  • death_date (optional) – The date of death of the person , formatted as yyyy, yyyy-mm or yyyy-mm-dd (schema:deathDate)

  • description (optional) – A biographical description of the person (dcterms:description)

  • image (optional) – URL to an image associated with the person (schema:image)

  • publisher (optional) – An entity responsible for making the resource available (dcterms:publisher)

  • honorific_prefix (optional) – An honorific prefix (schema:honorificPrefix)

  • honorific_suffix (optional) – An honorific suffix (schema:honorificSuffix)

  • job_title (optional) – The person’s job title. (schema:jobTitle)

Returns

The string for the mutation for updating the person.

Raises

  • UnsupportedLanguageException – if language is not one of the supported languages.

  • ValueError – if gender is not a value supported by the Ce

  • NotAMimeTypeException – if format_ is not a valid mimetype.

To delete a Person object, use the DeletePerson mutation

trompace.mutations.person.mutation_delete_person(identifier: str)

Returns a mutation for deleting a Person with the given identifier.

Parameters

identifier – The identifier of the Person to delete.

Returns

A mutation string to delete a Person

Relations

exactMatch

The skos:exactMatch relationship is used to identify that two Person nodes refer to the exact same natural person.

../_images/person-exactmatch-person.png

Use the MergePersonExactMatch mutation to create a one-way link between two Person objects

trompace.mutations.person.mutation_person_add_exact_match_person(identifier_from: str, identifier_to: str)

Returns a mutation for linking two Person objects with skos:exactMatch.

Parameters

  • identifier_from – the identifer of the Person to match to

  • identifier_to – the identifier of the Person that is an exact match of identifier_from

Returns: a mutation to make an exactMatch relationship between the Person objects

Use the RemovePersonExactMatch mutation to remove link between two Person objects

trompace.mutations.person.mutation_person_remove_exact_match_person(identifier_from: str, identifier_to: str)

Returns a mutation for removing the skos:exactMatch relation between two Person objects

Parameters

  • identifier_from – the identifer of the Person to match to

  • identifier_to – the identifier of the Person that is an exact match of identifier_from

Returns: a mutation to remove the exactMatch relationship from the Person objects