Enrolment Locales

List enrolment locale resource directories

get

/api/{tenantId}/admin/enrolmentForms/locales

Returns every locales/-rooted resource directory referenced by an enrolment form's internationalization.resources, together with the forms that reference it and the cultures it already has a file for.

Authorization

Requires tenant.configuration.enrolmentFormLocale:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Resource directories returned.

Resource directory returned by the list endpoint.

resourceDirstringRequired

Directory name under locales/, e.g. fields for locales/fields/.

formNamesstring[]Required

Enrolment forms whose internationalization.resources reference this directory.

culturesstring[]Required

Cultures that have a stored file directly inside the directory.

get/api/{tenantId}/admin/enrolmentForms/locales

GET /api/{tenantId}/admin/enrolmentForms/locales HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Resource directories returned.

[
  {
    "resourceDir": "text",
    "formNames": [
      "text"
    ],
    "cultures": [
      "text"
    ]
  }
]

Get an enrolment locale resource file

get

/api/{tenantId}/admin/enrolmentForms/locales/{culture}/{resourceDir}

Authorization

Requires tenant.configuration.enrolmentFormLocale:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

culturestringRequired

resourceDirstringRequired

tenantIdstringRequired

Responses

200

Resource file returned.

One culture's stored content, returned by the get and built by the save endpoint.

resourceDirstringRequired

Directory name, as in Neo.Web.Api.Admin.Controllers.Enrolment.EnrolmentLocalesController.EnrolmentLocaleResourceListItem.ResourceDir.

culturestringRequired

Culture the content is stored under, e.g. en.

formNamesstring[]Required

Enrolment forms whose internationalization.resources reference this directory.

valuesanyRequired

The stored tree: nested objects of string leaves.

400

Resource or culture is invalid.

404

No file stored for this resource and culture.

409

The stored file cannot be parsed.

get/api/{tenantId}/admin/enrolmentForms/locales/{culture}/{resourceDir}

GET /api/{tenantId}/admin/enrolmentForms/locales/{culture}/{resourceDir} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "resourceDir": "text",
  "culture": "text",
  "formNames": [
    "text"
  ],
  "values": null
}

Save an enrolment locale resource file

put

/api/{tenantId}/admin/enrolmentForms/locales/{culture}/{resourceDir}

Merges the request into the culture's stored tree: only the keys present in the request are touched, and every key already stored elsewhere in the tree is preserved. A key set to null, or to a blank string, is removed — M:Neo.Web.Api.Admin.Controllers.Wallet.ILocaleResourceRepository.Write(System.String,System.String,System.String,System.Collections.Generic.IReadOnlyList{System.ValueTuple{System.String[],System.String}},System.Threading.CancellationToken) applies that rule to every locale file, not just this one. An empty object leaves the tree exactly as it is stored.

Authorization

Requires tenant.configuration.enrolmentFormLocale:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

culturestringRequired

resourceDirstringRequired

Body

anyOptional

Responses

204

Resource file saved.

No content

400

Resource, culture or the request body is invalid.

409

The stored file cannot be parsed, so the request cannot be merged into it.

put/api/{tenantId}/admin/enrolmentForms/locales/{culture}/{resourceDir}

PUT /api/{tenantId}/admin/enrolmentForms/locales/{culture}/{resourceDir} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*

No content