GET v1/L10NStrings
Retrieves all strings for a given client type and culture
URI template
v1/L10NStrings?lastModifiedTime={lastModifiedTime}&clientType={clientType}&cultureType={cultureType}&companyCode={companyCode}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
lastModifiedTime |
Used for checking the server side cache |
date |
Required |
clientType |
The environment for which we retrieve the strings for |
ClientType |
Required |
cultureType |
The culture should be in the following format en-US, en-AU, and es-MX |
string |
Required |
companyCode | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
A list of key value pairs that have the string key and the string value. Known internal errors are InvalidParameters
Collection of StringLiteralName | Description | Type | Additional information |
---|---|---|---|
StringKey | string |
None. |
|
Value | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "1", "StringKey": "sample string 1", "Value": "sample string 2" }, { "$id": "2", "StringKey": "sample string 3", "Value": "sample string 4" } ]
application/xml, text/xml
Sample:
<ArrayOfStringLiteral xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <StringLiteral> <StringKey>sample string 1</StringKey> <Value>sample string 2</Value> </StringLiteral> <StringLiteral> <StringKey>sample string 3</StringKey> <Value>sample string 4</Value> </StringLiteral> </ArrayOfStringLiteral>