Addresses

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Common/Addresses

Represents a queryable address.

GUID

ED951587-26A0-4BC8-9315-8FA5B9809546

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the address.
Addressee String The addressee of the address.

  • Max length is 100
  • Not nullable
Field1 String The first field of the address.

  • Max length is 50
Field2 String The second field of the address.

  • Max length is 50
Field3 String The third field of the address.

  • Max length is 50
Field4 String The fourth field of the address.

  • Max length is 50
Field5 String The fifth field of the address.

  • Max length is 50
Locality String The locality of the address.

  • Max length is 50
Region String The region of the address.

  • Max length is 50
PostalCode String The postal code of the address.

  • Max length is 10
AddressFormatType Int32 The format type of the address.

  • Generic: 0
  • PostalCodeCity: 1
  • CityStatePostalCode: 2
  • CityPostalCodeTwoRows: 3
  • CityProvinsPostalCode: 4
CountryId Int64 References Countries.
LanguageId Int64 The business key identifier of the language code.

References LanguageCodes.
FormReportTranslationGroupId Int64 The business key identifier of the form report translation group.

References FormReportTranslationGroup.
PostalCodeId Int64? The business key identifier of the postal code.

References PostalCode.

  • Obsolete since version 2.44 (Unavailable)

Example

{
  "Id": 0,
  "Addressee": null,
  "Field1": null,
  "Field2": null,
  "Field3": null,
  "Field4": null,
  "Field5": null,
  "Locality": null,
  "Region": null,
  "PostalCode": null,
  "AddressFormatType": 0,
  "CountryId": 0,
  "LanguageId": 0,
  "FormReportTranslationGroupId": 0,
  "PostalCodeId": null
}