|
IHS Markit API |
GET v1/Contacts
Description
Retrieve list of Contacts satisfying the input search criteria.
Base Url
https://api-zion.wsohosting.com/
Rest Call Syntax
GET Reference/v1/Contacts
GET Reference/v1/Contacts
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
ContactNameStartsWith
Contact Name starts with criteria to search.
string
IsDeleted
This flag will allow the return of deleted contact records in the search results
PageNumber
Specified Page number to search
integer
PageSize
Specified Page size to search
integer
Response Information
PagedList Of Contact
Name
Description
Type
Additional Information
Response Body Formats
application/json, text/json
Sample:
{
"items": [
{
"id": 1,
"institutionId": 2,
"institution": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"address": "sample string 3",
"contactName": "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-08T05:39:33.073984-05:00",
"addId": "sample string 13",
"addNode": "sample string 14",
"lastChangeDate": "2024-10-08T05:39:33.073984-05:00",
"lastChangeId": "sample string 16",
"lastChangeNode": "sample string 17",
"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,
"institutionId": 2,
"institution": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"address": "sample string 3",
"contactName": "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-08T05:39:33.073984-05:00",
"addId": "sample string 13",
"addNode": "sample string 14",
"lastChangeDate": "2024-10-08T05:39:33.073984-05:00",
"lastChangeId": "sample string 16",
"lastChangeNode": "sample string 17",
"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"
}
]
}
],
"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:
<PagedListOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Items>
<Contact>
<AddDate>2024-10-08T05:39:33.073984-05:00</AddDate>
<AddId>sample string 13</AddId>
<AddNode>sample string 14</AddNode>
<Address>sample string 3</Address>
<ContactName>sample string 4</ContactName>
<Email>sample string 10</Email>
<Fax>sample string 5</Fax>
<Id>1</Id>
<Index>sample string 6</Index>
<Institution>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Institution>
<InstitutionId>2</InstitutionId>
<IsDeleted>true</IsDeleted>
<LastChangeDate>2024-10-08T05:39:33.073984-05:00</LastChangeDate>
<LastChangeId>sample string 16</LastChangeId>
<LastChangeNode>sample string 17</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>
<Notes>sample string 8</Notes>
<Phone>sample string 9</Phone>
</Contact>
<Contact>
<AddDate>2024-10-08T05:39:33.073984-05:00</AddDate>
<AddId>sample string 13</AddId>
<AddNode>sample string 14</AddNode>
<Address>sample string 3</Address>
<ContactName>sample string 4</ContactName>
<Email>sample string 10</Email>
<Fax>sample string 5</Fax>
<Id>1</Id>
<Index>sample string 6</Index>
<Institution>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Institution>
<InstitutionId>2</InstitutionId>
<IsDeleted>true</IsDeleted>
<LastChangeDate>2024-10-08T05:39:33.073984-05:00</LastChangeDate>
<LastChangeId>sample string 16</LastChangeId>
<LastChangeNode>sample string 17</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>
<Notes>sample string 8</Notes>
<Phone>sample string 9</Phone>
</Contact>
</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>
</PagedListOfContact>
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.