GET v1/Traders

Description

Retrieve list of Traders satisfying the input search criteria.

Base Url

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

Rest Call Syntax


GET TradeManagement/v1/Traders

Execute API

GET TradeManagement/v1/Traders

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

IsDeleted

The flag indicating if the issuer is soft deleted in the system

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

SortAscending

boolean

SortColumn

string

TraderNameStartsWith

Search the issuer name - "starts with"

string



Response Information


Paged List of Traders


PagedList Of Trader

Name

Description

Type

Additional Information

Items

Collection of Trader

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "id": 1,
      "isDeleted": true,
      "traderName": "sample string 3",
      "index": "sample string 4",
      "address": "sample string 5",
      "phone": "sample string 6",
      "fax": "sample string 7",
      "email": "sample string 8",
      "notes": "sample string 9",
      "companyId": 1,
      "addDate": "2024-10-08T05:34:41.1759905-05:00",
      "addId": "sample string 12",
      "addNode": "sample string 13",
      "lastChangeDate": "2024-10-08T05:34:41.1759905-05:00",
      "lastChangeId": "sample string 15",
      "lastChangeNode": "sample string 16",
      "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"
        }
      ]
    },
    {
      "id": 1,
      "isDeleted": true,
      "traderName": "sample string 3",
      "index": "sample string 4",
      "address": "sample string 5",
      "phone": "sample string 6",
      "fax": "sample string 7",
      "email": "sample string 8",
      "notes": "sample string 9",
      "companyId": 1,
      "addDate": "2024-10-08T05:34:41.1759905-05:00",
      "addId": "sample string 12",
      "addNode": "sample string 13",
      "lastChangeDate": "2024-10-08T05:34:41.1759905-05:00",
      "lastChangeId": "sample string 15",
      "lastChangeNode": "sample string 16",
      "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"
        }
      ]
    }
  ],
  "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: 
<PagedListOfTrader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <Trader>
      <AddDate>2024-10-08T05:34:41.1759905-05:00</AddDate>
      <AddId>sample string 12</AddId>
      <AddNode>sample string 13</AddNode>
      <Address>sample string 5</Address>
      <CompanyId>1</CompanyId>
      <Email>sample string 8</Email>
      <Fax>sample string 7</Fax>
      <Id>1</Id>
      <Index>sample string 4</Index>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-10-08T05:34:41.1759905-05:00</LastChangeDate>
      <LastChangeId>sample string 15</LastChangeId>
      <LastChangeNode>sample string 16</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 9</Notes>
      <Phone>sample string 6</Phone>
      <TraderName>sample string 3</TraderName>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
    </Trader>
    <Trader>
      <AddDate>2024-10-08T05:34:41.1759905-05:00</AddDate>
      <AddId>sample string 12</AddId>
      <AddNode>sample string 13</AddNode>
      <Address>sample string 5</Address>
      <CompanyId>1</CompanyId>
      <Email>sample string 8</Email>
      <Fax>sample string 7</Fax>
      <Id>1</Id>
      <Index>sample string 4</Index>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-10-08T05:34:41.1759905-05:00</LastChangeDate>
      <LastChangeId>sample string 15</LastChangeId>
      <LastChangeNode>sample string 16</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 9</Notes>
      <Phone>sample string 6</Phone>
      <TraderName>sample string 3</TraderName>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
    </Trader>
  </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>
</PagedListOfTrader>


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.