Messages

Create Messages

Creates a new Messages

SecurityapiKeyAuth
Request
header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Request Body schema:
required
message_Key
required
integer <int32>

Gets or sets the unique identifier for the message. Note: This field is marked as NOT NULL in the database and therefore required by the API.

messageThread_Key
required
integer <int32>

Gets or sets the unique identifier for the message thread to which this message belongs. Note: This field is marked as NOT NULL in the database and therefore required by the API.

message_Body
string or null

Gets or sets the body content of the message.

message_Create_Date
string or null <date-time>

Gets or sets the date and time when the message was created.

message_Create_UserId
string or null <uuid>

Gets or sets the unique identifier of the user who created the message.

message_Status
string or null <= 32 characters

Gets or sets the status of the message. This field has a maximum length of 32 characters.

message_Type
string or null <= 32 characters

Gets or sets the type of the message. This field has a maximum length of 32 characters.

Responses
200

Success

401

Unauthorized

post/messages
Request samples
{
  • "message_Key": 0,
  • "messageThread_Key": 0,
  • "message_Body": "string",
  • "message_Create_Date": "2019-08-24T14:15:22Z",
  • "message_Create_UserId": "967ca206-05d7-4c4b-8fd8-fee4ebb68ac0",
  • "message_Status": "string",
  • "message_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Messages

Lists all Messages

SecurityapiKeyAuth
Request
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
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/messages
Request samples 
Response samples 
No sample
Get Messages
Gets Messages


SecurityapiKeyAuth 
Request 
path Parameters
Message_Key
required
integer <int32> 
Message Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/messages/{Message_Key}
Request samples 
Response samples 
No sample
Update Messages
Updates a specific Messages.


SecurityapiKeyAuth 
Request 
path Parameters
Message_Key
required
integer <int32> 
Message Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
message_Key
required
integer <int32> 
Gets or sets the unique identifier for the message.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
messageThread_Key
required
integer <int32> 
Gets or sets the unique identifier for the message thread to which this message belongs.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
message_Body
string or null
Gets or sets the body content of the message.


 
message_Create_Date
string or null <date-time> 
Gets or sets the date and time when the message was created.


 
message_Create_UserId
string or null <uuid> 
Gets or sets the unique identifier of the user who created the message.


 
message_Status
string or null  <= 32 characters 
Gets or sets the status of the message.
This field has a maximum length of 32 characters.


 
message_Type
string or null  <= 32 characters 
Gets or sets the type of the message.
This field has a maximum length of 32 characters.


 
Responses 
200
Success


401
Unauthorized


put/messages/{Message_Key}
Request samples 
{
  • "message_Key": 0,
  • "messageThread_Key": 0,
  • "message_Body": "string",
  • "message_Create_Date": "2019-08-24T14:15:22Z",
  • "message_Create_UserId": "967ca206-05d7-4c4b-8fd8-fee4ebb68ac0",
  • "message_Status": "string",
  • "message_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Messages
Deletes an Messages


SecurityapiKeyAuth 
Request 
path Parameters
Message_Key
required
integer <int32> 
Message Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/messages/{Message_Key}
Request samples 
Create or Update Batch Messages
Create or Update multiple Messages at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
 Array 
message_Key
required
integer <int32> 
Gets or sets the unique identifier for the message.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
messageThread_Key
required
integer <int32> 
Gets or sets the unique identifier for the message thread to which this message belongs.
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
message_Body
string or null
Gets or sets the body content of the message.


 
message_Create_Date
string or null <date-time> 
Gets or sets the date and time when the message was created.


 
message_Create_UserId
string or null <uuid> 
Gets or sets the unique identifier of the user who created the message.


 
message_Status
string or null  <= 32 characters 
Gets or sets the status of the message.
This field has a maximum length of 32 characters.


 
message_Type
string or null  <= 32 characters 
Gets or sets the type of the message.
This field has a maximum length of 32 characters.


 
Responses 
207
Success


401
Unauthorized


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