GET v1/IdentifierTypes

Description

Retrieve list of identifier types satisfying the input search criteria.

Base Url

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


Rest Call Syntax


GET SecurityMaster/v1/IdentifierTypes

GET SecurityMaster/v1/IdentifierTypes

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

IdentifierTypeNameExactMatch

Rating Type name to search

string

IsDeleted

IsDeleted value to search

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer




Response Information



PagedList Of IdentifierTypeListItem

Name

Description

Type

Additional Information

Items

Collection of IdentifierTypeListItem

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "id": 1,
      "identifierTypeName": "sample string 2",
      "idcPrefix": "sample string 3",
      "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,
      "identifierTypeName": "sample string 2",
      "idcPrefix": "sample string 3",
      "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:
<PagedListOfIdentifierTypeListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/WSO.API.SecurityMaster.Models.v1">
    <d2p1:IdentifierTypeListItem>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IdcPrefix>sample string 3</d2p1:IdcPrefix>
      <d2p1:IdentifierTypeName>sample string 2</d2p1:IdentifierTypeName>
      <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:IdentifierTypeListItem>
    <d2p1:IdentifierTypeListItem>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IdcPrefix>sample string 3</d2p1:IdcPrefix>
      <d2p1:IdentifierTypeName>sample string 2</d2p1:IdentifierTypeName>
      <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:IdentifierTypeListItem>
  </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>
</PagedListOfIdentifierTypeListItem>



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.