GET api/File/GetGroup/{id}

Get group from Transfer

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Group

FileGroup
NameDescriptionTypeAdditional information
ID

integer

None.

Name

string

None.

Description

string

None.

Email

string

None.

Endpoint

string

None.

ReceivingGroup

boolean

None.

Private

boolean

None.

Members

Collection of GroupMember

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Email": "sample string 4",
  "Endpoint": "sample string 5",
  "ReceivingGroup": true,
  "Private": true,
  "Members": [
    {
      "SSN": "sample string 1",
      "Name": "sample string 2",
      "Order": 3
    },
    {
      "SSN": "sample string 1",
      "Name": "sample string 2",
      "Order": 3
    }
  ]
}

application/xml, text/xml

Sample:
<FileGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.FileExchange">
  <Description>sample string 3</Description>
  <Email>sample string 4</Email>
  <Endpoint>sample string 5</Endpoint>
  <ID>1</ID>
  <Members>
    <FileGroup.GroupMember>
      <Name>sample string 2</Name>
      <Order>3</Order>
      <SSN>sample string 1</SSN>
    </FileGroup.GroupMember>
    <FileGroup.GroupMember>
      <Name>sample string 2</Name>
      <Order>3</Order>
      <SSN>sample string 1</SSN>
    </FileGroup.GroupMember>
  </Members>
  <Name>sample string 2</Name>
  <Private>true</Private>
  <ReceivingGroup>true</ReceivingGroup>
</FileGroup>