GET api/Address/GetPrimaryKitchenAddresses

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of R_CustomerAddress
NameDescriptionTypeAdditional information
LocationCordinates

W_CustomerAddress_LocationCordinates

None.

CountryName

string

None.

AddressLocked

YesNo

None.

AddressInUse

YesNo

None.

AddressID

integer

Required

Matching regular expression pattern: ^[0-9]{1,11}$

AddressNickName

string

Required

Matching regular expression pattern: ^[^\%\/\\\&\@\#\$\*\?\,\'\;\:\!\-]+$

String length: inclusive between 4 and 50

AddressStreetAddress1

string

Required

Matching regular expression pattern: ^[^\%\/\\\&\@\#\$\*\?\,\'\;\:\!\-]+$

String length: inclusive between 2 and 50

AddressStreetAddress2

string

Matching regular expression pattern: ^[^\%\/\\\&\@\#\$\*\?\,\'\;\:\!\-]+$

String length: inclusive between 0 and 50

AddressCity

string

Required

Matching regular expression pattern: ^[^\%\/\\\&\@\#\$\*\?\,\'\;\:\!\-]+$

AddressState

string

Required

Matching regular expression pattern: ^(?-i:A[LKSZRAEP]|C[AOT]|D[EC]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[ARW]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$

String length: inclusive between 2 and 20

AddressZipCode

string

Required

Matching regular expression pattern: ^\d{5}(-\d{4})?$

AddressCountry

string

Required

String length: inclusive between 3 and 40

Response Formats

application/json, text/json

Sample:
[
  {
    "locationCordinates": {
      "longitude": "sample string 1",
      "latitude": "sample string 2"
    },
    "countryName": "sample string 1",
    "addressLocked": "YES",
    "addressInUse": "YES",
    "addressID": 2,
    "addressNickName": "sample string 3",
    "addressStreetAddress1": "sample string 4",
    "addressStreetAddress2": "sample string 5",
    "addressCity": "sample string 6",
    "addressState": "sample string 7",
    "addressZipCode": "sample string 8",
    "addressCountry": "sample string 9"
  },
  {
    "locationCordinates": {
      "longitude": "sample string 1",
      "latitude": "sample string 2"
    },
    "countryName": "sample string 1",
    "addressLocked": "YES",
    "addressInUse": "YES",
    "addressID": 2,
    "addressNickName": "sample string 3",
    "addressStreetAddress1": "sample string 4",
    "addressStreetAddress2": "sample string 5",
    "addressCity": "sample string 6",
    "addressState": "sample string 7",
    "addressZipCode": "sample string 8",
    "addressCountry": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfR_CustomerAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures">
  <R_CustomerAddress>
    <AddressCity>sample string 6</AddressCity>
    <AddressCountry>sample string 9</AddressCountry>
    <AddressState>sample string 7</AddressState>
    <AddressStreetAddress1>sample string 4</AddressStreetAddress1>
    <AddressStreetAddress2>sample string 5</AddressStreetAddress2>
    <AddressZipCode>sample string 8</AddressZipCode>
    <AddressNickName>sample string 3</AddressNickName>
    <AddressID>2</AddressID>
    <AddressInUse>YES</AddressInUse>
    <AddressLocked>YES</AddressLocked>
    <CountryName>sample string 1</CountryName>
    <LocationCordinates>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
    </LocationCordinates>
  </R_CustomerAddress>
  <R_CustomerAddress>
    <AddressCity>sample string 6</AddressCity>
    <AddressCountry>sample string 9</AddressCountry>
    <AddressState>sample string 7</AddressState>
    <AddressStreetAddress1>sample string 4</AddressStreetAddress1>
    <AddressStreetAddress2>sample string 5</AddressStreetAddress2>
    <AddressZipCode>sample string 8</AddressZipCode>
    <AddressNickName>sample string 3</AddressNickName>
    <AddressID>2</AddressID>
    <AddressInUse>YES</AddressInUse>
    <AddressLocked>YES</AddressLocked>
    <CountryName>sample string 1</CountryName>
    <LocationCordinates>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
    </LocationCordinates>
  </R_CustomerAddress>
</ArrayOfR_CustomerAddress>

multipart/form-data

Sample:
<ArrayOfR_CustomerAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures"><R_CustomerAddress><AddressCity>sample string 6</AddressCity><AddressCountry>sample string 9</AddressCountry><AddressState>sample string 7</AddressState><AddressStreetAddress1>sample string 4</AddressStreetAddress1><AddressStreetAddress2>sample string 5</AddressStreetAddress2><AddressZipCode>sample string 8</AddressZipCode><AddressNickName>sample string 3</AddressNickName><AddressID>2</AddressID><AddressInUse>YES</AddressInUse><AddressLocked>YES</AddressLocked><CountryName>sample string 1</CountryName><LocationCordinates><Latitude>sample string 2</Latitude><Longitude>sample string 1</Longitude></LocationCordinates></R_CustomerAddress><R_CustomerAddress><AddressCity>sample string 6</AddressCity><AddressCountry>sample string 9</AddressCountry><AddressState>sample string 7</AddressState><AddressStreetAddress1>sample string 4</AddressStreetAddress1><AddressStreetAddress2>sample string 5</AddressStreetAddress2><AddressZipCode>sample string 8</AddressZipCode><AddressNickName>sample string 3</AddressNickName><AddressID>2</AddressID><AddressInUse>YES</AddressInUse><AddressLocked>YES</AddressLocked><CountryName>sample string 1</CountryName><LocationCordinates><Latitude>sample string 2</Latitude><Longitude>sample string 1</Longitude></LocationCordinates></R_CustomerAddress></ArrayOfR_CustomerAddress>