GET api/Beneficiaries/Credit?citizenId={citizenId}&fullName={fullName}

Searches Beneficiaries for the New Credit Claim screen

Request Information

URI Parameters

NameDescriptionTypeAdditional information
citizenId

string

Default value is

fullName

string

Default value is

Body Parameters

None.

Response Information

Resource Description

ServiceResultTypedOfListOfBeneficiaryCreditSearchResult
NameDescriptionTypeAdditional information
Code

integer

None.

Errors

Collection of string

None.

Data

Collection of BeneficiaryCreditSearchResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "BeneficiaryId": 1,
      "BeneficiaryType": "sample string 2",
      "CitizenId": "sample string 3",
      "BeneficiaryFullName": "sample string 4",
      "BeneficiaryOtherNames": [
        "sample string 1",
        "sample string 2"
      ],
      "EmployeeId": 5,
      "EmployeeName": "sample string 6",
      "EmployeeNo": "sample string 7",
      "CompanyId": 8,
      "CompanyName": "sample string 9",
      "CompanyCode": "sample string 10",
      "CompanyTel": "sample string 11"
    },
    {
      "BeneficiaryId": 1,
      "BeneficiaryType": "sample string 2",
      "CitizenId": "sample string 3",
      "BeneficiaryFullName": "sample string 4",
      "BeneficiaryOtherNames": [
        "sample string 1",
        "sample string 2"
      ],
      "EmployeeId": 5,
      "EmployeeName": "sample string 6",
      "EmployeeNo": "sample string 7",
      "CompanyId": 8,
      "CompanyName": "sample string 9",
      "CompanyCode": "sample string 10",
      "CompanyTel": "sample string 11"
    }
  ]
}

text/html

Sample:
{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"BeneficiaryId":1,"BeneficiaryType":"sample string 2","CitizenId":"sample string 3","BeneficiaryFullName":"sample string 4","BeneficiaryOtherNames":["sample string 1","sample string 2"],"EmployeeId":5,"EmployeeName":"sample string 6","EmployeeNo":"sample string 7","CompanyId":8,"CompanyName":"sample string 9","CompanyCode":"sample string 10","CompanyTel":"sample string 11"},{"BeneficiaryId":1,"BeneficiaryType":"sample string 2","CitizenId":"sample string 3","BeneficiaryFullName":"sample string 4","BeneficiaryOtherNames":["sample string 1","sample string 2"],"EmployeeId":5,"EmployeeName":"sample string 6","EmployeeNo":"sample string 7","CompanyId":8,"CompanyName":"sample string 9","CompanyCode":"sample string 10","CompanyTel":"sample string 11"}]}

application/xml, text/xml

Sample:
<ServiceResultTypedOfArrayOfBeneficiaryCreditSearchResultYj8O1tFc 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:BeneficiaryCreditSearchResult>
      <d2p1:BeneficiaryFullName>sample string 4</d2p1:BeneficiaryFullName>
      <d2p1:BeneficiaryId>1</d2p1:BeneficiaryId>
      <d2p1:BeneficiaryOtherNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:BeneficiaryOtherNames>
      <d2p1:BeneficiaryType>sample string 2</d2p1:BeneficiaryType>
      <d2p1:CitizenId>sample string 3</d2p1:CitizenId>
      <d2p1:CompanyCode>sample string 10</d2p1:CompanyCode>
      <d2p1:CompanyId>8</d2p1:CompanyId>
      <d2p1:CompanyName>sample string 9</d2p1:CompanyName>
      <d2p1:CompanyTel>sample string 11</d2p1:CompanyTel>
      <d2p1:EmployeeId>5</d2p1:EmployeeId>
      <d2p1:EmployeeName>sample string 6</d2p1:EmployeeName>
      <d2p1:EmployeeNo>sample string 7</d2p1:EmployeeNo>
    </d2p1:BeneficiaryCreditSearchResult>
    <d2p1:BeneficiaryCreditSearchResult>
      <d2p1:BeneficiaryFullName>sample string 4</d2p1:BeneficiaryFullName>
      <d2p1:BeneficiaryId>1</d2p1:BeneficiaryId>
      <d2p1:BeneficiaryOtherNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:BeneficiaryOtherNames>
      <d2p1:BeneficiaryType>sample string 2</d2p1:BeneficiaryType>
      <d2p1:CitizenId>sample string 3</d2p1:CitizenId>
      <d2p1:CompanyCode>sample string 10</d2p1:CompanyCode>
      <d2p1:CompanyId>8</d2p1:CompanyId>
      <d2p1:CompanyName>sample string 9</d2p1:CompanyName>
      <d2p1:CompanyTel>sample string 11</d2p1:CompanyTel>
      <d2p1:EmployeeId>5</d2p1:EmployeeId>
      <d2p1:EmployeeName>sample string 6</d2p1:EmployeeName>
      <d2p1:EmployeeNo>sample string 7</d2p1:EmployeeNo>
    </d2p1:BeneficiaryCreditSearchResult>
  </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>
</ServiceResultTypedOfArrayOfBeneficiaryCreditSearchResultYj8O1tFc>