WSO Reference API

IHS Markit API

GET v1/Institutions

Description

Retrieve list of Institutions satisfying the input search criteria.

Base Url

https://api-agc.wsohosting.com/

Rest Call Syntax

GET Reference/v1/Institutions

Execute API

GET Reference/v1/Institutions

Verb

Description

Base Url

URL

URI parameters

Enable

Authentication

Username:

Password:

Show Password

Response Format

Content-Type:

Headers

Add header

Type

Parameter
Delete

Body

Samples:

Limitations

There are no limitations specified.

Request Information

Parameters

Name

Description

Type

Additional Information

InstitutionNameStartsWith

Institution name starts with to search

string

IsDeleted

IsDeleted value to search

TriStateValue

MarkitEntityId

the Markit Entity ID of the Institution to search

string

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

RoleType

Gets the value for the bank role type portion of the filter.

BankRoleType

Response Information

PagedList Of Institution

Name

Description

Type

Additional Information

Items

Collection of Institution

Links

Collection of Link

PagingInformation

Response Body Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "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-08T05:31:20.014187-05:00",
      "addNode": "sample string 20",
      "lastChangeId": "sample string 21",
      "lastChangeDate": "2024-10-08T05:31:20.014187-05:00",
      "lastChangeNode": "sample string 23"
    },
    {
      "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-08T05:31:20.014187-05:00",
      "addNode": "sample string 20",
      "lastChangeId": "sample string 21",
      "lastChangeDate": "2024-10-08T05:31:20.014187-05:00",
      "lastChangeNode": "sample string 23"
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "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"
    }
  ]
}

application/xml, text/xml

Sample:

<PagedListOfInstitution xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <Institution>
      <Abbreviation>sample string 5</Abbreviation>
      <AddDate>2024-10-08T05:31:20.014187-05: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-08T05:31:20.014187-05: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>
    <Institution>
      <Abbreviation>sample string 5</Abbreviation>
      <AddDate>2024-10-08T05:31:20.014187-05: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-08T05:31:20.014187-05: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>
  </Items>
  <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>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfInstitution>

Feedback

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.