Contents x
    Archive a person
    • 18 Sep 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Archive a person

    • Updated on 18 Sep 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/relations/persons/archive

    Archives an existing person from the given date. Either reference or externalIdentifier must have a value. If both are given, externalIdentifier will be used first for retrieving the person.

    Description

    Archives an existing person from the given date. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference. By using this operation the selected person will not be available anymore as an option to choose from lists.

    A person is a standalone entity and pertains to an enhancement of organisation. This could be a contact person within an organisation. Several users utilize this to enter their own employees into the system.

    Use Case

    The Bloxs user terminates the cooperation with a person. Therefore the person should not be shown in lists anymore.   

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system .
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    archiveDateThe date after which the person is archived.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    string

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    externalIdentifier
    string

    The external API identifier of the model.

    archiveDate
    string (date-time)

    The date after which the person is archived.

    Responses
    200

    The person was archived

    object
    isArchived
    boolean
    archiveDate
    string (date-time) | null
    400

    The archiving has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string additionalProperties
    string
    404

    The requested person was not found.

    What's Next