person-infos
Operations addressed under /person-infos — 5 operations.
get-person-info-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<PersonInfoDto>.
| Field | Declared type | Nullable |
|---|---|---|
IsTemporary | bool | no |
RegistrationType | int? | yes |
ExternalServiceResultId | Guid | no |
Gender | int? | yes |
Status | int? | yes |
MaritalStatus | int? | yes |
IdentityCardType | int? | yes |
IssueReason | string | no |
Citizenid | string | no |
PreviousCitizenid | string | no |
FatherCitizenid | string | no |
SpouseCitizenid | string | no |
MotherCitizenid | string | no |
Name | string | no |
Surname | string | no |
PreviousSurname | string | no |
BirthDate | DateOnly? | yes |
BirthPlace | string | no |
MotherName | string | no |
FatherName | string | no |
FamilyRecordNo | string | no |
PersonRecordNo | string | no |
Binder | string | no |
RegisterCity | string | no |
RegisterDistrict | string | no |
RegistrationNumber | string | no |
SerialNumber | string | no |
IssueOffice | string | no |
IssueDate | DateOnly? | yes |
ValidityDate | DateOnly? | yes |
Nationality | int? | yes |
CountryId | int? | yes |
DeathDate | DateOnly? | yes |
Unit | string | no |
ForeignPermissionCity | string | no |
ForeignPermissionStartDate | DateOnly? | yes |
ForeignPermissionEndDate | DateOnly? | yes |
ForeignPermissionNumber | string | no |
CreatedDate | DateTime | no |
CorrelationId | Guid? | yes |
HasGuardian | bool? | yes |
GuardianshipType | int? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-person-info-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
binderbirthDatebirthPlacecitizenidcorrelationIdcountryIddeathDateexternalServiceResultIdfamilyRecordNofatherCitizenidfatherNameforeignPermissionCityforeignPermissionEndDateforeignPermissionNumberforeignPermissionStartDategenderguardianshipTypePermitted values — validated against the guardianship_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Unknown | en: Unknown · tr: Bilinmeyen · ar: غير معروف |
1 | Will | en: Will · tr: Vasiyet · ar: وصية |
2 | Revocation of Will | en: Revocation of Will · tr: Vasiyet İptali · ar: إلغاء الوصية |
3 | Appointment of Guardian | en: Appointment of Guardian · tr: Vasi Tayini · ar: تعيين الوصي |
4 | Lifetime Care Contract | en: Lifetime Care Contract · tr: Ölünceye Kadar Bakım Sözleşmesi · ar: عقد الرعاية مدى الحياة |
5 | Disinheritance | en: Disinheritance · tr: Mirasçılıktan Çıkarma · ar: الحرمان من الإرث |
6 | Cancellation of Lifetime Care Contract | en: Cancellation of Lifetime Care Contract · tr: Ölünceye Kadar Bakım Sözleşmesi İptali · ar: إلغاء عقد الرعاية مدى الحياة |
7 | Revocation of Disinheritance | en: Revocation of Disinheritance · tr: Mirasçılıktan Çıkarmanın İptali · ar: إلغاء الحرمان من الإرث |
8 | Revocation of Waiver of Inheritance | en: Revocation of Waiver of Inheritance · tr: Mirastan Feragatin İptali · ar: إلغاء التنازل عن الإرث |
9 | Inheritance Contract | en: Inheritance Contract · tr: Miras Sözleşmesi · ar: عقد الميراث |
10 | Cancellation of Inheritance Contract | en: Cancellation of Inheritance Contract · tr: Miras Sözleşmesi İptali · ar: إلغاء عقد الميراث |
11 | Withdrawal from Will | en: Withdrawal from Will · tr: Vasiyetten Dönme · ar: الرجوع عن الوصية |
hasGuardianididentityCardTypePermitted values — validated against the identity_card_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Birth Certificate | no label seeded |
2 | Identity Card | no label seeded |
3 | Blue Card | no label seeded |
4 | Passport | no label seeded |
isTemporaryissueDateissueOfficeissueReasonmaritalStatusmotherCitizenidmotherNamenamenationalitypersonRecordNopreviousCitizenidpreviousSurnameregisterCityregisterDistrictregistrationNumberregistrationTypePermitted values — validated against the registration_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | TEst | no label seeded |
0 | test_zero | no label seeded |
serialNumberspouseCitizenidstatusPermitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Open | no label seeded |
2 | Close | ar: إغلاق |
3 | Death | ar: الموت |
4 | Unseen | ar: غير مرئي |
5 | Renouncing Citizenship | ar: التخلي عن المواطنة |
14 | Stopped | ar: توقف |
15 | Secret | ar: سرّ |
surnameunitvalidityDatecreate-person-info
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PersonInfoDto.
| Field | Declared type | Nullable |
|---|---|---|
IsTemporary | bool | no |
RegistrationType | int? | yes |
ExternalServiceResultId | Guid | no |
Gender | int? | yes |
Status | int? | yes |
MaritalStatus | int? | yes |
IdentityCardType | int? | yes |
IssueReason | string | no |
Citizenid | string | no |
PreviousCitizenid | string | no |
FatherCitizenid | string | no |
SpouseCitizenid | string | no |
MotherCitizenid | string | no |
Name | string | no |
Surname | string | no |
PreviousSurname | string | no |
BirthDate | DateOnly? | yes |
BirthPlace | string | no |
MotherName | string | no |
FatherName | string | no |
FamilyRecordNo | string | no |
PersonRecordNo | string | no |
Binder | string | no |
RegisterCity | string | no |
RegisterDistrict | string | no |
RegistrationNumber | string | no |
SerialNumber | string | no |
IssueOffice | string | no |
IssueDate | DateOnly? | yes |
ValidityDate | DateOnly? | yes |
Nationality | int? | yes |
CountryId | int? | yes |
DeathDate | DateOnly? | yes |
Unit | string | no |
ForeignPermissionCity | string | no |
ForeignPermissionStartDate | DateOnly? | yes |
ForeignPermissionEndDate | DateOnly? | yes |
ForeignPermissionNumber | string | no |
CreatedDate | DateTime | no |
CorrelationId | Guid? | yes |
HasGuardian | bool? | yes |
GuardianshipType | int? | yes |
Member names are the service's declaration names.
create-person-info › Request Body
isTemporarybinderbirthDatebirthPlacecitizenidcorrelationIdcountryIddeathDateexternalServiceResultIdfamilyRecordNofatherCitizenidfatherNameforeignPermissionCityforeignPermissionEndDateforeignPermissionNumberforeignPermissionStartDategenderguardianshipTypePermitted values — validated against the guardianship_type parameter.
| Value | Meaning |
|---|---|
0 | Unknown |
1 | Will |
2 | Revocation of Will |
3 | Appointment of Guardian |
4 | Lifetime Care Contract |
5 | Disinheritance |
6 | Cancellation of Lifetime Care Contract |
7 | Revocation of Disinheritance |
8 | Revocation of Waiver of Inheritance |
9 | Inheritance Contract |
10 | Cancellation of Inheritance Contract |
11 | Withdrawal from Will |
Permitted values — validated against the guardianship_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Unknown | en: Unknown · tr: Bilinmeyen · ar: غير معروف |
1 | Will | en: Will · tr: Vasiyet · ar: وصية |
2 | Revocation of Will | en: Revocation of Will · tr: Vasiyet İptali · ar: إلغاء الوصية |
3 | Appointment of Guardian | en: Appointment of Guardian · tr: Vasi Tayini · ar: تعيين الوصي |
4 | Lifetime Care Contract | en: Lifetime Care Contract · tr: Ölünceye Kadar Bakım Sözleşmesi · ar: عقد الرعاية مدى الحياة |
5 | Disinheritance | en: Disinheritance · tr: Mirasçılıktan Çıkarma · ar: الحرمان من الإرث |
6 | Cancellation of Lifetime Care Contract | en: Cancellation of Lifetime Care Contract · tr: Ölünceye Kadar Bakım Sözleşmesi İptali · ar: إلغاء عقد الرعاية مدى الحياة |
7 | Revocation of Disinheritance | en: Revocation of Disinheritance · tr: Mirasçılıktan Çıkarmanın İptali · ar: إلغاء الحرمان من الإرث |
8 | Revocation of Waiver of Inheritance | en: Revocation of Waiver of Inheritance · tr: Mirastan Feragatin İptali · ar: إلغاء التنازل عن الإرث |
9 | Inheritance Contract | en: Inheritance Contract · tr: Miras Sözleşmesi · ar: عقد الميراث |
10 | Cancellation of Inheritance Contract | en: Cancellation of Inheritance Contract · tr: Miras Sözleşmesi İptali · ar: إلغاء عقد الميراث |
11 | Withdrawal from Will | en: Withdrawal from Will · tr: Vasiyetten Dönme · ar: الرجوع عن الوصية |
hasGuardianidentityCardTypePermitted values — validated against the identity_card_type parameter.
| Value | Meaning |
|---|---|
1 | Birth Certificate |
2 | Identity Card |
3 | Blue Card |
4 | Passport |
Permitted values — validated against the identity_card_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Birth Certificate | no label seeded |
2 | Identity Card | no label seeded |
3 | Blue Card | no label seeded |
4 | Passport | no label seeded |
issueDateissueOfficeissueReasonmaritalStatusmotherCitizenidmotherNamenamenationalitypersonRecordNopreviousCitizenidpreviousSurnameregisterCityregisterDistrictregistrationNumberregistrationTypePermitted values — validated against the registration_type parameter.
| Value | Meaning |
|---|---|
1 | TEst |
0 | test_zero |
Permitted values — validated against the registration_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | TEst | no label seeded |
0 | test_zero | no label seeded |
serialNumberspouseCitizenidstatusPermitted values — validated against the status parameter.
| Value | Meaning |
|---|---|
1 | Open |
2 | Close |
3 | Death |
4 | Unseen |
5 | Renouncing Citizenship |
14 | Stopped |
15 | Secret |
Permitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Open | no label seeded |
2 | Close | ar: إغلاق |
3 | Death | ar: الموت |
4 | Unseen | ar: غير مرئي |
5 | Renouncing Citizenship | ar: التخلي عن المواطنة |
14 | Stopped | ar: توقف |
15 | Secret | ar: سرّ |
surnameunitvalidityDatecreate-person-info › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
binderbirthDatebirthPlacecitizenidcorrelationIdcountryIdcreatedDatedeathDateexternalServiceResultIdfamilyRecordNofatherCitizenidfatherNameforeignPermissionCityforeignPermissionEndDateforeignPermissionNumberforeignPermissionStartDategenderguardianshipTypePermitted values — validated against the guardianship_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Unknown | en: Unknown · tr: Bilinmeyen · ar: غير معروف |
1 | Will | en: Will · tr: Vasiyet · ar: وصية |
2 | Revocation of Will | en: Revocation of Will · tr: Vasiyet İptali · ar: إلغاء الوصية |
3 | Appointment of Guardian | en: Appointment of Guardian · tr: Vasi Tayini · ar: تعيين الوصي |
4 | Lifetime Care Contract | en: Lifetime Care Contract · tr: Ölünceye Kadar Bakım Sözleşmesi · ar: عقد الرعاية مدى الحياة |
5 | Disinheritance | en: Disinheritance · tr: Mirasçılıktan Çıkarma · ar: الحرمان من الإرث |
6 | Cancellation of Lifetime Care Contract | en: Cancellation of Lifetime Care Contract · tr: Ölünceye Kadar Bakım Sözleşmesi İptali · ar: إلغاء عقد الرعاية مدى الحياة |
7 | Revocation of Disinheritance | en: Revocation of Disinheritance · tr: Mirasçılıktan Çıkarmanın İptali · ar: إلغاء الحرمان من الإرث |
8 | Revocation of Waiver of Inheritance | en: Revocation of Waiver of Inheritance · tr: Mirastan Feragatin İptali · ar: إلغاء التنازل عن الإرث |
9 | Inheritance Contract | en: Inheritance Contract · tr: Miras Sözleşmesi · ar: عقد الميراث |
10 | Cancellation of Inheritance Contract | en: Cancellation of Inheritance Contract · tr: Miras Sözleşmesi İptali · ar: إلغاء عقد الميراث |
11 | Withdrawal from Will | en: Withdrawal from Will · tr: Vasiyetten Dönme · ar: الرجوع عن الوصية |
hasGuardianididentityCardTypePermitted values — validated against the identity_card_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Birth Certificate | no label seeded |
2 | Identity Card | no label seeded |
3 | Blue Card | no label seeded |
4 | Passport | no label seeded |
isTemporaryissueDateissueOfficeissueReasonmaritalStatusmotherCitizenidmotherNamenamenationalitypersonRecordNopreviousCitizenidpreviousSurnameregisterCityregisterDistrictregistrationNumberregistrationTypePermitted values — validated against the registration_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | TEst | no label seeded |
0 | test_zero | no label seeded |
serialNumberspouseCitizenidstatusPermitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Open | no label seeded |
2 | Close | ar: إغلاق |
3 | Death | ar: الموت |
4 | Unseen | ar: غير مرئي |
5 | Renouncing Citizenship | ar: التخلي عن المواطنة |
14 | Stopped | ar: توقف |
15 | Secret | ar: سرّ |
surnameunitvalidityDateget-person-info-by-citizenid
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PersonInfoDto.
| Field | Declared type | Nullable |
|---|---|---|
IsTemporary | bool | no |
RegistrationType | int? | yes |
ExternalServiceResultId | Guid | no |
Gender | int? | yes |
Status | int? | yes |
MaritalStatus | int? | yes |
IdentityCardType | int? | yes |
IssueReason | string | no |
Citizenid | string | no |
PreviousCitizenid | string | no |
FatherCitizenid | string | no |
SpouseCitizenid | string | no |
MotherCitizenid | string | no |
Name | string | no |
Surname | string | no |
PreviousSurname | string | no |
BirthDate | DateOnly? | yes |
BirthPlace | string | no |
MotherName | string | no |
FatherName | string | no |
FamilyRecordNo | string | no |
PersonRecordNo | string | no |
Binder | string | no |
RegisterCity | string | no |
RegisterDistrict | string | no |
RegistrationNumber | string | no |
SerialNumber | string | no |
IssueOffice | string | no |
IssueDate | DateOnly? | yes |
ValidityDate | DateOnly? | yes |
Nationality | int? | yes |
CountryId | int? | yes |
DeathDate | DateOnly? | yes |
Unit | string | no |
ForeignPermissionCity | string | no |
ForeignPermissionStartDate | DateOnly? | yes |
ForeignPermissionEndDate | DateOnly? | yes |
ForeignPermissionNumber | string | no |
CreatedDate | DateTime | no |
CorrelationId | Guid? | yes |
HasGuardian | bool? | yes |
GuardianshipType | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_INTGRTN_17 | 400 | CITIZEN_NUMBER_NOT_FOUND | Citizen Number cannot be found. |
path Parameters
citizenidget-person-info-by-citizenid › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
delete-person-info-by-citizenid
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_INTGRTN_47 | 400 | PERSON_INFO_NOT_FOUND | Person Info Parameter not found. |
path Parameters
citizeniddelete-person-info-by-citizenid › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-person-info
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_INTGRTN_47 | 400 | PERSON_INFO_NOT_FOUND | Person Info Parameter not found. |
path Parameters
iddelete-person-info › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.