GET v1/Traders/Udfs

Description

Retrieves all or specific udf type(s) for trader

Base Url

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

Rest Call Syntax


GET TradeManagement/v1/Traders/Udfs

Execute API

GET TradeManagement/v1/Traders/Udfs

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

pageNumber

Page number of the list

integer

Default value is 1

pageSize

Page size of the list

integer

Default value is 50



Response Information



PagedList Of UdfType

Name

Description

Type

Additional Information

Items

Collection of UdfType

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "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"
        }
      ],
      "maxLength": 1,
      "name": "sample string 2",
      "displayName": "sample string 3",
      "fieldDataType": "Long",
      "ownerObjectType": "Portfolio",
      "extractionName": "sample string 4",
      "hasPickList": true,
      "minValue": {},
      "maxValue": {},
      "format": "sample string 8",
      "allowNewPickListItem": true,
      "limitToList": true,
      "pickList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "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"
        }
      ],
      "maxLength": 1,
      "name": "sample string 2",
      "displayName": "sample string 3",
      "fieldDataType": "Long",
      "ownerObjectType": "Portfolio",
      "extractionName": "sample string 4",
      "hasPickList": true,
      "minValue": {},
      "maxValue": {},
      "format": "sample string 8",
      "allowNewPickListItem": true,
      "limitToList": true,
      "pickList": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "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: 
<PagedListOfUdfType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <UdfType>
      <AllowNewPickListItem>true</AllowNewPickListItem>
      <DisplayName>sample string 3</DisplayName>
      <ExtractionName>sample string 4</ExtractionName>
      <FieldDataType>Long</FieldDataType>
      <Format>sample string 8</Format>
      <HasPickList>true</HasPickList>
      <LimitToList>true</LimitToList>
      <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>
      <MaxLength>1</MaxLength>
      <MaxValue />
      <MinValue />
      <Name>sample string 2</Name>
      <OwnerObjectType>Portfolio</OwnerObjectType>
      <PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PickList>
    </UdfType>
    <UdfType>
      <AllowNewPickListItem>true</AllowNewPickListItem>
      <DisplayName>sample string 3</DisplayName>
      <ExtractionName>sample string 4</ExtractionName>
      <FieldDataType>Long</FieldDataType>
      <Format>sample string 8</Format>
      <HasPickList>true</HasPickList>
      <LimitToList>true</LimitToList>
      <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>
      <MaxLength>1</MaxLength>
      <MaxValue />
      <MinValue />
      <Name>sample string 2</Name>
      <OwnerObjectType>Portfolio</OwnerObjectType>
      <PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PickList>
    </UdfType>
  </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>
</PagedListOfUdfType>


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.