person-address-infos
Operations addressed under /person-address-infos — 5 operations.
get-person-address-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<PersonAddressInfoDto>.
| Field | Declared type | Nullable |
|---|---|---|
ExternalServiceResultId | Guid? | yes |
CorrelationId | Guid? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-person-address-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.
addressNumberaddressOpenTextaddressSourcePermitted values — validated against the address_source parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Residency Address | no label seeded |
2 | Other Address | no label seeded |
addressTypePermitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | CityAddress | no label seeded |
2 | TownAddress | no label seeded |
3 | VillageAddress | no label seeded |
birthDatebuildingbuildingCodecitizenidcitycityCodecorrelationIdcountrycountryIddistrictdistrictCodeexternalServiceResultIdforeignAddressidneihgbourhoodneihgbourhoodCoderegionregionCodesectionsectionCodestreetstreetCodecreate-person-address-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 PersonAddressInfoDto.
| Field | Declared type | Nullable |
|---|---|---|
ExternalServiceResultId | Guid? | yes |
CorrelationId | Guid? | yes |
Member names are the service's declaration names.
create-person-address-info › Request Body optional
addressNumberaddressOpenTextaddressSourcePermitted values — validated against the address_source parameter.
| Value | Meaning |
|---|---|
1 | Residency Address |
2 | Other Address |
Permitted values — validated against the address_source parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Residency Address | no label seeded |
2 | Other Address | no label seeded |
addressTypePermitted values — validated against the address_type parameter.
| Value | Meaning |
|---|---|
1 | CityAddress |
2 | TownAddress |
3 | VillageAddress |
Permitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | CityAddress | no label seeded |
2 | TownAddress | no label seeded |
3 | VillageAddress | no label seeded |
birthDatebuildingbuildingCodecitizenidcitycityCodecorrelationIdcountrycountryIddistrictdistrictCodeexternalServiceResultIdforeignAddressneihgbourhoodneihgbourhoodCoderegionregionCodesectionsectionCodestreetstreetCodecreate-person-address-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.
addressNumberaddressOpenTextaddressSourcePermitted values — validated against the address_source parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Residency Address | no label seeded |
2 | Other Address | no label seeded |
addressTypePermitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | CityAddress | no label seeded |
2 | TownAddress | no label seeded |
3 | VillageAddress | no label seeded |
birthDatebuildingbuildingCodecitizenidcitycityCodecorrelationIdcountrycountryIdcreatedDatedistrictdistrictCodeexternalServiceResultIdforeignAddressidneihgbourhoodneihgbourhoodCoderegionregionCodesectionsectionCodestreetstreetCodeget-person-address-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 PersonAddressInfoDto.
| Field | Declared type | Nullable |
|---|---|---|
ExternalServiceResultId | Guid? | yes |
CorrelationId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_INTGRTN_49 | 400 | PERSON_ADDRESS_INFO_NOT_FOUND | Person address info not found |
path Parameters
citizenidget-person-address-info-by-citizenid › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
delete-person-address-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_49 | 400 | PERSON_ADDRESS_INFO_NOT_FOUND | Person address info not found |
path Parameters
citizeniddelete-person-address-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-address-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_49 | 400 | PERSON_ADDRESS_INFO_NOT_FOUND | Person address info not found |
path Parameters
iddelete-person-address-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.