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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	beneficiaries: 
	[
		{
			id: 0,
			memberId: 0,
			name: String,
			birthdate: 0001-01-01,
			relationshipToMember: String,
			identificationNumber: String,
			allocation: 0
		}
	],
	memberId: 0,
	createdBy: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

(HttpWebResponse)