POST v1/Portfolios/{id}/BankAccounts/{portfolioBankAccountId}/Udfs

Description

Add one or more udf(s) for the PortfolioBankAccount with WSO ID of {id}.

Base Url

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

Rest Call Syntax


POST Reference/v1/Portfolios/{id}/BankAccounts/{portfolioBankAccountId}/Udfs

Execute API

POST Reference/v1/Portfolios/{id}/BankAccounts/{portfolioBankAccountId}/Udfs

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



Collection of UdfAdd

Name

Description

Type

Additional Information

Name

The name of the UDF

string

Required

Value

The value of the UDF(Boolean value used True/False).

string

Required



Limitations

There are no limitations specified.



Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of Portfolio

integer

Required

portfolioBankAccountId

WSO ID of PortfolioBankAccounts

integer

Required



Request body formats


application/json, text/json

Sample: 
[
  {
    "value": "sample string 1",
    "name": "sample string 2"
  },
  {
    "value": "sample string 1",
    "name": "sample string 2"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfUdfAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <UdfAdd>
    <Name>sample string 2</Name>
    <Value>sample string 1</Value>
  </UdfAdd>
  <UdfAdd>
    <Name>sample string 2</Name>
    <Value>sample string 1</Value>
  </UdfAdd>
</ArrayOfUdfAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information



PagedList Of UdfListItem

Name

Description

Type

Additional Information

Items

Collection of UdfListItem

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"
        }
      ],
      "value": {},
      "name": "sample string 2",
      "maxLength": 4,
      "displayName": "sample string 5",
      "fieldDataType": "Long",
      "ownerObjectType": "Portfolio",
      "extractionName": "sample string 6",
      "hasPickList": true,
      "minValue": {},
      "maxValue": {},
      "format": "sample string 10",
      "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"
        }
      ],
      "value": {},
      "name": "sample string 2",
      "maxLength": 4,
      "displayName": "sample string 5",
      "fieldDataType": "Long",
      "ownerObjectType": "Portfolio",
      "extractionName": "sample string 6",
      "hasPickList": true,
      "minValue": {},
      "maxValue": {},
      "format": "sample string 10",
      "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: 
<PagedListOfUdfListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <UdfListItem>
      <AllowNewPickListItem>true</AllowNewPickListItem>
      <DisplayName>sample string 5</DisplayName>
      <ExtractionName>sample string 6</ExtractionName>
      <FieldDataType>Long</FieldDataType>
      <Format>sample string 10</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>4</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>
      <Value />
    </UdfListItem>
    <UdfListItem>
      <AllowNewPickListItem>true</AllowNewPickListItem>
      <DisplayName>sample string 5</DisplayName>
      <ExtractionName>sample string 6</ExtractionName>
      <FieldDataType>Long</FieldDataType>
      <Format>sample string 10</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>4</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>
      <Value />
    </UdfListItem>
  </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>
</PagedListOfUdfListItem>


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.