Marital Statuses

Create MaritalStatus

Creates a new MaritalStatus

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
marital_Status
required
string = 1 characters

Identifier for the marital status

description
string or null <= 32 characters

Description of the marital status

Responses
200

Success

401

Unauthorized

post/marital-statuses
Request samples
{
  • "marital_Status": "s",
  • "description": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MaritalStatus

Lists all MaritalStatus

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/marital-statuses
Request samples 
Response samples 
No sample
Get MaritalStatus
Gets MaritalStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
maritalStatus
required
string
Marital Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/marital-statuses/{maritalStatus}
Request samples 
Response samples 
No sample
Update MaritalStatus
Updates a specific MaritalStatus.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
maritalStatus
required
string
Marital Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
marital_Status
required
string  = 1 characters 
Identifier for the marital status


 
description
string or null  <= 32 characters 
Description of the marital status


 
Responses 
200
Success


401
Unauthorized


put/marital-statuses/{maritalStatus}
Request samples 
{
  • "marital_Status": "s",
  • "description": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MaritalStatus
Deletes an MaritalStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
maritalStatus
required
string
Marital Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/marital-statuses/{maritalStatus}
Request samples 
Create or Update Batch MaritalStatus
Create or Update multiple MaritalStatus 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 
marital_Status
required
string  = 1 characters 
Identifier for the marital status


 
description
string or null  <= 32 characters 
Description of the marital status


 
Responses 
207
Success


401
Unauthorized


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