Announcement

Create Announcement

Creates a new Announcement

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
announcement_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

announcement_Body
string or null
announcement_Date
string or null <date-time>
announcement_End
string or null <date-time>
announcement_Source
string or null <= 32 characters
announcement_Source_UserId
string or null <uuid>
announcement_Status
string or null <= 32 characters
announcement_Title
string or null <= 256 characters
announcement_Type
string or null <= 32 characters
Responses
200

Success

401

Unauthorized

post/announcements
Request samples
{
  • "announcement_Key": 0,
  • "announcement_Body": "string",
  • "announcement_Date": "2019-08-24T14:15:22Z",
  • "announcement_End": "2019-08-24T14:15:22Z",
  • "announcement_Source": "string",
  • "announcement_Source_UserId": "755b1d2e-1274-4e07-a2be-cb4c2b7f67b4",
  • "announcement_Status": "string",
  • "announcement_Title": "string",
  • "announcement_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Announcement

Lists all Announcement

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


SecurityapiKeyAuth 
Request 
path Parameters
Announcement_Key
required
integer <int32> 
Announcement 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/announcements/{Announcement_Key}
Request samples 
Response samples 
No sample
Update Announcement
Updates a specific Announcement.


SecurityapiKeyAuth 
Request 
path Parameters
Announcement_Key
required
integer <int32> 
Announcement 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
announcement_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
announcement_Body
string or null
 
announcement_Date
string or null <date-time> 
 
announcement_End
string or null <date-time> 
 
announcement_Source
string or null  <= 32 characters 
 
announcement_Source_UserId
string or null <uuid> 
 
announcement_Status
string or null  <= 32 characters 
 
announcement_Title
string or null  <= 256 characters 
 
announcement_Type
string or null  <= 32 characters 
 
Responses 
200
Success


401
Unauthorized


put/announcements/{Announcement_Key}
Request samples 
{
  • "announcement_Key": 0,
  • "announcement_Body": "string",
  • "announcement_Date": "2019-08-24T14:15:22Z",
  • "announcement_End": "2019-08-24T14:15:22Z",
  • "announcement_Source": "string",
  • "announcement_Source_UserId": "755b1d2e-1274-4e07-a2be-cb4c2b7f67b4",
  • "announcement_Status": "string",
  • "announcement_Title": "string",
  • "announcement_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Announcement
Deletes an Announcement


SecurityapiKeyAuth 
Request 
path Parameters
Announcement_Key
required
integer <int32> 
Announcement 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/announcements/{Announcement_Key}
Request samples 
Create or Update Batch Announcement
Create or Update multiple Announcement 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 
announcement_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
announcement_Body
string or null
 
announcement_Date
string or null <date-time> 
 
announcement_End
string or null <date-time> 
 
announcement_Source
string or null  <= 32 characters 
 
announcement_Source_UserId
string or null <uuid> 
 
announcement_Status
string or null  <= 32 characters 
 
announcement_Title
string or null  <= 256 characters 
 
announcement_Type
string or null  <= 32 characters 
 
Responses 
207
Success


401
Unauthorized


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