POST {clientId}/Config/Locales

Add Locales.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.

string

Required

Body Parameters

Collection of Locales to submit

Collection of ConfigLocale
NameDescriptionTypeAdditional information
OverwriteExisting

boolean

None.

Name

string

Required

Max length: 50

Min length: 1

IsDefault

boolean

None.

Permissions

Collection of ConfigViewEditPermission

None.

ID

string

Required

Max length: 15

Min length: 1

Request Formats

application/json, text/json

Sample:
[
  {
    "OverwriteExisting": true,
    "Name": "sample string 2",
    "IsDefault": true,
    "Permissions": [
      {
        "UserGroupID": "sample string 1",
        "CanView": true,
        "CanEdit": true
      }
    ],
    "ID": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfConfigLocale xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigLocale>
    <ID>sample string 4</ID>
    <IsDefault>true</IsDefault>
    <Name>sample string 2</Name>
    <OverwriteExisting>true</OverwriteExisting>
    <Permissions>
      <ConfigViewEditPermission>
        <CanEdit>true</CanEdit>
        <CanView>true</CanView>
        <UserGroupID>sample string 1</UserGroupID>
      </ConfigViewEditPermission>
    </Permissions>
  </ConfigLocale>
</ArrayOfConfigLocale>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

  • Unauthorized (401)
  • InternalServerError (500)
  • BadRequest (400)

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.