Retrieve Client Details Template

GET/lokta-lms/api/v1/clients/template

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:

Field Defaults
Allowed Value Lists

Example Request:

clients/template

Query parameters

officeIdquery · integer · int64 · optional

officeId

commandParamquery · string · optional

commandParam

staffInSelectedOfficeOnlyquery · boolean · optional

staffInSelectedOfficeOnly

Responses

200OK

Response fields

activationDatestring · date · optional

datatablesarray of GetClientsDataTables · optional

officeIdinteger · int64 · optional

officeOptionsarray of GetClientsOfficeOptions · optional

savingProductOptionsarray of GetClientsSavingProductOptions · optional

staffOptionsarray of GetClientsStaffOptions · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

import requests response = requests.get( "http://localhost:8080/lokta-lms/api/v1/clients/template", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/clients/template", { method: "GET", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", }, }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/clients/template")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

req, _ := http.NewRequest("GET", "http://localhost:8080/lokta-lms/api/v1/clients/template", nil) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))