Contacts

Create Contact

Creates a new Contact

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
contact_Key
required
integer <int32>
address
string or null <= 128 characters
address_2
string or null <= 128 characters
city
string or null <= 64 characters
contact_Category
string or null <= 16 characters
contact_Image
string or null <= 128 characters
contact_Status
string or null <= 16 characters
contact_Type
string or null <= 16 characters
contact_Web_Address
string or null <= 256 characters
country_ID
string or null <= 8 characters
county_Code
string or null <= 8 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
first_Name
string or null <= 32 characters
last_Name
string or null <= 32 characters
middle_Name
string or null <= 32 characters
org_Name
string or null <= 256 characters
qR_Code_File
string or null <= 128 characters
state
string or null <= 2 characters
title
string or null <= 128 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
zip_Code
string or null <= 16 characters
Responses
200

Success

401

Unauthorized

post/contacts
Request samples
{
  • "contact_Key": 0,
  • "address": "string",
  • "address_2": "string",
  • "city": "string",
  • "contact_Category": "string",
  • "contact_Image": "string",
  • "contact_Status": "string",
  • "contact_Type": "string",
  • "contact_Web_Address": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Name": "string",
  • "last_Name": "string",
  • "middle_Name": "string",
  • "org_Name": "string",
  • "qR_Code_File": "string",
  • "state": "st",
  • "title": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Contact

Lists all Contact

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/contacts
Request samples 
Response samples 
No sample
Get Contact
Gets Contact


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
contactKey
required
integer <int32> 
Contact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/contacts/{contactKey}
Request samples 
Response samples 
No sample
Update Contact
Updates a specific Contact.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
contactKey
required
integer <int32> 
Contact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
contact_Key
required
integer <int32> 
 
address
string or null  <= 128 characters 
 
address_2
string or null  <= 128 characters 
 
city
string or null  <= 64 characters 
 
contact_Category
string or null  <= 16 characters 
 
contact_Image
string or null  <= 128 characters 
 
contact_Status
string or null  <= 16 characters 
 
contact_Type
string or null  <= 16 characters 
 
contact_Web_Address
string or null  <= 256 characters 
 
country_ID
string or null  <= 8 characters 
 
county_Code
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
first_Name
string or null  <= 32 characters 
 
last_Name
string or null  <= 32 characters 
 
middle_Name
string or null  <= 32 characters 
 
org_Name
string or null  <= 256 characters 
 
qR_Code_File
string or null  <= 128 characters 
 
state
string or null  <= 2 characters 
 
title
string or null  <= 128 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip_Code
string or null  <= 16 characters 
 
Responses 
200
Success


401
Unauthorized


put/contacts/{contactKey}
Request samples 
{
  • "contact_Key": 0,
  • "address": "string",
  • "address_2": "string",
  • "city": "string",
  • "contact_Category": "string",
  • "contact_Image": "string",
  • "contact_Status": "string",
  • "contact_Type": "string",
  • "contact_Web_Address": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Name": "string",
  • "last_Name": "string",
  • "middle_Name": "string",
  • "org_Name": "string",
  • "qR_Code_File": "string",
  • "state": "st",
  • "title": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Contact
Deletes an Contact


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
contactKey
required
integer <int32> 
Contact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/contacts/{contactKey}
Request samples 
Create or Update Batch Contact
Create or Update multiple Contact 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 
contact_Key
required
integer <int32> 
 
address
string or null  <= 128 characters 
 
address_2
string or null  <= 128 characters 
 
city
string or null  <= 64 characters 
 
contact_Category
string or null  <= 16 characters 
 
contact_Image
string or null  <= 128 characters 
 
contact_Status
string or null  <= 16 characters 
 
contact_Type
string or null  <= 16 characters 
 
contact_Web_Address
string or null  <= 256 characters 
 
country_ID
string or null  <= 8 characters 
 
county_Code
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
first_Name
string or null  <= 32 characters 
 
last_Name
string or null  <= 32 characters 
 
middle_Name
string or null  <= 32 characters 
 
org_Name
string or null  <= 256 characters 
 
qR_Code_File
string or null  <= 128 characters 
 
state
string or null  <= 2 characters 
 
title
string or null  <= 128 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip_Code
string or null  <= 16 characters 
 
Responses 
207
Success


401
Unauthorized


put/contacts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}