GET {clientId}/Config/SourceGroups

Retrieve all Source Groups.

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 ConfigSourceGroup
NameDescriptionTypeAdditional information
Link

integer

None.

OverwriteExisting

boolean

None.

SourceGroupID

string

Required

Min length: 1

SourceGroupName

string

Required

Min length: 1

SourceTypeNbr

integer

Required

Range: inclusive between 1 and 3

Description

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Description": "sample string 1",
    "Link": 1,
    "OverwriteExisting": true,
    "SourceGroupID": "sample string 3",
    "SourceGroupName": "sample string 4",
    "SourceTypeNbr": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfConfigSourceGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigSourceGroup>
    <Description>sample string 1</Description>
    <Link>1</Link>
    <OverwriteExisting>true</OverwriteExisting>
    <SourceGroupID>sample string 3</SourceGroupID>
    <SourceGroupName>sample string 4</SourceGroupName>
    <SourceTypeNbr>5</SourceTypeNbr>
  </ConfigSourceGroup>
</ArrayOfConfigSourceGroup>