The simpletimezone object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this simpletimezone |
Description: string required |
Name: string required |
TimeOffset: string required |
UsesSummerTime: bool optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this simpletimezone |
SystemId: string optional api-only
User defined data about this simpletimezone. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"Description": "(UTC) Dublin, Edinburgh, Lisbon, London",
"Name": "GMT Standard Time",
"TimeOffset": "0:00",
"UsesSummerTime": false,
"UniqueId": "b4153229-3326-4f00-86a0-35a6ce9c6e3d",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a SimpleTimeZone
This endpoint allows you to GET a list of simpletimezones based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/sys/simpletimezones?...
๐ Requires role "SimpleTimeZone-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=TimeOffset
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Descending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search simpletimezone records based on their different properties. |
Id number
?Id=12345678 |
SimpleTimeZone_Description string
?SimpleTimeZone_Description=... |
SimpleTimeZone_Name string
?SimpleTimeZone_Name=... |
SimpleTimeZone_TimeOffset string
?SimpleTimeZone_TimeOffset=... |
SimpleTimeZone_UsesSummerTime bool
?SimpleTimeZone_UsesSummerTime=... |
Range search querystring parameters
Lets you search simpletimezone records based on a range of date or numeric values. |
To_SimpleTimeZone_CreatedOn date
?To_SimpleTimeZone_CreatedOn=2010-01-01T20:32 |
From_SimpleTimeZone_CreatedOn date
?From_SimpleTimeZone_CreatedOn=2010-01-01T20:32 |
To_SimpleTimeZone_UpdatedOn date
?To_SimpleTimeZone_UpdatedOn=2010-01-01T20:32 |
From_SimpleTimeZone_UpdatedOn date
?From_SimpleTimeZone_UpdatedOn=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/sys/simpletimezones?SimpleTimeZone_Description=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "GMT Standard Time",
"Description": "(UTC) Dublin, Edinburgh, Lisbon, London",
"TimeOffset": "0:00",
"UsesSummerTime": false,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "2b347661-6fea-498b-8a48-46c54cf9ae83",
"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 SimpleTimeZones by IDs
Gets one or more simpletimezone records based on their Id.GET https://spaces.nexudus.com/api/sys/simpletimezones?SimpleTimeZone_Id=[:id1,:id2,...]
๐ Requires role "SimpleTimeZone-List"
Querystring parameters |
SimpleTimeZone_Id: array requried
?SimpleTimeZone_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/sys/simpletimezones?SimpleTimeZone_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "GMT Standard Time",
"Description": "(UTC) Dublin, Edinburgh, Lisbon, London",
"TimeOffset": "0:00",
"UsesSummerTime": false,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "1f86d5b5-28ed-4769-bd9a-62f08260ba02",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "TimeOffset",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single SimpleTimeZone by Id
Gets one simpletimezone record by its Id.GET https://spaces.nexudus.com/api/sys/simpletimezones/:Id
๐ Requires role "SimpleTimeZone-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/sys/simpletimezones/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"Description": "(UTC) Dublin, Edinburgh, Lisbon, London",
"Name": "GMT Standard Time",
"TimeOffset": "0:00",
"UsesSummerTime": false,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "68006596-c9fc-41a6-a6ac-5c115ca1d190",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new SimpleTimeZone
Creates a new simpletimezone.POST https://spaces.nexudus.com/api/sys/simpletimezones
๐ Requires role "SimpleTimeZone-Create"
Body parameters |
Name: string required |
Description: string required |
TimeOffset: string required |
UsesSummerTime: bool optional |
Example request
POST https://spaces.nexudus.com/api/sys/simpletimezones Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Name": "GMT Standard Time",
"Description": "(UTC) Dublin, Edinburgh, Lisbon, London",
"TimeOffset": "0:00",
"UsesSummerTime": false,
}
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 SimpleTimeZone
Updates an existing simpletimezone.PUT https://spaces.nexudus.com/api/sys/simpletimezones
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
๐ Requires role "SimpleTimeZone-Edit"
Body parameters |
Id: number required
The unique Id of the simpletimezone to update. |
Name: string cleared if missing |
Description: string cleared if missing |
TimeOffset: string cleared if missing |
UsesSummerTime: bool cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/sys/simpletimezones Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"Name": "GMT Standard Time",
"Description": "(UTC) Dublin, Edinburgh, Lisbon, London",
"TimeOffset": "0:00",
"UsesSummerTime": false,
}
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"
},
]
}
Commands
Commands allow to perform actions against one or more simpletimezone 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 simpletimezone records.GET https://spaces.nexudus.com/api/sys/simpletimezones/commands
Example request
GET https://spaces.nexudus.com/api/sys/simpletimezones/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 simpletimezone record IDs.POST https://spaces.nexudus.com/api/sys/simpletimezones/runacommand๐ Requires role "SimpleTimeZone-Edit"
Example request
POST https://spaces.nexudus.com/api/sys/simpletimezones/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.