Relationships

Create Relationships

Creates a new Relationships

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
relate_Code
required
string [ 1 .. 8 ] characters

Code that specifies the relationship of the Member to the Subscriber.

description
string or null <= 32 characters

Describes the relationship of the Member to the Subscriber.

entry_Date
string <date-time>

Date when the record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

hipaA_Code
string or null <= 8 characters

HIPAA code that is related to the selected Relationship.

spouse
string or null <= 1 characters

Indicates that the selected relationship is associated with the Spouse.

subscriber
string or null <= 1 characters

Indicates that the selected relationship is associated with the Subscriber.

update_Date
string <date-time>

Date when the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/relationships
Request samples
{
  • "relate_Code": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "spouse": "s",
  • "subscriber": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Relationships

Lists all Relationships

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/relationships
Request samples 
Response samples 
No sample
Get Relationships
Gets Relationships


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
relateCode
required
string
Relate Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/relationships/{relateCode}
Request samples 
Response samples 
No sample
Update Relationships
Updates a specific Relationships.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
relateCode
required
string
Relate Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
relate_Code
required
string  [ 1 .. 8 ] characters 
Code that specifies the relationship of the Member to the Subscriber.


 
description
string or null  <= 32 characters 
Describes the relationship of the Member to the Subscriber.


 
entry_Date
string <date-time> 
Date when the record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
hipaA_Code
string or null  <= 8 characters 
HIPAA code that is related to the selected Relationship.


 
spouse
string or null  <= 1 characters 
Indicates that the selected relationship is associated with the Spouse.


 
subscriber
string or null  <= 1 characters 
Indicates that the selected relationship is associated with the Subscriber.


 
update_Date
string <date-time> 
Date when the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/relationships/{relateCode}
Request samples 
{
  • "relate_Code": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "spouse": "s",
  • "subscriber": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Relationships
Deletes an Relationships


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
relateCode
required
string
Relate Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/relationships/{relateCode}
Request samples 
Create or Update Batch Relationships
Create or Update multiple Relationships at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
relate_Code
required
string  [ 1 .. 8 ] characters 
Code that specifies the relationship of the Member to the Subscriber.


 
description
string or null  <= 32 characters 
Describes the relationship of the Member to the Subscriber.


 
entry_Date
string <date-time> 
Date when the record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
hipaA_Code
string or null  <= 8 characters 
HIPAA code that is related to the selected Relationship.


 
spouse
string or null  <= 1 characters 
Indicates that the selected relationship is associated with the Spouse.


 
subscriber
string or null  <= 1 characters 
Indicates that the selected relationship is associated with the Subscriber.


 
update_Date
string <date-time> 
Date when the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/relationships-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}