Contact Phone

Create ContactPhone

Creates a new ContactPhone

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
contactPhone_Key
required
integer <int32>

ID of the contact phone number. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

contact_Key
required
integer <int32>

ID of the contact. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

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

phone_Country_Code
string or null <= 8 characters

Country code of the contact's phone number.

phone_Number
string or null <= 32 characters

Phone number of the contact.

phone_Type
required
string [ 1 .. 16 ] characters

Identifies the type of phone number.

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/contact-phones
Request samples
{
  • "contactPhone_Key": 0,
  • "contact_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "phone_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ContactPhone

Lists all ContactPhone

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/contact-phones
Request samples 
Response samples 
No sample
Get ContactPhone
Gets ContactPhone


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ContactPhone_Key
required
integer <int32> 
ContactPhone Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/contact-phones/{ContactPhone_Key}
Request samples 
Response samples 
No sample
Update ContactPhone
Updates a specific ContactPhone.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ContactPhone_Key
required
integer <int32> 
ContactPhone Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
contactPhone_Key
required
integer <int32> 
ID of the contact phone number.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
contact_Key
required
integer <int32> 
ID of the contact.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the contact's phone number.


 
phone_Number
string or null  <= 32 characters 
Phone number of the contact.


 
phone_Type
required
string  [ 1 .. 16 ] characters 
Identifies the type of phone number.


 
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/contact-phones/{ContactPhone_Key}
Request samples 
{
  • "contactPhone_Key": 0,
  • "contact_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "phone_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ContactPhone
Deletes an ContactPhone


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ContactPhone_Key
required
integer <int32> 
ContactPhone Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/contact-phones/{ContactPhone_Key}
Request samples 
Create or Update Batch ContactPhone
Create or Update multiple ContactPhone 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 
contactPhone_Key
required
integer <int32> 
ID of the contact phone number.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
contact_Key
required
integer <int32> 
ID of the contact.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the contact's phone number.


 
phone_Number
string or null  <= 32 characters 
Phone number of the contact.


 
phone_Type
required
string  [ 1 .. 16 ] characters 
Identifies the type of phone number.


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