GET {clientId}/Config/ProgramPermissions

Retrieve Permissions for all Programs.

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

None.

Response Information

Response Codes

  • Unauthorized (401)
  • InternalServerError (500)

Resource Description

Collection of ProgramPermission
NameDescriptionTypeAdditional information
ID

string

Required

Min length: 1
Permissions

Collection of ConfigViewEditPreferencePermission

Required

Response Formats

application/json, text/json

Sample: 
[
  {
    "ID": "sample string 1",
    "Permissions": [
      {
        "ObjectPreference": true,
        "ObjectPreferenceOptIn": true,
        "ObjectPreferenceOptOut": true,
        "UserGroupID": "sample string 4",
        "CanView": true,
        "CanEdit": true
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfProgramPermission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ProgramPermission>
    <ID>sample string 1</ID>
    <Permissions>
      <ConfigViewEditPreferencePermission>
        <CanEdit>true</CanEdit>
        <CanView>true</CanView>
        <UserGroupID>sample string 4</UserGroupID>
        <ObjectPreference>true</ObjectPreference>
        <ObjectPreferenceOptIn>true</ObjectPreferenceOptIn>
        <ObjectPreferenceOptOut>true</ObjectPreferenceOptOut>
      </ConfigViewEditPreferencePermission>
    </Permissions>
  </ProgramPermission>
</ArrayOfProgramPermission>