PUT api/Institution

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InstitutionId	integer	None.
Name	string	None.
CountryId	integer	None.
TaxId	string	None.
IsBank	boolean	None.
IsIssuer	boolean	None.
IsBroker	boolean	None.
IsAdministrator	boolean	None.
IsManager	boolean	None.
IsCustodian	boolean	None.
IsDistributor	boolean	None.
WebURL	string	None.
PlaidCode	string	None.
InstitutionCode	string	None.
IsEUGuaranteed	boolean	None.
IsEUSituated	boolean	None.
FeederId	integer	None.
SectorId	integer	None.
IndustryId	integer	None.
Note	string	None.
Order	integer	None.
Color	string	None.
Industry	string	None.
Sector	string	None.
InstitutionAddress	Collection of InstitutionAddressView	None.
InstitutionEmail	Collection of InstitutionEmailView	None.
InstitutionPhone	Collection of InstitutionPhoneView	None.
InstitutionInterface	Collection of InstitutionInterfaceView	None.

Request Formats

application/json, text/json

Sample:

{
  "InstitutionId": 1,
  "Name": "sample string 2",
  "CountryId": 3,
  "TaxId": "sample string 4",
  "IsBank": true,
  "IsIssuer": true,
  "IsBroker": true,
  "IsAdministrator": true,
  "IsManager": true,
  "IsCustodian": true,
  "IsDistributor": true,
  "WebURL": "sample string 12",
  "PlaidCode": "sample string 13",
  "InstitutionCode": "sample string 14",
  "IsEUGuaranteed": true,
  "IsEUSituated": true,
  "FeederId": 17,
  "SectorId": 1,
  "IndustryId": 1,
  "Note": "sample string 18",
  "Order": 19,
  "Color": "sample string 20",
  "Industry": "sample string 21",
  "Sector": "sample string 22",
  "InstitutionAddress": [
    {
      "InstitutionAddressId": 1,
      "InstitutionId": 2,
      "Address": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "ZipCode": "sample string 6"
    },
    {
      "InstitutionAddressId": 1,
      "InstitutionId": 2,
      "Address": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "ZipCode": "sample string 6"
    }
  ],
  "InstitutionEmail": [
    {
      "InstitutionEmailId": 1,
      "InstitutionId": 2,
      "Email": "sample string 3",
      "IsPrimary": true
    },
    {
      "InstitutionEmailId": 1,
      "InstitutionId": 2,
      "Email": "sample string 3",
      "IsPrimary": true
    }
  ],
  "InstitutionPhone": [
    {
      "InstitutionPhoneId": 1,
      "InstitutionId": 2,
      "Number": "sample string 3",
      "Extension": "sample string 4"
    },
    {
      "InstitutionPhoneId": 1,
      "InstitutionId": 2,
      "Number": "sample string 3",
      "Extension": "sample string 4"
    }
  ],
  "InstitutionInterface": [
    {
      "InstitutionId": 1,
      "PlaidAccessToken": "sample string 2",
      "PlaidItemId": "sample string 3",
      "UserId": 4
    },
    {
      "InstitutionId": 1,
      "PlaidAccessToken": "sample string 2",
      "PlaidItemId": "sample string 3",
      "UserId": 4
    }
  ]
}

application/xml, text/xml

Sample:

<InstitutionView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiCompass.Models.ClassModel.Institution">
  <Color>sample string 20</Color>
  <CountryId>3</CountryId>
  <FeederId>17</FeederId>
  <Industry>sample string 21</Industry>
  <IndustryId>1</IndustryId>
  <InstitutionAddress>
    <InstitutionAddressView>
      <Address>sample string 3</Address>
      <City>sample string 4</City>
      <InstitutionAddressId>1</InstitutionAddressId>
      <InstitutionId>2</InstitutionId>
      <State>sample string 5</State>
      <ZipCode>sample string 6</ZipCode>
    </InstitutionAddressView>
    <InstitutionAddressView>
      <Address>sample string 3</Address>
      <City>sample string 4</City>
      <InstitutionAddressId>1</InstitutionAddressId>
      <InstitutionId>2</InstitutionId>
      <State>sample string 5</State>
      <ZipCode>sample string 6</ZipCode>
    </InstitutionAddressView>
  </InstitutionAddress>
  <InstitutionCode>sample string 14</InstitutionCode>
  <InstitutionEmail>
    <InstitutionEmailView>
      <Email>sample string 3</Email>
      <InstitutionEmailId>1</InstitutionEmailId>
      <InstitutionId>2</InstitutionId>
      <IsPrimary>true</IsPrimary>
    </InstitutionEmailView>
    <InstitutionEmailView>
      <Email>sample string 3</Email>
      <InstitutionEmailId>1</InstitutionEmailId>
      <InstitutionId>2</InstitutionId>
      <IsPrimary>true</IsPrimary>
    </InstitutionEmailView>
  </InstitutionEmail>
  <InstitutionId>1</InstitutionId>
  <InstitutionInterface>
    <InstitutionInterfaceView>
      <InstitutionId>1</InstitutionId>
      <PlaidAccessToken>sample string 2</PlaidAccessToken>
      <PlaidItemId>sample string 3</PlaidItemId>
      <UserId>4</UserId>
    </InstitutionInterfaceView>
    <InstitutionInterfaceView>
      <InstitutionId>1</InstitutionId>
      <PlaidAccessToken>sample string 2</PlaidAccessToken>
      <PlaidItemId>sample string 3</PlaidItemId>
      <UserId>4</UserId>
    </InstitutionInterfaceView>
  </InstitutionInterface>
  <InstitutionPhone>
    <InstitutionPhoneView>
      <Extension>sample string 4</Extension>
      <InstitutionId>2</InstitutionId>
      <InstitutionPhoneId>1</InstitutionPhoneId>
      <Number>sample string 3</Number>
    </InstitutionPhoneView>
    <InstitutionPhoneView>
      <Extension>sample string 4</Extension>
      <InstitutionId>2</InstitutionId>
      <InstitutionPhoneId>1</InstitutionPhoneId>
      <Number>sample string 3</Number>
    </InstitutionPhoneView>
  </InstitutionPhone>
  <IsAdministrator>true</IsAdministrator>
  <IsBank>true</IsBank>
  <IsBroker>true</IsBroker>
  <IsCustodian>true</IsCustodian>
  <IsDistributor>true</IsDistributor>
  <IsEUGuaranteed>true</IsEUGuaranteed>
  <IsEUSituated>true</IsEUSituated>
  <IsIssuer>true</IsIssuer>
  <IsManager>true</IsManager>
  <Name>sample string 2</Name>
  <Note>sample string 18</Note>
  <Order>19</Order>
  <PlaidCode>sample string 13</PlaidCode>
  <Sector>sample string 22</Sector>
  <SectorId>1</SectorId>
  <TaxId>sample string 4</TaxId>
  <WebURL>sample string 12</WebURL>
</InstitutionView>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.