Contact Assignments

Create ContactAssign

Creates a new ContactAssign

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
contactAssign_Key
required
integer <int32>
assign_Priority
integer or null <int32>
assign_Type
required
string [ 1 .. 16 ] characters
contact_Key
required
integer <int32>
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
key_Column1
string or null <= 128 characters
key_Column2
string or null <= 128 characters
key_Column3
string or null <= 128 characters
key_Column4
string or null <= 128 characters
key_Column5
string or null <= 128 characters
key_DataType1
string or null <= 32 characters
key_DataType2
string or null <= 32 characters
key_DataType3
string or null <= 32 characters
key_DataType4
string or null <= 32 characters
key_DataType5
string or null <= 32 characters
key_Value1
string or null <= 128 characters
key_Value2
string or null <= 128 characters
key_Value3
string or null <= 128 characters
key_Value4
string or null <= 128 characters
key_Value5
string or null <= 128 characters
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/contact-assignments
Request samples
{
  • "contactAssign_Key": 0,
  • "assign_Priority": 0,
  • "assign_Type": "string",
  • "contact_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "key_Column1": "string",
  • "key_Column2": "string",
  • "key_Column3": "string",
  • "key_Column4": "string",
  • "key_Column5": "string",
  • "key_DataType1": "string",
  • "key_DataType2": "string",
  • "key_DataType3": "string",
  • "key_DataType4": "string",
  • "key_DataType5": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ContactAssign

Lists all ContactAssign

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-assignments
Request samples 
Response samples 
No sample
Get ContactAssign
Gets ContactAssign


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
contactAssignKey
required
integer <int32> 
ContactAssign Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/contact-assignments/{contactAssignKey}
Request samples 
Response samples 
No sample
Update ContactAssign
Updates a specific ContactAssign.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
contactAssignKey
required
integer <int32> 
ContactAssign Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
contactAssign_Key
required
integer <int32> 
 
assign_Priority
integer or null <int32> 
 
assign_Type
required
string  [ 1 .. 16 ] characters 
 
contact_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
key_Column1
string or null  <= 128 characters 
 
key_Column2
string or null  <= 128 characters 
 
key_Column3
string or null  <= 128 characters 
 
key_Column4
string or null  <= 128 characters 
 
key_Column5
string or null  <= 128 characters 
 
key_DataType1
string or null  <= 32 characters 
 
key_DataType2
string or null  <= 32 characters 
 
key_DataType3
string or null  <= 32 characters 
 
key_DataType4
string or null  <= 32 characters 
 
key_DataType5
string or null  <= 32 characters 
 
key_Value1
string or null  <= 128 characters 
 
key_Value2
string or null  <= 128 characters 
 
key_Value3
string or null  <= 128 characters 
 
key_Value4
string or null  <= 128 characters 
 
key_Value5
string or null  <= 128 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/contact-assignments/{contactAssignKey}
Request samples 
{
  • "contactAssign_Key": 0,
  • "assign_Priority": 0,
  • "assign_Type": "string",
  • "contact_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "key_Column1": "string",
  • "key_Column2": "string",
  • "key_Column3": "string",
  • "key_Column4": "string",
  • "key_Column5": "string",
  • "key_DataType1": "string",
  • "key_DataType2": "string",
  • "key_DataType3": "string",
  • "key_DataType4": "string",
  • "key_DataType5": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ContactAssign
Deletes an ContactAssign


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
contactAssignKey
required
integer <int32> 
ContactAssign Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/contact-assignments/{contactAssignKey}
Request samples 
Create or Update Batch ContactAssign
Create or Update multiple ContactAssign 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 
contactAssign_Key
required
integer <int32> 
 
assign_Priority
integer or null <int32> 
 
assign_Type
required
string  [ 1 .. 16 ] characters 
 
contact_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
key_Column1
string or null  <= 128 characters 
 
key_Column2
string or null  <= 128 characters 
 
key_Column3
string or null  <= 128 characters 
 
key_Column4
string or null  <= 128 characters 
 
key_Column5
string or null  <= 128 characters 
 
key_DataType1
string or null  <= 32 characters 
 
key_DataType2
string or null  <= 32 characters 
 
key_DataType3
string or null  <= 32 characters 
 
key_DataType4
string or null  <= 32 characters 
 
key_DataType5
string or null  <= 32 characters 
 
key_Value1
string or null  <= 128 characters 
 
key_Value2
string or null  <= 128 characters 
 
key_Value3
string or null  <= 128 characters 
 
key_Value4
string or null  <= 128 characters 
 
key_Value5
string or null  <= 128 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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