Member Occupations

Create MemberOccupation

Creates a new MemberOccupation

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

occupation_ID
required
string [ 1 .. 32 ] characters

Identifies the occupation that is associated with the Member.

effective_Date
required
string <date-time>

Date when the occupation becomes/became effective for the Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

hire_Date
string or null <date-time>

Date when the Member was hired at the associated occupation.

pay_Rate
number or null <double>

Rate of pay for the Member at the associated occupation.

pay_Rate_Frequency
string or null <= 16 characters

Frequency of the rate of pay for the Member at the associated occupation.

term_Date
string or null <date-time>

Date when the occupation expires/expired for the Member.

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/subscribers/{subscriberID}/members/{memberSeq}/occupations
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "occupation_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hire_Date": "2019-08-24T14:15:22Z",
  • "pay_Rate": 0.1,
  • "pay_Rate_Frequency": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberOccupation

Lists all MemberOccupation for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

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/subscribers/{subscriberID}/members/{memberSeq}/occupations
Request samples 
Response samples 
No sample
Get MemberOccupation
Gets MemberOccupation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
occupationID
required
string
Occupation ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/occupations/{occupationID}/{effectiveDate}
Request samples 
Response samples 
No sample
Update MemberOccupation
Updates a specific MemberOccupation.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
occupationID
required
string
Occupation ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
occupation_ID
required
string  [ 1 .. 32 ] characters 
Identifies the occupation that is associated with the Member.


 
effective_Date
required
string <date-time> 
Date when the occupation becomes/became effective for the Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
hire_Date
string or null <date-time> 
Date when the Member was hired at the associated occupation.


 
pay_Rate
number or null <double> 
Rate of pay for the Member at the associated occupation.


 
pay_Rate_Frequency
string or null  <= 16 characters 
Frequency of the rate of pay for the Member at the associated occupation.


 
term_Date
string or null <date-time> 
Date when the occupation expires/expired for the Member.


 
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/subscribers/{subscriberID}/members/{memberSeq}/occupations/{occupationID}/{effectiveDate}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "occupation_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hire_Date": "2019-08-24T14:15:22Z",
  • "pay_Rate": 0.1,
  • "pay_Rate_Frequency": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberOccupation
Deletes an MemberOccupation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
occupationID
required
string
Occupation ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/occupations/{occupationID}/{effectiveDate}
Request samples 
Create or Update Batch MemberOccupation
Create or Update multiple MemberOccupation 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
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
occupation_ID
required
string  [ 1 .. 32 ] characters 
Identifies the occupation that is associated with the Member.


 
effective_Date
required
string <date-time> 
Date when the occupation becomes/became effective for the Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
hire_Date
string or null <date-time> 
Date when the Member was hired at the associated occupation.


 
pay_Rate
number or null <double> 
Rate of pay for the Member at the associated occupation.


 
pay_Rate_Frequency
string or null  <= 16 characters 
Frequency of the rate of pay for the Member at the associated occupation.


 
term_Date
string or null <date-time> 
Date when the occupation expires/expired for the Member.


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