GET v1/Institutions/{id}

Description

Retrieve a Institution with WSO ID of {id}.

Base Url

https://api-mgi.uat.wsohosting.com/


Rest Call Syntax


GET Reference/v1/Institutions/{id}

GET Reference/v1/Institutions/{id}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of institution

integer

Required




Response Information



Institution

Name

Description

Type

Additional Information

Abbreviation

Abbreviation of the Institution - Bank

string

AddDate

Gets or sets the date that the institution was created.

date

AddId

Gets or sets the name of the user who added the institution.

string

AddNode

Gets or sets the name of the machine that added this record to the system.

string

Address

Institution Address

string

Administrator

ID of the Administrator

integer

AffiliationId

WSO InstitutionId of affiliated parent

integer

BinaryImage

Gets or sets the letter head image.

Collection of byte

CompanyId

Company id

integer

Country

Link to the Country

CountryDescription

Description of the Country

string

CountryId

ID of Country

integer

Id

The WSO InstitutionId of the Institution - Bank

integer

ImageAlignment

Gets or sets the letter head alignment.

ImageHeight

Gets or sets the height of the letter head.

decimal number

ImagePlacement

Gets or sets the letter head mode.

InstitutionName

The Name of the Institution - Bank

string

IsBank

Is this Institution considered a Bank

boolean

IsDeleted

The IsDeleted Flag of the Institution - Bank

boolean

IsFund

Is Fund Boolean

boolean

LastChangeDate

Gets or sets the date of the last change to the institution.

date

LastChangeId

Gets or sets the name of the user that last made changes to the institution.

string

LastChangeNode

Gets or sets the name of the machine that added this record to the system.

string

Links

The Hateoas links to related object

Collection of Link

MarkitEntityId

Markit Entity ID

string

Notes

Notes

string

ParentAffiliate

Link to Affiliated Parent Institution

Ratings

Link to Ratings

Signature1

Signature 1

string

Signature2

Signature 2

string

Signature3

Signature 3

string

Signature4

Signature 4

string

Udfs

Link to Udfs




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "institutionName": "sample string 2",
  "isDeleted": true,
  "administrator": 4,
  "abbreviation": "sample string 5",
  "address": "sample string 6",
  "countryId": 1,
  "country": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "countryDescription": "sample string 7",
  "isBank": true,
  "isFund": true,
  "markitEntityId": "sample string 10",
  "notes": "sample string 11",
  "affiliationId": 1,
  "parentAffiliate": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "signature1": "sample string 12",
  "signature2": "sample string 13",
  "signature3": "sample string 14",
  "signature4": "sample string 15",
  "ratings": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "udfs": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ],
  "companyId": 16,
  "imagePlacement": "Logo1",
  "imageHeight": 17.1,
  "imageAlignment": "Left",
  "binaryImage": "QEA=",
  "addId": "sample string 18",
  "addDate": "2024-10-08T11:39:05.7748303+01:00",
  "addNode": "sample string 20",
  "lastChangeId": "sample string 21",
  "lastChangeDate": "2024-10-08T11:39:05.7748303+01:00",
  "lastChangeNode": "sample string 23"
}

application/xml, text/xml

Sample:
<Institution xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Abbreviation>sample string 5</Abbreviation>
  <AddDate>2024-10-08T11:39:05.7748303+01:00</AddDate>
  <AddId>sample string 18</AddId>
  <AddNode>sample string 20</AddNode>
  <Address>sample string 6</Address>
  <Administrator>4</Administrator>
  <AffiliationId>1</AffiliationId>
  <BinaryImage>QEA=</BinaryImage>
  <CompanyId>16</CompanyId>
  <Country>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Country>
  <CountryDescription>sample string 7</CountryDescription>
  <CountryId>1</CountryId>
  <Id>1</Id>
  <ImageAlignment>Left</ImageAlignment>
  <ImageHeight>17.1</ImageHeight>
  <ImagePlacement>Logo1</ImagePlacement>
  <InstitutionName>sample string 2</InstitutionName>
  <IsBank>true</IsBank>
  <IsDeleted>true</IsDeleted>
  <IsFund>true</IsFund>
  <LastChangeDate>2024-10-08T11:39:05.7748303+01:00</LastChangeDate>
  <LastChangeId>sample string 21</LastChangeId>
  <LastChangeNode>sample string 23</LastChangeNode>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <MarkitEntityId>sample string 10</MarkitEntityId>
  <Notes>sample string 11</Notes>
  <ParentAffiliate>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </ParentAffiliate>
  <Ratings>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Ratings>
  <Signature1>sample string 12</Signature1>
  <Signature2>sample string 13</Signature2>
  <Signature3>sample string 14</Signature3>
  <Signature4>sample string 15</Signature4>
  <Udfs>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Udfs>
</Institution>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.