GET v1/Institutions/{id}/Contact

Description

Retrieve contacts for an institution with WSO ID of {id}.

Base Url

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


Rest Call Syntax


GET Reference/v1/Institutions/{id}/Contact

GET Reference/v1/Institutions/{id}/Contact

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



NonPagedList Of ContactListItems

Name

Description

Type

Additional Information

Items

Collection of ContactListItems

Links

Collection of Link




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "id": 1,
      "contactName": "sample string 2",
      "institutionId": 3,
      "institution": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "address": "sample string 4",
      "fax": "sample string 5",
      "index": "sample string 6",
      "isDeleted": true,
      "notes": "sample string 8",
      "phone": "sample string 9",
      "email": "sample string 10",
      "addDate": "2024-10-08T11:32:37.6116913+01:00",
      "addId": "sample string 13",
      "lastChangeDate": "2024-10-08T11:32:37.6116913+01:00",
      "lastChangeId": "sample string 15",
      "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"
        }
      ]
    },
    {
      "id": 1,
      "contactName": "sample string 2",
      "institutionId": 3,
      "institution": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "address": "sample string 4",
      "fax": "sample string 5",
      "index": "sample string 6",
      "isDeleted": true,
      "notes": "sample string 8",
      "phone": "sample string 9",
      "email": "sample string 10",
      "addDate": "2024-10-08T11:32:37.6116913+01:00",
      "addId": "sample string 13",
      "lastChangeDate": "2024-10-08T11:32:37.6116913+01:00",
      "lastChangeId": "sample string 15",
      "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"
        }
      ]
    }
  ],
  "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:
<NonPagedListOfContactListItems xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/WSO.API.Reference.Models.v1">
    <d2p1:ContactListItems>
      <d2p1:AddDate>2024-10-08T11:32:37.6116913+01:00</d2p1:AddDate>
      <d2p1:AddId>sample string 13</d2p1:AddId>
      <d2p1:Address>sample string 4</d2p1:Address>
      <d2p1:ContactName>sample string 2</d2p1:ContactName>
      <d2p1:Email>sample string 10</d2p1:Email>
      <d2p1:Fax>sample string 5</d2p1:Fax>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Index>sample string 6</d2p1:Index>
      <d2p1:Institution>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </d2p1:Institution>
      <d2p1:InstitutionId>3</d2p1:InstitutionId>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:LastChangeDate>2024-10-08T11:32:37.6116913+01:00</d2p1:LastChangeDate>
      <d2p1:LastChangeId>sample string 15</d2p1:LastChangeId>
      <d2p1: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>
      </d2p1:Links>
      <d2p1:Notes>sample string 8</d2p1:Notes>
      <d2p1:Phone>sample string 9</d2p1:Phone>
    </d2p1:ContactListItems>
    <d2p1:ContactListItems>
      <d2p1:AddDate>2024-10-08T11:32:37.6116913+01:00</d2p1:AddDate>
      <d2p1:AddId>sample string 13</d2p1:AddId>
      <d2p1:Address>sample string 4</d2p1:Address>
      <d2p1:ContactName>sample string 2</d2p1:ContactName>
      <d2p1:Email>sample string 10</d2p1:Email>
      <d2p1:Fax>sample string 5</d2p1:Fax>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Index>sample string 6</d2p1:Index>
      <d2p1:Institution>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </d2p1:Institution>
      <d2p1:InstitutionId>3</d2p1:InstitutionId>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:LastChangeDate>2024-10-08T11:32:37.6116913+01:00</d2p1:LastChangeDate>
      <d2p1:LastChangeId>sample string 15</d2p1:LastChangeId>
      <d2p1: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>
      </d2p1:Links>
      <d2p1:Notes>sample string 8</d2p1:Notes>
      <d2p1:Phone>sample string 9</d2p1:Phone>
    </d2p1:ContactListItems>
  </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>
</NonPagedListOfContactListItems>



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.