POST example/api/Event
https://app.bwz.se/bedrock/example/api/Event
Create an EventModel.
Request Information
URI Parameters
None.
Body Parameters
A model containing information about an online meeting.
CreateEventArgsName | Description | Type | Additional information |
---|---|---|---|
Name |
Name of the Event. |
string |
Required Valid name with max 256 characters |
Description |
Description of the Event. |
string |
None. |
PublicationId |
PublicationId of the Event. |
integer |
None. |
Location |
[Deprecated] Location of the Event. |
string |
None. |
MaxParticipants |
Maximum amount of participiants in the Event. |
integer |
None. |
GoalParticipants |
Expected amount of participant in the Event. |
integer |
None. |
RegistrationOpens |
When registration opens for the Event. |
date |
None. |
RegistrationCloses |
When registration closes for the Event. |
date |
None. |
EventStart |
When the Event starts. |
date |
None. |
EventEnd |
When the Event ends. |
date |
None. |
HasPhysicalLocation |
Does the Event have a physical location? |
boolean |
None. |
HasOnlineMeeting |
Does the Event have an online meeting? |
boolean |
None. |
PhysicalMeeting |
A model containing information about a physical meeting. |
PhysicalMeetingModel |
None. |
OnlineMeeting |
A model containing information about an online meeting. |
OnlineMeetingModel |
None. |
Request Formats
application/json, text/json
{ "Name": "sample string 1", "Description": "sample string 2", "PublicationId": 3, "Location": "sample string 4", "MaxParticipants": 1, "GoalParticipants": 1, "RegistrationOpens": "2024-11-21T17:27:26.1926319+01:00", "RegistrationCloses": "2024-11-21T17:27:26.1926319+01:00", "EventStart": "2024-11-21T17:27:26.1926319+01:00", "EventEnd": "2024-11-21T17:27:26.1926319+01:00", "HasPhysicalLocation": true, "HasOnlineMeeting": true, "PhysicalMeeting": { "Location": "sample string 1", "PlaceId": "sample string 2", "Longitude": "sample string 3", "Latitude": "sample string 4" }, "OnlineMeeting": { "MeetingUrl": "sample string 1", "MeetingDetails": "sample string 2" } }
application/xml, text/xml
<CreateEventArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Event"> <Description>sample string 2</Description> <EventEnd>2024-11-21T17:27:26.1926319+01:00</EventEnd> <EventStart>2024-11-21T17:27:26.1926319+01:00</EventStart> <GoalParticipants>1</GoalParticipants> <HasOnlineMeeting>true</HasOnlineMeeting> <HasPhysicalLocation>true</HasPhysicalLocation> <Location>sample string 4</Location> <MaxParticipants>1</MaxParticipants> <Name>sample string 1</Name> <OnlineMeeting> <MeetingDetails>sample string 2</MeetingDetails> <MeetingUrl>sample string 1</MeetingUrl> </OnlineMeeting> <PhysicalMeeting> <Latitude>sample string 4</Latitude> <Location>sample string 1</Location> <Longitude>sample string 3</Longitude> <PlaceId>sample string 2</PlaceId> </PhysicalMeeting> <PublicationId>3</PublicationId> <RegistrationCloses>2024-11-21T17:27:26.1926319+01:00</RegistrationCloses> <RegistrationOpens>2024-11-21T17:27:26.1926319+01:00</RegistrationOpens> </CreateEventArgs>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The EventModel that has been created.
EventModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Id of the Event. |
integer |
None. |
Name |
Name of the Event. |
string |
None. |
Location |
[Deprecated] Location of the Event. |
string |
None. |
Description |
Description of the Event. |
string |
None. |
PublicationId |
PublicationId of the Event. |
integer |
None. |
MaxParticipants |
Maximum amount of participiants in the Event. |
integer |
None. |
GoalParticipants |
Expected amount of participant in the Event. |
integer |
None. |
RegistrationOpens |
When registration opens for the Event. |
date |
None. |
RegistrationCloses |
When registration closes for the Event. |
date |
None. |
EventStart |
When the Event starts. |
date |
None. |
EventEnd |
When the Event ends. |
date |
None. |
CreatedByUserId |
Id of the user who created the Event. |
integer |
None. |
CreationDate |
CreationDate of the Event. |
date |
None. |
ModifiedDate |
ModifiedDate of the Event. |
date |
None. |
FormFieldProperties |
An array containing the FormFields of the Event. |
Collection of FormFieldModel |
None. |
HasPhysicalMeeting |
Does the Event have a physical location? |
boolean |
None. |
HasOnlineMeeting |
Does the Event have an online meeting? |
boolean |
None. |
PhysicalMeeting |
A model containing information about a physical meeting. |
PhysicalMeetingModel |
None. |
OnlineMeeting |
A model containing information about an online meeting. |
OnlineMeetingModel |
None. |
RegistrationLink |
The registration link for the Event. |
string |
None. |
EventHasMaxParticipants |
Is the Event full? |
boolean |
None. |
Response Formats
application/json, text/json
{ "Id": 1, "Name": "sample string 2", "Location": "sample string 3", "Description": "sample string 4", "PublicationId": 5, "MaxParticipants": 1, "GoalParticipants": 1, "RegistrationOpens": "2024-11-21T17:27:26.1926319+01:00", "RegistrationCloses": "2024-11-21T17:27:26.1926319+01:00", "EventStart": "2024-11-21T17:27:26.1926319+01:00", "EventEnd": "2024-11-21T17:27:26.1926319+01:00", "CreatedByUserId": 10, "CreationDate": "2024-11-21T17:27:26.1926319+01:00", "ModifiedDate": "2024-11-21T17:27:26.1926319+01:00", "FormFieldProperties": [ { "FormFieldId": 1, "Name": "sample string 2", "FieldType": 1, "IsRequired": true, "FieldDataType": 1, "FieldLabel": "sample string 4", "Options": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] }, { "FormFieldId": 1, "Name": "sample string 2", "FieldType": 1, "IsRequired": true, "FieldDataType": 1, "FieldLabel": "sample string 4", "Options": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] } ], "HasPhysicalMeeting": true, "HasOnlineMeeting": true, "PhysicalMeeting": { "Location": "sample string 1", "PlaceId": "sample string 2", "Longitude": "sample string 3", "Latitude": "sample string 4" }, "OnlineMeeting": { "MeetingUrl": "sample string 1", "MeetingDetails": "sample string 2" }, "RegistrationLink": "sample string 15", "EventHasMaxParticipants": true }
application/xml, text/xml
<EventModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Event"> <CreatedByUserId>10</CreatedByUserId> <CreationDate>2024-11-21T17:27:26.1926319+01:00</CreationDate> <Description>sample string 4</Description> <EventEnd>2024-11-21T17:27:26.1926319+01:00</EventEnd> <EventHasMaxParticipants>true</EventHasMaxParticipants> <EventStart>2024-11-21T17:27:26.1926319+01:00</EventStart> <FormFieldProperties xmlns:d2p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Form"> <d2p1:FormFieldModel> <d2p1:FieldDataType>Text</d2p1:FieldDataType> <d2p1:FieldLabel>sample string 4</d2p1:FieldLabel> <d2p1:FieldType>TEXT</d2p1:FieldType> <d2p1:FormFieldId>1</d2p1:FormFieldId> <d2p1:IsRequired>true</d2p1:IsRequired> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Options> <d2p1:FormFieldPossibilityModel> <d2p1:Label>sample string 2</d2p1:Label> <d2p1:Value>sample string 1</d2p1:Value> </d2p1:FormFieldPossibilityModel> <d2p1:FormFieldPossibilityModel> <d2p1:Label>sample string 2</d2p1:Label> <d2p1:Value>sample string 1</d2p1:Value> </d2p1:FormFieldPossibilityModel> </d2p1:Options> </d2p1:FormFieldModel> <d2p1:FormFieldModel> <d2p1:FieldDataType>Text</d2p1:FieldDataType> <d2p1:FieldLabel>sample string 4</d2p1:FieldLabel> <d2p1:FieldType>TEXT</d2p1:FieldType> <d2p1:FormFieldId>1</d2p1:FormFieldId> <d2p1:IsRequired>true</d2p1:IsRequired> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Options> <d2p1:FormFieldPossibilityModel> <d2p1:Label>sample string 2</d2p1:Label> <d2p1:Value>sample string 1</d2p1:Value> </d2p1:FormFieldPossibilityModel> <d2p1:FormFieldPossibilityModel> <d2p1:Label>sample string 2</d2p1:Label> <d2p1:Value>sample string 1</d2p1:Value> </d2p1:FormFieldPossibilityModel> </d2p1:Options> </d2p1:FormFieldModel> </FormFieldProperties> <GoalParticipants>1</GoalParticipants> <HasOnlineMeeting>true</HasOnlineMeeting> <HasPhysicalMeeting>true</HasPhysicalMeeting> <Id>1</Id> <Location>sample string 3</Location> <MaxParticipants>1</MaxParticipants> <ModifiedDate>2024-11-21T17:27:26.1926319+01:00</ModifiedDate> <Name>sample string 2</Name> <OnlineMeeting> <MeetingDetails>sample string 2</MeetingDetails> <MeetingUrl>sample string 1</MeetingUrl> </OnlineMeeting> <PhysicalMeeting> <Latitude>sample string 4</Latitude> <Location>sample string 1</Location> <Longitude>sample string 3</Longitude> <PlaceId>sample string 2</PlaceId> </PhysicalMeeting> <PublicationId>5</PublicationId> <RegistrationCloses>2024-11-21T17:27:26.1926319+01:00</RegistrationCloses> <RegistrationLink>sample string 15</RegistrationLink> <RegistrationOpens>2024-11-21T17:27:26.1926319+01:00</RegistrationOpens> </EventModel>