Birth-Death

Birth & Death APIs

APIs to create new birth and death applications, update existing applications, search applications and download birth and death certificates.

download

post
/birth/_download
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/birth/_download

getfilestoreid

post
/birth/_getfilestoreid
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/birth/_getfilestoreid

plainSearch

post
/birth/_plainsearch
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/birth/_plainsearch

search

post
/birth/_search
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/birth/_search

searchApplications

post
/birth/_searchapplications
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/birth/_searchapplications

viewCertificateData

post
/birth/_viewcertdata
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/birth/_viewcertdata

viewfullCertMasterData

post
/birth/_viewfullcertdata
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/birth/_viewfullcertdata

search

post
/common/gethospitals
Query parameters
birthDtlIdstringOptional
birthcertificatenostringOptional
consumerCodestringOptional
dateOfBirthstringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
tenantIdstringOptional
toDatestringOptional
tokenstringOptional
Body
Responses
200

OK

*/*
post
/common/gethospitals

saveBirthImport

post
/common/savebirthimport
Body
Responses
200

OK

*/*
post
/common/savebirthimport

saveDeathImport

post
/common/savedeathimport
Body
Responses
200

OK

*/*
post
/common/savedeathimport

updateBirthImport

post
/common/updatebirthimport
Body
Responses
200

OK

*/*
post
/common/updatebirthimport

updateDeathImport

post
/common/updatedeathimport
Body
Responses
200

OK

*/*
post
/common/updatedeathimport

download

post
/death/_download
Query parameters
consumerCodestringOptional
dateOfDeathstringOptional
deathDtlIdstringOptional
deathcertificatenostringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
namestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
spouseNamestringOptional
tenantIdstringOptional
toDatestringOptional
Body
Responses
200

OK

*/*
post
/death/_download

getfilestoreid

post
/death/_getfilestoreid
Query parameters
consumerCodestringOptional
dateOfDeathstringOptional
deathDtlIdstringOptional
deathcertificatenostringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
namestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
spouseNamestringOptional
tenantIdstringOptional
toDatestringOptional
Body
Responses
200

OK

*/*
post
/death/_getfilestoreid

plainSearch

post
/death/_plainsearch
Query parameters
consumerCodestringOptional
dateOfDeathstringOptional
deathDtlIdstringOptional
deathcertificatenostringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
namestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
spouseNamestringOptional
tenantIdstringOptional
toDatestringOptional
Body
Responses
200

OK

*/*
post
/death/_plainsearch

search

post
/death/_search
Query parameters
consumerCodestringOptional
dateOfDeathstringOptional
deathDtlIdstringOptional
deathcertificatenostringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
namestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
spouseNamestringOptional
tenantIdstringOptional
toDatestringOptional
Body
Responses
200

OK

*/*
post
/death/_search

searchApplications

post
/death/_searchapplications
Query parameters
consumerCodestringOptional
dateOfDeathstringOptional
deathDtlIdstringOptional
deathcertificatenostringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
namestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
spouseNamestringOptional
tenantIdstringOptional
toDatestringOptional
Body
Responses
200

OK

*/*
post
/death/_searchapplications

viewCertificateData

post
/death/_viewcertdata
Query parameters
consumerCodestringOptional
dateOfDeathstringOptional
deathDtlIdstringOptional
deathcertificatenostringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
namestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
spouseNamestringOptional
tenantIdstringOptional
toDatestringOptional
Body
Responses
200

OK

*/*
post
/death/_viewcertdata

viewfullCertMasterData

post
/death/_viewfullcertdata
Query parameters
consumerCodestringOptional
dateOfDeathstringOptional
deathDtlIdstringOptional
deathcertificatenostringOptional
fatherNamestringOptional
fromDatestringOptional
genderinteger · int32Optional
hospitalIdstringOptional
idstringOptional
limitinteger · int32Optional
motherNamestringOptional
namestringOptional
offsetinteger · int32Optional
registrationNostringOptional
sourcestring · enumOptionalPossible values:
spouseNamestringOptional
tenantIdstringOptional
toDatestringOptional
Body
Responses
200

OK

*/*
post
/death/_viewfullcertdata

Last updated

Was this helpful?