The coworkermsofficecalendar object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this coworkermsofficecalendar |
CalendarId: string required |
CoworkerId: Id optional |
Name: string required |
ResourceId: Id required |
SubscriptionExpireDate: DateTime required |
SubscriptionId: string required |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkermsofficecalendar |
SystemId: string optional api-only
User defined data about this coworkermsofficecalendar. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"CalendarId": "00001",
"CoworkerId": 12345678,
"Name": "00001",
"ResourceId": 12345678,
"SubscriptionExpireDate": 2020-01-01T21:03:54Z,
"SubscriptionId": "00001",
"UniqueId": "995fbc9b-e786-42b6-a140-c081e44d48d4",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a CoworkerMsOfficeCalendar
This endpoint allows you to GET a list of coworkermsofficecalendars based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars?...
π Requires role "CoworkerMsOfficeCalendar-List"
Pagination querystring parameters
Lets control how many records to return at a time and their order. |
page integer optional
?page=1 |
size integer optional default=25
Sets the maximum number of records to return each page of results. ?size=25 |
orderby string optional default=Id
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search coworkermsofficecalendar records based on their different properties. |
Id number
?Id=12345678 |
CoworkerMsOfficeCalendar_CalendarId string
?CoworkerMsOfficeCalendar_CalendarId=... |
CoworkerMsOfficeCalendar_Coworker Coworker
?CoworkerMsOfficeCalendar_Coworker=... |
CoworkerMsOfficeCalendar_Name string
?CoworkerMsOfficeCalendar_Name=... |
CoworkerMsOfficeCalendar_Resource Resource
?CoworkerMsOfficeCalendar_Resource=... |
CoworkerMsOfficeCalendar_SubscriptionExpireDate DateTime
?CoworkerMsOfficeCalendar_SubscriptionExpireDate=... |
CoworkerMsOfficeCalendar_SubscriptionId string
?CoworkerMsOfficeCalendar_SubscriptionId=... |
CoworkerMsOfficeCalendar_CoworkerFullName string
?CoworkerMsOfficeCalendar_CoworkerFullName=... |
Range search querystring parameters
Lets you search coworkermsofficecalendar records based on a range of date or numeric values. |
To_CoworkerMsOfficeCalendar_CreatedOn date
?To_CoworkerMsOfficeCalendar_CreatedOn=2010-01-01T20:32 |
From_CoworkerMsOfficeCalendar_CreatedOn date
?From_CoworkerMsOfficeCalendar_CreatedOn=2010-01-01T20:32 |
To_CoworkerMsOfficeCalendar_UpdatedOn date
?To_CoworkerMsOfficeCalendar_UpdatedOn=2010-01-01T20:32 |
From_CoworkerMsOfficeCalendar_UpdatedOn date
?From_CoworkerMsOfficeCalendar_UpdatedOn=2010-01-01T20:32 |
To_CoworkerMsOfficeCalendar_SubscriptionExpireDate date
?To_CoworkerMsOfficeCalendar_SubscriptionExpireDate=2010-01-01T20:32 |
From_CoworkerMsOfficeCalendar_SubscriptionExpireDate date
?From_CoworkerMsOfficeCalendar_SubscriptionExpireDate=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars?CoworkerMsOfficeCalendar_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Resource": ,
"Coworker": ,
"Name": "00001",
"SubscriptionId": "00001",
"CalendarId": "00001",
"SubscriptionExpireDate": 2020-01-01T21:03:54Z,
"CoworkerMsOfficeCalendarCoworkerFullName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "c0a7f062-0f42-476d-8999-ba5beb9bd878",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 25,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 60,
"TotalPages": 3
}
Find CoworkerMsOfficeCalendars by IDs
Gets one or more coworkermsofficecalendar records based on their Id.GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars?CoworkerMsOfficeCalendar_Id=[:id1,:id2,...]
π Requires role "CoworkerMsOfficeCalendar-List"
Querystring parameters |
CoworkerMsOfficeCalendar_Id: array requried
?CoworkerMsOfficeCalendar_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars?CoworkerMsOfficeCalendar_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Resource": ,
"Coworker": ,
"Name": "00001",
"SubscriptionId": "00001",
"CalendarId": "00001",
"SubscriptionExpireDate": 2020-01-01T21:03:54Z,
"CoworkerMsOfficeCalendarCoworkerFullName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "d3426c21-b94c-49ef-9f85-e5f3e818c1fc",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single CoworkerMsOfficeCalendar by Id
Gets one coworkermsofficecalendar record by its Id.GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/:Id
π Requires role "CoworkerMsOfficeCalendar-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"CalendarId": "00001",
"CoworkerId": 12345678,
"Name": "00001",
"ResourceId": 12345678,
"SubscriptionExpireDate": 2020-01-01T21:03:54Z,
"SubscriptionId": "00001",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "9100dcc0-608d-4e7f-8710-36dfddc6ce68",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new CoworkerMsOfficeCalendar
Creates a new coworkermsofficecalendar.POST https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars
π Requires role "CoworkerMsOfficeCalendar-Create"
Body parameters |
ResourceId: number required |
CoworkerId: number optional |
Name: string required |
SubscriptionId: string required |
CalendarId: string required |
SubscriptionExpireDate: DateTime required |
Example request
POST https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"ResourceId": 12345678,
"CoworkerId": 12345678,
"Name": "00001",
"SubscriptionId": "00001",
"CalendarId": "00001",
"SubscriptionExpireDate": 2020-01-01T21:03:54Z,
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully created.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Update CoworkerMsOfficeCalendar
Updates an existing coworkermsofficecalendar.PUT https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "CoworkerMsOfficeCalendar-Edit"
Body parameters |
Id: number required
The unique Id of the coworkermsofficecalendar to update. |
ResourceId: number cleared if missing |
CoworkerId: number cleared if missing |
Name: string cleared if missing |
SubscriptionId: string cleared if missing |
CalendarId: string cleared if missing |
SubscriptionExpireDate: DateTime cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"ResourceId": 12345678,
"CoworkerId": 12345678,
"Name": "00001",
"SubscriptionId": "00001",
"CalendarId": "00001",
"SubscriptionExpireDate": 2020-01-01T21:03:54Z,
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully updated.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Delete CoworkerMsOfficeCalendar
Deletes an existing coworkermsofficecalendar by its Id.DELETE https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/:Id
π Requires role "CoworkerMsOfficeCalendar-Delete"
URL parameters |
Id: number required
The unique Id of the coworkermsofficecalendar to update. |
Example request
DELETE https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/12345678 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "The record was deleted successfully.",
"Value": null,
"OpenInDialog": false,
"RedirectURL": null,
"JavaScript": null,
"Errors": null
}
Commands
Commands allow to perform actions against one or more coworkermsofficecalendar records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.Get Commands
Get all commands available to run for coworkermsofficecalendar records.GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/commands
Example request
GET https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/commands Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
[
{
"Key": "COMMAND_KEY_1",
"Name": "Command 1 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": false,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": false,
"NeedsEntitiesToRun": true,
"Order": 2,
"RequiresParameters": []
},
{
"Key": "COMMAND_KEY_2",
"Name": "Command 2 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": true,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": true,
"NeedsEntitiesToRun": true,
"Order": 10,
"RequiresParameters":
[
{
"Name": "Parameter 1 description",
"Type": "string",
},
{
"Name": "Parameter 2 description",
"Type": "Boolean",
}
]
},
...
]
Run Command
Runs a command based on its Key and one or more coworkermsofficecalendar record IDs.POST https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/runacommandπ Requires role "CoworkerMsOfficeCalendar-Edit"
Example request
POST https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars/runcommand Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Ids":[1329961649],
"Parameters":
[
{
"Type": "string"
"Value":987654321
},
{
"Type": "Boolean",
"Value":true
},
...
],
"Key":"COMMAND_KEY_2"
}
Example valid response
{
"Errors": null
"JavaScript": null
"Message": "Result description"
"OpenInDialog": false
"OpenInWindow": false
"RedirectURL": null
"Status": 200
"UpdatedBy": "email@example.net"
"UpdatedOn: "2020-06-04T11:40:20Z"
"Value: {Id: 12345678}
"WasSuccessful: true
}
Comments
Please sign in to leave a comment.