Member Address

Create MemberAddress

Creates a new MemberAddress

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.

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.

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.

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 work 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/{subscriberID}/members/{memberSeq}/addresses
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "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",
  • "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",
  • "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": {
    }
}

Get MemberAddress

Gets MemberAddress

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/members/{memberSeq}/addresses
Request samples
Response samples
No sample

Update MemberAddress

Updates a specific MemberAddress.

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.

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.

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.

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 work 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/{subscriberID}/members/{memberSeq}/addresses
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "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",
  • "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",
  • "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 MemberAddress

Deletes an MemberAddress

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/subscribers/{subscriberID}/members/{memberSeq}/addresses
Request samples