GET api/Beneficiaries/Cash?companyId={companyId}&employeeNo={employeeNo}

Searches Beneficiaries for the New Cash Claim screen

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		integer	Required
employeeNo		string	Required

Body Parameters

None.

Response Information

Resource Description

ServiceResultTypedOfListOfBeneficiaryCashSearch

Name	Type	Additional information
Code	integer	None.
Errors	Collection of string	None.
Data	Collection of BeneficiaryCashSearch	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "EmployeeId": 1,
      "EmployeeFullName": "sample string 2",
      "Beneficiaries": [
        {
          "BeneficiaryId": 1,
          "BeneficiaryFullName": "sample string 2",
          "PriorNames": [
            {
              "NameId": 1,
              "Name": "sample string 2"
            },
            {
              "NameId": 1,
              "Name": "sample string 2"
            }
          ]
        },
        {
          "BeneficiaryId": 1,
          "BeneficiaryFullName": "sample string 2",
          "PriorNames": [
            {
              "NameId": 1,
              "Name": "sample string 2"
            },
            {
              "NameId": 1,
              "Name": "sample string 2"
            }
          ]
        }
      ]
    },
    {
      "EmployeeId": 1,
      "EmployeeFullName": "sample string 2",
      "Beneficiaries": [
        {
          "BeneficiaryId": 1,
          "BeneficiaryFullName": "sample string 2",
          "PriorNames": [
            {
              "NameId": 1,
              "Name": "sample string 2"
            },
            {
              "NameId": 1,
              "Name": "sample string 2"
            }
          ]
        },
        {
          "BeneficiaryId": 1,
          "BeneficiaryFullName": "sample string 2",
          "PriorNames": [
            {
              "NameId": 1,
              "Name": "sample string 2"
            },
            {
              "NameId": 1,
              "Name": "sample string 2"
            }
          ]
        }
      ]
    }
  ]
}

text/html

Sample:

{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"EmployeeId":1,"EmployeeFullName":"sample string 2","Beneficiaries":[{"BeneficiaryId":1,"BeneficiaryFullName":"sample string 2","PriorNames":[{"NameId":1,"Name":"sample string 2"},{"NameId":1,"Name":"sample string 2"}]},{"BeneficiaryId":1,"BeneficiaryFullName":"sample string 2","PriorNames":[{"NameId":1,"Name":"sample string 2"},{"NameId":1,"Name":"sample string 2"}]}]},{"EmployeeId":1,"EmployeeFullName":"sample string 2","Beneficiaries":[{"BeneficiaryId":1,"BeneficiaryFullName":"sample string 2","PriorNames":[{"NameId":1,"Name":"sample string 2"},{"NameId":1,"Name":"sample string 2"}]},{"BeneficiaryId":1,"BeneficiaryFullName":"sample string 2","PriorNames":[{"NameId":1,"Name":"sample string 2"},{"NameId":1,"Name":"sample string 2"}]}]}]}

application/xml, text/xml

Sample:

<ServiceResultTypedOfArrayOfBeneficiaryCashSearchYj8O1tFc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSW.Common.Models">
  <Code>1</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TTMWM_MECLAIM_API.ViewModels">
    <d2p1:BeneficiaryCashSearch>
      <d2p1:Beneficiaries>
        <d2p1:BeneficiaryCashSearchResult>
          <d2p1:BeneficiaryFullName>sample string 2</d2p1:BeneficiaryFullName>
          <d2p1:BeneficiaryId>1</d2p1:BeneficiaryId>
          <d2p1:PriorNames>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
          </d2p1:PriorNames>
        </d2p1:BeneficiaryCashSearchResult>
        <d2p1:BeneficiaryCashSearchResult>
          <d2p1:BeneficiaryFullName>sample string 2</d2p1:BeneficiaryFullName>
          <d2p1:BeneficiaryId>1</d2p1:BeneficiaryId>
          <d2p1:PriorNames>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
          </d2p1:PriorNames>
        </d2p1:BeneficiaryCashSearchResult>
      </d2p1:Beneficiaries>
      <d2p1:EmployeeFullName>sample string 2</d2p1:EmployeeFullName>
      <d2p1:EmployeeId>1</d2p1:EmployeeId>
    </d2p1:BeneficiaryCashSearch>
    <d2p1:BeneficiaryCashSearch>
      <d2p1:Beneficiaries>
        <d2p1:BeneficiaryCashSearchResult>
          <d2p1:BeneficiaryFullName>sample string 2</d2p1:BeneficiaryFullName>
          <d2p1:BeneficiaryId>1</d2p1:BeneficiaryId>
          <d2p1:PriorNames>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
          </d2p1:PriorNames>
        </d2p1:BeneficiaryCashSearchResult>
        <d2p1:BeneficiaryCashSearchResult>
          <d2p1:BeneficiaryFullName>sample string 2</d2p1:BeneficiaryFullName>
          <d2p1:BeneficiaryId>1</d2p1:BeneficiaryId>
          <d2p1:PriorNames>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
            <d2p1:BeneficiaryNameHistory>
              <d2p1:Name>sample string 2</d2p1:Name>
              <d2p1:NameId>1</d2p1:NameId>
            </d2p1:BeneficiaryNameHistory>
          </d2p1:PriorNames>
        </d2p1:BeneficiaryCashSearchResult>
      </d2p1:Beneficiaries>
      <d2p1:EmployeeFullName>sample string 2</d2p1:EmployeeFullName>
      <d2p1:EmployeeId>1</d2p1:EmployeeId>
    </d2p1:BeneficiaryCashSearch>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ServiceResultTypedOfArrayOfBeneficiaryCashSearchYj8O1tFc>