Skip to content

Latest commit

 

History

History
259 lines (174 loc) · 6.5 KB

File metadata and controls

259 lines (174 loc) · 6.5 KB

Agent Feed Format Specification

Introduction

Specification of JSON format for submitting an automated agent roster to Who's Who in Luxury Real Estate.

Example JSON

{
  "Agent": [
    {
      "JobTitle": "VP of Sneezing",
      "Media": [
        {
          "MediaCategory": "Profile Photo",
          "MediaModificationTimestamp": "2018-09-20 13:53:38 UTC",
          "MediaURL": "http://mydomain.com/mug.jpg"
        },
        {
          "MediaCategory": "Background Photo",
          "MediaModificationTimestamp": "2018-09-20 13:53:38 UTC",
          "MediaURL": "http://mydomain.com/background.jpg"
        },
        {
          "MediaCategory": "Video",
          "MediaModificationTimestamp": "2018-09-20 13:53:38 UTC",
          "MediaURL": "http://mydomain.com/video.mpg"
        }
      ],
      "MemberAddress1": "2110 Western Avenue",
      "MemberAddress2": null,
      "MemberCity": "Seattle",
      "MemberCountry": "US",
      "MemberCounty":"King",
      "MemberDescription": [
        {
          "remark": "I like sneezing, code, and Oxford commas.", 
          "languageCode": "en"
         }
       ],
      "MemberDirectPhone": "555-123-4567",
      "MemberEmail": "sneezer@luxre.com",
      "MemberFirstName": "Michael",
      "MemberKey": "LRE001",
      "MemberLanguages": [
        "en",
        "sv"
      ],
      "MemberLastName": "Edlund",
      "MemberMlsId": [
        "12345678",
        "MLSID123"
      ],
      "MemberMobilePhone": "555-1235050",
      "MemberOfficePhone": "555-3129090",
      "MemberOfficePhoneExt": null,
      "MemberPassword": null,
      "MemberPostalCode": "98121",
      "MemberPreferredPhone": "206-9879090",
      "MemberPreferredPhoneExt": null,
      "MemberLicenses": [
        {
          "number": "01424267",
          "stateCode": "CA"
        }
      ],
      "MemberStateOrProvince": "WA",
      "MemberTollFreePhone": "800-9879090",
      "ModificationTimestamp": "2018-09-20 13:53:38 UTC",
      "OfficeKey": "OFF123",
      "OfficeName": "ACME Brokerage",
      "SocialMedia": [
        {
          "SocialMediaType": "Twitter",
          "SocialMediaUrlOrId": "@arcticleo"
         },
         {
          "SocialMediaType": "LinkedIn",
          "SocialMediaUrlOrId": "https://www.linkedin.com/in/arcticleo/"
        },
        {
          "SocialMediaType": "Website",
          "SocialMediaUrlOrId": "http://myownsite.com"
        }
      ]
    }
  ]
}

Field Descriptions

Agent

Top level object. Contains an array of objects with the following attributes.

JobTitleString(50)

The title or position of the agent within their organization.

MemberAddress1String(50)

The street number, direction, name and suffix of the agent.

MemberAddress2String(50)

The unit/suite number of the agent.

MemberCityString(50)

The city of the agent.

MemberCountryString(2)

The two digit country abbreviation of the agent's postal address.

MemberCountyString(50)

The county of the agent.

MemberDescriptionString(8000)

The bio/description of the agent.

MemberDirectPhoneString(16)

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard.

MemberEmailString(80)

The email address of the agent.

MemberFirstNameString(50)

The first name of the agent.

MemberKeyString(255)

A unique string identifier for the agent.

MemberLanguagesArray of String(50)

An array with the ISO 639-1 codes of languages spoken by the agent.

MemberLastNameString(50)

The last name of the agent.

MemberMlsIdArray of String(25)

The identifiers for the MLSs that the agent is associated with.

MemberMobilePhoneString(16)

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard.

MemberOfficePhoneString(16)

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard.

MemberOfficePhoneExtString(10)

The extension of the given phone number (if applicable).

MemberPassword String(25)

If provided, the seed password that the agent's user will initially have. If left blank, a random password will be created and emailed to the agent's user.

MemberPostalCodeString(10)

The postal code of the agent.

MemberPreferredPhoneString(16)

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard.

MemberPreferredPhoneExtString(10)

The extension of the given phone number (if applicable).

MemberLicensesArray of JSON objects

number: String(50) - The license. stateCode: String(2) - The state in which the member is licensed.

MemberStateLicenseStateString(3)

The ISO 3166-2 code for the state or province in which the member is licensed.

MemberTollFreePhoneString(16)

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard.

ModificationTimestampTimestamp String(27)

Timestamp for when the agent record was last modified.

OfficeKeyString(255)

A unique string identifier for the office where the agent hangs their license.

OfficeNameString(255)

The legal name of the brokerage.

Media

The Media Resource is a representation of agent profile photos and videos.

MediaCategoryString(50)

Category describing the photo.

Allowed values:

  • Profile Photo
  • Background Photo
  • Video

MediaModificationTimestampTimestamp String(27)

Timestamp for when the photo was last updated. Update this value when a photo has changed but maintains the same name.

MediaURLString(8000)

The URI to the photo file referenced by this object.

SocialMedia

A collection of social media objects that is related to the agent.

SocialMediaTypeString(50)

The type of sites, blog, social media, the Member URL or ID is referring to.

Allowed values:

  • Facebook
  • Instagram
  • LinkedIn
  • Pinterest
  • Skype
  • Twitter
  • Website

SocialMediaUrlOrIdString(8000)

The website URL or ID of social media site or account that the Social Media Type is referring to.