Gender

Create Gender

Creates a new Gender

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
gender_Code
required
string = 1 characters

User defined Gender Code for each gender value.

description
string or null <= 512 characters

Brief description of this Gender Code.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 200 characters

User that first added the record to the system

hipaA_Code
string or null <= 8 characters

Used to map to a valid x12 transaction value for 834 processing.

update_Date
string <date-time>

Date 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/genders
Request samples
{
  • "gender_Code": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Gender

Lists all Gender

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/genders
Request samples 
Response samples 
No sample
Get Gender
Gets Gender


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Gender_Code
required
string
Gender Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/genders/{Gender_Code}
Request samples 
Response samples 
No sample
Update Gender
Updates a specific Gender.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Gender_Code
required
string
Gender Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
gender_Code
required
string  = 1 characters 
User defined Gender Code for each gender value.


 
description
string or null  <= 512 characters 
Brief description of this Gender Code.


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


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


 
hipaA_Code
string or null  <= 8 characters 
Used to map to a valid x12 transaction value for 834 processing.


 
update_Date
string <date-time> 
Date 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/genders/{Gender_Code}
Request samples 
{
  • "gender_Code": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Gender
Deletes an Gender


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Gender_Code
required
string
Gender Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/genders/{Gender_Code}
Request samples 
Create or Update Batch Gender
Create or Update multiple Gender 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 
gender_Code
required
string  = 1 characters 
User defined Gender Code for each gender value.


 
description
string or null  <= 512 characters 
Brief description of this Gender Code.


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


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


 
hipaA_Code
string or null  <= 8 characters 
Used to map to a valid x12 transaction value for 834 processing.


 
update_Date
string <date-time> 
Date 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/genders-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}