Reference

Language

The language object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this language
Active: bool optional
BusinessId: Id required
Culture: string required
DisplayOrder: int required
Name: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this language
SystemId: string optional api-only
User defined data about this language. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "Culture": "Culture",
  "DisplayOrder": ,
  "Name": "Name",
  "UniqueId": "5f320036-c9a7-40eb-8449-cdc0ddecbd1d",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a Language

This endpoint allows you to GET a list of languages based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/sys/languages?...

πŸ”’ Requires role "Language-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 language records based on their different properties.
Id number
?Id=12345678
Language_Active bool
?Language_Active=...
Language_Business Business
?Language_Business=...
Language_Culture string
?Language_Culture=...
Language_DisplayOrder int
?Language_DisplayOrder=...
Language_Name string
?Language_Name=...
Language_BusinessName string
?Language_BusinessName=...

Range search querystring parameters
Lets you search language records based on a range of date or numeric values.
To_Language_CreatedOn date
?To_Language_CreatedOn=2010-01-01T20:32
From_Language_CreatedOn date
?From_Language_CreatedOn=2010-01-01T20:32
To_Language_UpdatedOn date
?To_Language_UpdatedOn=2010-01-01T20:32
From_Language_UpdatedOn date
?From_Language_UpdatedOn=2010-01-01T20:32
To_Language_DisplayOrder number
?To_Language_DisplayOrder=0
From_Language_DisplayOrder number
?From_Language_DisplayOrder=10

Example request

GET https://spaces.nexudus.com/api/sys/languages?Language_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Culture": "Culture",
        "Active": false,
        "DisplayOrder": ,
        "LanguageBusinessName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "8fa4926c-2ab4-4ba8-9773-a0530122f961",
        "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 Languages by IDs

Gets one or more language records based on their Id.
GET https://spaces.nexudus.com/api/sys/languages?Language_Id=[:id1,:id2,...]

πŸ”’ Requires role "Language-List"

Querystring parameters
Language_Id: array requried
?Language_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/sys/languages?Language_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Culture": "Culture",
        "Active": false,
        "DisplayOrder": ,
        "LanguageBusinessName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "2f4d32c3-16d1-4f43-8ccd-ef48b878e2bc",
        "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 Language by Id

Gets one language record by its Id.
GET https://spaces.nexudus.com/api/sys/languages/:Id

πŸ”’ Requires role "Language-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/sys/languages/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "Culture": "Culture",
  "DisplayOrder": ,
  "Name": "Name",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "53860840-f195-4b42-88b6-9e7cfe7a4c97",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new Language

Creates a new language.
POST https://spaces.nexudus.com/api/sys/languages

πŸ”’ Requires role "Language-Create"

Body parameters
BusinessId: number required
Name: string required
Culture: string required
Active: bool optional
DisplayOrder: int required

Example request

POST https://spaces.nexudus.com/api/sys/languages
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "Name": "Name",
    "Culture": "Culture",
    "Active": false,
    "DisplayOrder": ,
}


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 Language

Updates an existing language.
PUT https://spaces.nexudus.com/api/sys/languages

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "Language-Edit"

Body parameters
Id: number required
The unique Id of the language to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Culture: string cleared if missing
Active: bool cleared if missing
DisplayOrder: int cleared if missing

Example request

PUT https://spaces.nexudus.com/api/sys/languages
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "Culture": "Culture",
    "Active": false,
    "DisplayOrder": ,
}


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 Language

Deletes an existing language by its Id.
DELETE https://spaces.nexudus.com/api/sys/languages/:Id

πŸ”’ Requires role "Language-Delete"

URL parameters
Id: number required
The unique Id of the language to update.

Example request

DELETE https://spaces.nexudus.com/api/sys/languages/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 language 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 language records.
GET https://spaces.nexudus.com/api/sys/languages/commands

Example request

GET https://spaces.nexudus.com/api/sys/languages/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 language record IDs.
POST https://spaces.nexudus.com/api/sys/languages/runacommand
πŸ”’ Requires role "Language-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/languages/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
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.