POST uat/vcc-br2s-entity-profile-uat/api/intf/v1/iz/vcc/entityProfile

Request Information

URI Parameters

None.

Body Parameters

EntityProfileParam
NameDescriptionTypeAdditional information
uenNo

string

None.

uenName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "uenNo": "sample string 1",
  "uenName": "sample string 2"
}

application/xml, text/xml

Sample:
<EntityProfileParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApplication1.Models">
  <uenName>sample string 2</uenName>
  <uenNo>sample string 1</uenNo>
</EntityProfileParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EntityProfileResult
NameDescriptionTypeAdditional information
apiKey

string

None.

entity

Collection of Entity

None.

recordCount

integer

None.

recordStatus

string

None.

Response Formats

application/json, text/json

Sample:
{
  "apiKey": "sample string 1",
  "entity": [
    {
      "uenAddreffDate": "sample string 1",
      "uenName": "sample string 2",
      "uenNo": "sample string 3",
      "uenStatuscode": "sample string 4",
      "uenType": "sample string 5",
      "uenblkhseNbr": "sample string 6",
      "uenlevelNbr": "sample string 7",
      "uenpostalCode": "sample string 8",
      "uenregDate": "sample string 9",
      "uenstatusDesc": "sample string 10",
      "uenstrKey": "sample string 11",
      "uenstrName": "sample string 12",
      "uenunitNbr": "sample string 13"
    },
    {
      "uenAddreffDate": "sample string 1",
      "uenName": "sample string 2",
      "uenNo": "sample string 3",
      "uenStatuscode": "sample string 4",
      "uenType": "sample string 5",
      "uenblkhseNbr": "sample string 6",
      "uenlevelNbr": "sample string 7",
      "uenpostalCode": "sample string 8",
      "uenregDate": "sample string 9",
      "uenstatusDesc": "sample string 10",
      "uenstrKey": "sample string 11",
      "uenstrName": "sample string 12",
      "uenunitNbr": "sample string 13"
    }
  ],
  "recordCount": 2,
  "recordStatus": "sample string 3"
}

application/xml, text/xml

Sample:
<EntityProfileResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApplication1.Models">
  <apiKey>sample string 1</apiKey>
  <entity>
    <Entity>
      <uenAddreffDate>sample string 1</uenAddreffDate>
      <uenName>sample string 2</uenName>
      <uenNo>sample string 3</uenNo>
      <uenStatuscode>sample string 4</uenStatuscode>
      <uenType>sample string 5</uenType>
      <uenblkhseNbr>sample string 6</uenblkhseNbr>
      <uenlevelNbr>sample string 7</uenlevelNbr>
      <uenpostalCode>sample string 8</uenpostalCode>
      <uenregDate>sample string 9</uenregDate>
      <uenstatusDesc>sample string 10</uenstatusDesc>
      <uenstrKey>sample string 11</uenstrKey>
      <uenstrName>sample string 12</uenstrName>
      <uenunitNbr>sample string 13</uenunitNbr>
    </Entity>
    <Entity>
      <uenAddreffDate>sample string 1</uenAddreffDate>
      <uenName>sample string 2</uenName>
      <uenNo>sample string 3</uenNo>
      <uenStatuscode>sample string 4</uenStatuscode>
      <uenType>sample string 5</uenType>
      <uenblkhseNbr>sample string 6</uenblkhseNbr>
      <uenlevelNbr>sample string 7</uenlevelNbr>
      <uenpostalCode>sample string 8</uenpostalCode>
      <uenregDate>sample string 9</uenregDate>
      <uenstatusDesc>sample string 10</uenstatusDesc>
      <uenstrKey>sample string 11</uenstrKey>
      <uenstrName>sample string 12</uenstrName>
      <uenunitNbr>sample string 13</uenunitNbr>
    </Entity>
  </entity>
  <recordCount>2</recordCount>
  <recordStatus>sample string 3</recordStatus>
</EntityProfileResult>