Commission Rep Licenses

Create CommissionRepLicense

Creates a new CommissionRepLicense

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
commRepKey
required
integer <int32>

CommissionRep Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionRepLicense_Key
required
integer <int32>
commissionRep_Key
required
integer <int32>
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
license_Number
string or null <= 128 characters
license_State
string or null <= 2 characters
license_Type
string or null <= 32 characters
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/commission-reps/{commRepKey}/commission-rep-licenses
Request samples
{
  • "commissionRepLicense_Key": 0,
  • "commissionRep_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "license_Number": "string",
  • "license_State": "st",
  • "license_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionRepLicense

Lists all CommissionRepLicense for the given commRepKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
commRepKey
required
integer <int32>

CommissionRep Key

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/commission-reps/{commRepKey}/commission-rep-licenses
Request samples 
Response samples 
No sample
Get CommissionRepLicense
Gets CommissionRepLicense


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepLicenseKey
required
integer <int32> 
CommissionRepLicense Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-reps/{commRepKey}/commission-rep-licenses/{commRepLicenseKey}
Request samples 
Response samples 
No sample
Update CommissionRepLicense
Updates a specific CommissionRepLicense.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepLicenseKey
required
integer <int32> 
CommissionRepLicense Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionRepLicense_Key
required
integer <int32> 
 
commissionRep_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
license_Number
string or null  <= 128 characters 
 
license_State
string or null  <= 2 characters 
 
license_Type
string or null  <= 32 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/commission-reps/{commRepKey}/commission-rep-licenses/{commRepLicenseKey}
Request samples 
{
  • "commissionRepLicense_Key": 0,
  • "commissionRep_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "license_Number": "string",
  • "license_State": "st",
  • "license_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionRepLicense
Deletes an CommissionRepLicense


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepLicenseKey
required
integer <int32> 
CommissionRepLicense Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-reps/{commRepKey}/commission-rep-licenses/{commRepLicenseKey}
Request samples 
Create or Update Batch CommissionRepLicense
Create or Update multiple CommissionRepLicense at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
commissionRepLicense_Key
required
integer <int32> 
 
commissionRep_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
license_Number
string or null  <= 128 characters 
 
license_State
string or null  <= 2 characters 
 
license_Type
string or null  <= 32 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/commission-reps/{commRepKey}/commission-rep-licenses-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}