Operation

This operation allow you to get a list of all the Family Relationship's available in the system.

GET

https://{environment}.ulysescloud.com/public/api/{version}/familyRelationship

Request

This request has no parameters.

Example request

GET https://publicapi-dev.ulysescloud.com/public/api/v1/familyRelationship

Response

Array of familyRelationship elements.

Entity

Field	Type	Description
id	Integer	id
code	String	Code
name	String	Name

Example response

[
    {
        "id": 1,
        "code": "GFGM",
        "name": "Grandfather/Grandmother",
        "nameI18n": "Grandfather/Grandmother"
    },
    {
        "id": 2,
        "code": "GGFGGM",
        "name": "Great-grandfather/Great-grandmother",
        "nameI18n": "Great-grandfather/Great-grandmother"
    },
    {
        "id": 3,
        "code": "GGCD",
        "name": "Great-grandchild",
        "nameI18n": "Great-grandchild"
    },
    {
        "id": 4,
        "code": "BLSL",
        "name": "Brother-in-law/Sister-in-law",
        "nameI18n": "Brother-in-law/Sister-in-law"
    },
    {
        "id": 5,
        "code": "SPOU",
        "name": "Spouse",
        "nameI18n": "Spouse"
    } ...
]

Browser not supported