Skip to main content

Location internal nicknames validation rules for length, content restrictions, and uniqueness requirements

Internal Nicknames

CountOfInternalNicknamesMustNotExceedThreshold

DefinitionSeverityAPISampleMode
Validate that the list of internal nicknames is equal to or less than one (1)
VIOLATION
POST_AND_PUT
S

InternalNicknamesListMustNotIncludeNulls

DefinitionSeverityAPISampleMode
Validate that a list does not include null
VIOLATION
POST_AND_PUT
S

Name

Preconditions
internalNicknames is present

InternalNicknamesNameMustBePresent

DefinitionSeverityAPISampleMode
Validate that name is present
VIOLATION
POST_AND_PUT
Link
S

InternalNicknamesNameMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that name is not an empty string
VIOLATION
POST_AND_PUT
S

InternalNicknamesMustNotBeEmptyArray

DefinitionSeverityAPISampleMode
Validate that internalNicknames is not an empty array
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__InternalNicknamesMustNotBeEmptyArray",
"message": "'{{field}}' must be omitted or contain at least one element; empty arrays are not allowed.",
"severity": "VIOLATION",
"context": {
"field": "internalNicknames"
},
"details": {
"compared": [],
"expected": [],
"submitted": [
{
"field": "$.locationDetails.internalNicknames",
"value": "[]"
}
],
"createdDate": "2026-03-03T13:58:43.946Z"
}
}

InternalNicknamesNameMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that name length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
S

InternalNicknamesNameMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that name does not include a URL
VIOLATION
POST_AND_PUT
Link
S

InternalNicknamesNameHasUnsupportedCharacter

DefinitionSeverityAPISampleMode
Validate that name does not include an unsupported character
VIOLATION
POST_AND_PUT
Link
S

Locale

Preconditions
internalNicknames is present

InternalNicknamesLocaleMustBePresent

DefinitionSeverityAPISampleMode
Validate that locale is present
VIOLATION
POST_AND_PUT
Link
S

InternalNicknamesLocaleMustBeValid

DefinitionSeverityAPISampleMode
Validate that locale is valid
VIOLATION
POST_AND_PUT
Link
S

InternalNicknamesLocaleMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that locale is not an empty string
VIOLATION
POST_AND_PUT
S