AlbaApi

<back to all web services

BeneficiaryRequest

The following routes are available for this service:
POST/beneficiary/save
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Beneficiary:
    id: Optional[int] = None
    member_id: Optional[int] = None
    name: Optional[str] = None
    birthdate: Optional[datetime.datetime] = None
    relationship_to_member: Optional[str] = None
    identification_number: Optional[str] = None
    allocation: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BeneficiaryRequest:
    beneficiaries: Optional[List[Beneficiary]] = None
    member_id: Optional[int] = None
    created_by: Optional[str] = None

Python BeneficiaryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /beneficiary/save HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BeneficiaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <Beneficiaries xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
    <d2p1:Beneficiary>
      <d2p1:Allocation>0</d2p1:Allocation>
      <d2p1:Birthdate>0001-01-01T00:00:00</d2p1:Birthdate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IdentificationNumber>String</d2p1:IdentificationNumber>
      <d2p1:MemberId>0</d2p1:MemberId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:RelationshipToMember>String</d2p1:RelationshipToMember>
    </d2p1:Beneficiary>
  </Beneficiaries>
  <CreatedBy>String</CreatedBy>
  <MemberId>0</MemberId>
</BeneficiaryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

(HttpWebResponse)