Controller for dealing with our addresses or parts of an address. think mailing address API Reference

undefined

API Endpoint

https://app.memberzone.org

Request Content-Types: application/json

Response Content-Types: application/json

Schemes: https

Version: v1.0

Paths

Address

Endpoint to get country data

GET /api/address/countries

This is used by the flatfile contact imports

200 OK

SystemCountryTypes

Country data

type

SystemCountryTypes

Response Example (200 OK)

[
  {
    "CountryId": "string",
    "Name": "string",
    "Description": "string",
    "IsoAlpha2": "string",
    "IsoAlpha3": "string",
    "IsoNumeric": "integer",
    "Addresses": "string",
    "Counties": "string",
    "PostalCodeGeoDatas": "string",
    "SystemCountryRegions": "string"
  }
]

Address

Endpoint to get region data (aka states)

GET /api/address/regions

This is used by the flatfile contact imports

200 OK

SystemCountryRegion

Region Data

type

SystemCountryRegion

Response Example (200 OK)

[
  {
    "RegionId": "integer",
    "CountryId": "string",
    "Region": "string",
    "Abbreviation": "string",
    "PostalCodeGeoDatas": "string",
    "SystemCountryTypes": "string"
  }
]

Schema Definitions

SystemCountryTypes: object

CountryId: string
Name: string
Description: string
IsoAlpha2: string
IsoAlpha3: string
IsoNumeric: integer
Addresses: string
Counties: string
PostalCodeGeoDatas: string
SystemCountryRegions: string

Example

{
  "CountryId": "string",
  "Name": "string",
  "Description": "string",
  "IsoAlpha2": "string",
  "IsoAlpha3": "string",
  "IsoNumeric": "integer",
  "Addresses": "string",
  "Counties": "string",
  "PostalCodeGeoDatas": "string",
  "SystemCountryRegions": "string"
}

SystemCountryRegion: object

RegionId: integer
CountryId: string
Region: string
Abbreviation: string
PostalCodeGeoDatas: string
SystemCountryTypes: string

Example

{
  "RegionId": "integer",
  "CountryId": "string",
  "Region": "string",
  "Abbreviation": "string",
  "PostalCodeGeoDatas": "string",
  "SystemCountryTypes": "string"
}

Documentation by Spectacle