GET {clientId}/Config/Frequencies

Retrieve all Frequencies.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.	string	Required

Body Parameters

None.

Response Information

Response Codes

Unauthorized (401)
InternalServerError (500)

Resource Description

Collection of ConfigFrequency

Name	Type	Additional information
Link	integer	None.
ID	string	Required Max length: 20 Min length: 1
DisplayName	string	Required Max length: 50 Min length: 1
Description	string	Max length: 256
IsDefault	boolean	Required
Locales	Collection of ConfigFrequencyLocale	Required
Permissions	Collection of ConfigViewEditPermission	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Link": 1,
    "ID": "sample string 2",
    "DisplayName": "sample string 3",
    "Description": "sample string 4",
    "IsDefault": true,
    "Locales": [
      {
        "Description": "sample string 1",
        "Name": "sample string 1",
        "ID": "sample string 2"
      }
    ],
    "Permissions": [
      {
        "UserGroupID": "sample string 1",
        "CanView": true,
        "CanEdit": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfConfigFrequency xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigFrequency>
    <Description>sample string 4</Description>
    <DisplayName>sample string 3</DisplayName>
    <ID>sample string 2</ID>
    <IsDefault>true</IsDefault>
    <Link>1</Link>
    <Locales>
      <ConfigFrequencyLocale>
        <ID>sample string 2</ID>
        <Description>sample string 1</Description>
        <Name>sample string 1</Name>
      </ConfigFrequencyLocale>
    </Locales>
    <Permissions>
      <ConfigViewEditPermission>
        <CanEdit>true</CanEdit>
        <CanView>true</CanView>
        <UserGroupID>sample string 1</UserGroupID>
      </ConfigViewEditPermission>
    </Permissions>
  </ConfigFrequency>
</ArrayOfConfigFrequency>