GET api/ClientRights/GetClientRights?surveyID={surveyID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyID

integer

Required

Body Parameters

None.

Response Information

Resource Description

ClientRights
NameDescriptionTypeAdditional information
ShowHidden

boolean

None.
ExcludeQIDs

Collection of integer

None.
IncludeQIDs

Collection of integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "ShowHidden": true,
  "ExcludeQIDs": [
    1,
    2
  ],
  "IncludeQIDs": [
    1,
    2
  ]
}

text/plain

Sample: 
{"ShowHidden":true,"ExcludeQIDs":[1,2],"IncludeQIDs":[1,2]}

application/xml, text/xml

Sample: 
<ClientRights xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rtr.Entities.Model.Frequency">
  <ExcludeQIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ExcludeQIDs>
  <IncludeQIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </IncludeQIDs>
  <ShowHidden>true</ShowHidden>
</ClientRights>