GET api/entity/family/GetFamilyAddresses

Gets the addresses associated with the specified families. These addresses can be filtered by the last time the family record was updated. (Note that the record can be updated even if the address has not been changed.)

Request Information

URI Parameters

Name	Description	Type	Additional information
FamilyIDs		Collection of integer	None.
Since		date	None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfDictionaryOfInt32AndListOfEntityAddress

Name	Type	Additional information
Result	Dictionary of integer [key] and Collection of EntityAddress [value]	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "1": [
      {
        "EntityID": 1,
        "EntityTypeID": 0,
        "LocationFlagID": 0,
        "Label": "sample string 4",
        "MailingTitle": "sample string 5",
        "AltMailingTitle": "sample string 6",
        "Address": {
          "ID": 1,
          "AddressLine1": "sample string 2",
          "AddressLine2": "sample string 3",
          "City": "sample string 4",
          "StateProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "TimeStamp": {
            "Created": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Modified": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Archived": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            }
          }
        }
      },
      {
        "EntityID": 1,
        "EntityTypeID": 0,
        "LocationFlagID": 0,
        "Label": "sample string 4",
        "MailingTitle": "sample string 5",
        "AltMailingTitle": "sample string 6",
        "Address": {
          "ID": 1,
          "AddressLine1": "sample string 2",
          "AddressLine2": "sample string 3",
          "City": "sample string 4",
          "StateProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "TimeStamp": {
            "Created": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Modified": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Archived": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            }
          }
        }
      }
    ],
    "2": [
      {
        "EntityID": 1,
        "EntityTypeID": 0,
        "LocationFlagID": 0,
        "Label": "sample string 4",
        "MailingTitle": "sample string 5",
        "AltMailingTitle": "sample string 6",
        "Address": {
          "ID": 1,
          "AddressLine1": "sample string 2",
          "AddressLine2": "sample string 3",
          "City": "sample string 4",
          "StateProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "TimeStamp": {
            "Created": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Modified": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Archived": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            }
          }
        }
      },
      {
        "EntityID": 1,
        "EntityTypeID": 0,
        "LocationFlagID": 0,
        "Label": "sample string 4",
        "MailingTitle": "sample string 5",
        "AltMailingTitle": "sample string 6",
        "Address": {
          "ID": 1,
          "AddressLine1": "sample string 2",
          "AddressLine2": "sample string 3",
          "City": "sample string 4",
          "StateProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "TimeStamp": {
            "Created": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Modified": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            },
            "Archived": {
              "PersonID": 1,
              "DateTime": "sample string 1"
            }
          }
        }
      }
    ]
  },
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":{"1":[{"EntityID":1,"EntityTypeID":0,"LocationFlagID":0,"Label":"sample string 4","MailingTitle":"sample string 5","AltMailingTitle":"sample string 6","Address":{"ID":1,"AddressLine1":"sample string 2","AddressLine2":"sample string 3","City":"sample string 4","StateProvince":"sample string 5","PostalCode":"sample string 6","Country":"sample string 7","TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}}},{"EntityID":1,"EntityTypeID":0,"LocationFlagID":0,"Label":"sample string 4","MailingTitle":"sample string 5","AltMailingTitle":"sample string 6","Address":{"ID":1,"AddressLine1":"sample string 2","AddressLine2":"sample string 3","City":"sample string 4","StateProvince":"sample string 5","PostalCode":"sample string 6","Country":"sample string 7","TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}}}],"2":[{"EntityID":1,"EntityTypeID":0,"LocationFlagID":0,"Label":"sample string 4","MailingTitle":"sample string 5","AltMailingTitle":"sample string 6","Address":{"ID":1,"AddressLine1":"sample string 2","AddressLine2":"sample string 3","City":"sample string 4","StateProvince":"sample string 5","PostalCode":"sample string 6","Country":"sample string 7","TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}}},{"EntityID":1,"EntityTypeID":0,"LocationFlagID":0,"Label":"sample string 4","MailingTitle":"sample string 5","AltMailingTitle":"sample string 6","Address":{"ID":1,"AddressLine1":"sample string 2","AddressLine2":"sample string 3","City":"sample string 4","StateProvince":"sample string 5","PostalCode":"sample string 6","Country":"sample string 7","TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}}}]},"Success":true,"ErrorText":"sample string 2"}