Member Address History

Create MemberAddressHistory

Creates a new MemberAddressHistory

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Subscriber_ID
required
string

Subscriber ID

Member_Seq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
memberAddressHistory_Key
required
integer <int32>

ID of the Member Address History record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

address
string or null <= 128 characters

Primary address of the Member.

address2
string or null <= 128 characters

Address line 2 of the Member's primary address.

cell_Country_Code
string or null <= 8 characters

Country code of the Member's cell phone number.

cell_Phone
string or null <= 32 characters

Cell phone number of the Member.

city
string or null <= 32 characters

City of the Member's primary address.

country_ID
string or null <= 8 characters

Identifier of the country of the Member's primary address.

county_Code
string or null <= 8 characters

County code of the Member's primary address.

effective_Date
string or null <date-time>

Date when the Member Address becomes/became effective.

email_Address
string or null <= 128 characters

Email address of the Member.

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.

home_Country_Code
string or null <= 8 characters

Country code of the Member's home phone number.

home_Phone
string or null <= 32 characters

Home phone number of the Member.

latitude
string or null <= 12 characters

Latitudinal coordinate of the Member's primary address.

longitude
string or null <= 13 characters

Longitudinal coordinate of the Member's primary address.

member_Seq
required
string [ 1 .. 2 ] characters

Sequential identifier assigned to the Member.

region_Code
string or null <= 32 characters

Region code of the Member's primary address.

secondary_Address
string or null <= 128 characters

Secondary address associated with the Member.

secondary_Address2
string or null <= 256 characters

Line 2 of secondary address associated with the Member.

secondary_City
string or null <= 32 characters

City of the Member's secondary address.

secondary_County_Code
string or null <= 8 characters

County code of the Secondary Address

secondary_State
string or null <= 2 characters

State of the Member's secondary address.

secondary_Zip_Code
string or null <= 10 characters

Zip code of the Member's secondary address.

state
string or null <= 2 characters

State of the Member's primary address.

subscriber_ID
required
string [ 1 .. 9 ] characters

Identifier assigned to the Subscriber associated with this Member.

term_Date
string or null <date-time>

Date when the Member Address is no longer valid/effective.

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.

work_Country_Code
string or null <= 8 characters

Country code of the Member's home phone number.

work_Phone
string or null <= 32 characters

Work phone number of the Member.

zip_Code
string or null <= 32 characters

Zip code of the Member's primary address.

Responses
200

Success

401

Unauthorized

