Relationship

GET 
/lookup/relationship

Fetches a list of lookup values for relationship.

Request

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
name stringrequired
displayName stringrequired
options object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder numberrequired
active booleanrequired
value stringrequired
title stringrequired
readOnly booleannullablerequired
relationshipGenerationGap numbernullablerequired
reverseMaleRelationshipId uuidnullablerequired
reverseMaleRelationshipDescription stringnullablerequired
reverseFemaleRelationshipId uuidnullablerequired
reverseFemaleRelationshipDescription stringnullablerequired
reverseOtherRelationshipId uuidnullablerequired
reverseOtherRelationshipDescription stringnullablerequired
spouseRelationshipId uuidnullablerequired
relationshipSystemMeaning stringnullablerequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "name": "string",
    "displayName": "string",
    "options": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string",
        "code": "string",
        "sortOrder": 0,
        "active": true,
        "value": "string",
        "title": "string",
        "readOnly": true,
        "relationshipGenerationGap": 0,
        "reverseMaleRelationshipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "reverseMaleRelationshipDescription": "string",
        "reverseFemaleRelationshipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "reverseFemaleRelationshipDescription": "string",
        "reverseOtherRelationshipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "reverseOtherRelationshipDescription": "string",
        "spouseRelationshipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "relationshipSystemMeaning": "string"
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "name": "relationship",
    "displayName": "Relationship",
    "options": [
      {
        "id": "150a90c2-00b5-4e5e-86d4-e4ebe3f81724",
        "description": "Brother",
        "code": "BR",
        "sortOrder": 0,
        "active": true,
        "value": "Brother",
        "title": "Brother",
        "readOnly": false,
        "relationshipGenerationGap": 1,
        "reverseMaleRelationshipId": "150a90c2-00b5-4e5e-86d4-e4ebe3f81724",
        "reverseMaleRelationshipDescription": "Sibling",
        "reverseFemaleRelationshipId": "89ab3991-ce2b-4765-882c-0ed935b1623b",
        "reverseFemaleRelationshipDescription": "Sister",
        "reverseOtherRelationshipId": "dd4d8b66-15e8-416b-930b-dbe34a2fb081",
        "reverseOtherRelationshipDescription": "Sibling",
        "spouseRelationshipId": "4f696245-02c4-4cde-8d9c-9c1c821f392e",
        "relationshipSystemMeaning": "Brother"
      }
    ]
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...