Brokerage

Create Brokerage

Creates a new Brokerage

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
brokerage1
required
string [ 1 .. 256 ] characters

Brokerage that can be associated with a group

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

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

List Brokerage

Lists all Brokerage

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/brokerages
Request samples
Response samples
No sample

Get Brokerage

Gets Brokerage

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
brokerage
required
string

Brokerage1

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/brokerages/{brokerage}
Request samples
Response samples
No sample

Update Brokerage

Updates a specific Brokerage.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
brokerage
required
string

Brokerage1

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
brokerage1
required
string [ 1 .. 256 ] characters

Brokerage that can be associated with a group

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

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/brokerages/{brokerage}
Request samples
{
  • "brokerage1": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete Brokerage

Deletes an Brokerage

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
brokerage
required
string

Brokerage1

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/brokerages/{brokerage}
Request samples

Create or Update Batch Brokerage

Create or Update multiple Brokerage 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
brokerage1
required
string [ 1 .. 256 ] characters

Brokerage that can be associated with a group

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

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/brokerages-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}