post/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history
Request samples
{
  • "memberAddressHistory_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "cell_Country_Code": "string",
  • "cell_Phone": "string",
  • "city": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "home_Country_Code": "string",
  • "home_Phone": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "member_Seq": "st",
  • "region_Code": "string",
  • "secondary_Address": "string",
  • "secondary_Address2": "string",
  • "secondary_City": "string",
  • "secondary_County_Code": "string",
  • "secondary_State": "st",
  • "secondary_Zip_Code": "string",
  • "state": "st",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "work_Country_Code": "string",
  • "work_Phone": "string",
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberAddressHistory

Lists all MemberAddressHistory for the given Subscriber_ID and Member_Seq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Subscriber_ID
required
string

Subscriber ID

Member_Seq
required
string

Member Seq

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/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history
Request samples 
Response samples 
No sample
Get MemberAddressHistory
Gets MemberAddressHistory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Subscriber_ID
required
string
Subscriber ID


 
Member_Seq
required
string
Member Seq


 
MemberAddressHistory_Key
required
integer <int32> 
MemberAddressHistory Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history/{MemberAddressHistory_Key}
Request samples 
Response samples 
No sample
Update MemberAddressHistory
Updates a specific MemberAddressHistory.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Subscriber_ID
required
string
Subscriber ID


 
Member_Seq
required
string
Member Seq


 
MemberAddressHistory_Key
required
integer <int32> 
MemberAddressHistory Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberAddressHistory_Key
required
integer <int32> 
ID of the Member Address History record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
address
string or null  <= 128 characters 
Primary address of the Member.


 
address2
string or null  <= 128 characters 
Address line 2 of the Member's primary address.


 
cell_Country_Code
string or null  <= 8 characters 
Country code of the Member's cell phone number.


 
cell_Phone
string or null  <= 32 characters 
Cell phone number of the Member.


 
city
string or null  <= 32 characters 
City of the Member's primary address.


 
country_ID
string or null  <= 8 characters 
Identifier of the country of the Member's primary address.


 
county_Code
string or null  <= 8 characters 
County code of the Member's primary address.


 
effective_Date
string or null <date-time> 
Date when the Member Address becomes/became effective.


 
email_Address
string or null  <= 128 characters 
Email address of the Member.


 
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.


 
home_Country_Code
string or null  <= 8 characters 
Country code of the Member's home phone number.


 
home_Phone
string or null  <= 32 characters 
Home phone number of the Member.


 
latitude
string or null  <= 12 characters 
Latitudinal coordinate of the Member's primary address.


 
longitude
string or null  <= 13 characters 
Longitudinal coordinate of the Member's primary address.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
Sequential identifier assigned to the Member.


 
region_Code
string or null  <= 32 characters 
Region code of the Member's primary address.


 
secondary_Address
string or null  <= 128 characters 
Secondary address associated with the Member.


 
secondary_Address2
string or null  <= 256 characters 
Line 2 of secondary address associated with the Member.


 
secondary_City
string or null  <= 32 characters 
City of the Member's secondary address.


 
secondary_County_Code
string or null  <= 8 characters 
County code of the Secondary Address


 
secondary_State
string or null  <= 2 characters 
State of the Member's secondary address.


 
secondary_Zip_Code
string or null  <= 10 characters 
Zip code of the Member's secondary address.


 
state
string or null  <= 2 characters 
State of the Member's primary address.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
Identifier assigned to the Subscriber associated with this Member.


 
term_Date
string or null <date-time> 
Date when the Member Address is no longer valid/effective.


 
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.


 
work_Country_Code
string or null  <= 8 characters 
Country code of the Member's home phone number.


 
work_Phone
string or null  <= 32 characters 
Work phone number of the Member.


 
zip_Code
string or null  <= 32 characters 
Zip code of the Member's primary address.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history/{MemberAddressHistory_Key}
Request samples 
{
  • "memberAddressHistory_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "cell_Country_Code": "string",
  • "cell_Phone": "string",
  • "city": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "home_Country_Code": "string",
  • "home_Phone": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "member_Seq": "st",
  • "region_Code": "string",
  • "secondary_Address": "string",
  • "secondary_Address2": "string",
  • "secondary_City": "string",
  • "secondary_County_Code": "string",
  • "secondary_State": "st",
  • "secondary_Zip_Code": "string",
  • "state": "st",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "work_Country_Code": "string",
  • "work_Phone": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberAddressHistory
Deletes an MemberAddressHistory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Subscriber_ID
required
string
Subscriber ID


 
Member_Seq
required
string
Member Seq


 
MemberAddressHistory_Key
required
integer <int32> 
MemberAddressHistory Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history/{MemberAddressHistory_Key}
Request samples 
Create or Update Batch MemberAddressHistory
Create or Update multiple MemberAddressHistory 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
Subscriber_ID
required
string
Subscriber ID


 
Member_Seq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
memberAddressHistory_Key
required
integer <int32> 
ID of the Member Address History record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
address
string or null  <= 128 characters 
Primary address of the Member.


 
address2
string or null  <= 128 characters 
Address line 2 of the Member's primary address.


 
cell_Country_Code
string or null  <= 8 characters 
Country code of the Member's cell phone number.


 
cell_Phone
string or null  <= 32 characters 
Cell phone number of the Member.


 
city
string or null  <= 32 characters 
City of the Member's primary address.


 
country_ID
string or null  <= 8 characters 
Identifier of the country of the Member's primary address.


 
county_Code
string or null  <= 8 characters 
County code of the Member's primary address.


 
effective_Date
string or null <date-time> 
Date when the Member Address becomes/became effective.


 
email_Address
string or null  <= 128 characters 
Email address of the Member.


 
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.


 
home_Country_Code
string or null  <= 8 characters 
Country code of the Member's home phone number.


 
home_Phone
string or null  <= 32 characters 
Home phone number of the Member.


 
latitude
string or null  <= 12 characters 
Latitudinal coordinate of the Member's primary address.


 
longitude
string or null  <= 13 characters 
Longitudinal coordinate of the Member's primary address.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
Sequential identifier assigned to the Member.


 
region_Code
string or null  <= 32 characters 
Region code of the Member's primary address.


 
secondary_Address
string or null  <= 128 characters 
Secondary address associated with the Member.


 
secondary_Address2
string or null  <= 256 characters 
Line 2 of secondary address associated with the Member.


 
secondary_City
string or null  <= 32 characters 
City of the Member's secondary address.


 
secondary_County_Code
string or null  <= 8 characters 
County code of the Secondary Address


 
secondary_State
string or null  <= 2 characters 
State of the Member's secondary address.


 
secondary_Zip_Code
string or null  <= 10 characters 
Zip code of the Member's secondary address.


 
state
string or null  <= 2 characters 
State of the Member's primary address.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
Identifier assigned to the Subscriber associated with this Member.


 
term_Date
string or null <date-time> 
Date when the Member Address is no longer valid/effective.


 
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.


 
work_Country_Code
string or null  <= 8 characters 
Country code of the Member's home phone number.


 
work_Phone
string or null  <= 32 characters 
Work phone number of the Member.


 
zip_Code
string or null  <= 32 characters 
Zip code of the Member's primary address.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{Subscriber_ID}/members/{Member_Seq}/address-history-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}