OBJECT
Query

GraphQL Schema definition

type Query {
#   get all clients on our system
# 
# Arguments
#   statuses: filter by client statuses
#   kinds: filter by client types
#   filter: additional filters defined a ClientFilter
allClients(
statuses: [ClientStatus],
kinds: [ClientType],
filter: ClientFilter
): [Client] 
#   determine if a user is the assigned agent for a prospect
# 
# Arguments
#   userId: ID of user 
#   prospectId: ID of prospect
#   clientName: name of client
isAgentOfProspect(
userId: Int!,
prospectId: Int!,
clientName: String!
): Boolean 
#   determine if a prospect is a prospect for a given client
# 
# Arguments
#   clientId: ID of client
#   prospectId: ID of prospect
isProspectOfClient(clientId: Int!, prospectId: Int!): Boolean 
#   retrieve a Client type by ID
# 
# Arguments
#   clientId: ID of client
clientById(clientId: Int): Client 
#   Get all plans for a given client.
# 
# Arguments
#   clientName: name of client
#   buildYourLot: is client a build-on-your-lot builder
#   active: retrieve only active plans
allPlans(clientName: String!, buildYourLot: Boolean, active: Boolean): [Plan] 
#   Get a list of all agents for the client
# 
# Arguments
#   clientName: name of client
#   communityId: optional community ID to filter list of agents 
#   returned
#   communityIds: optional list of community IDs to filter list of 
#   agents returned 
agentsByClient(
clientName: String!,
communityId: Int,
communityIds: [Int!]
): [Agent] 
#   Get a list of anewgo floorplan tags.
anewgoFloorplanTags: [AnewgoFloorplanTag] 
#   Get all floorplans for an inventory home
# 
# Arguments
#   clientName: name of client
#   inventoryId: ID of inventory of home 
baseInventoryFloorplans(
clientName: String!,
inventoryId: Int!
): [Floorplan] 
#   Get a list of Plan/Elevation that can be assigned on a given lot
# 
# Arguments
#   clientName: name of client
#   lotId: ID of lot
baseLotPlanElevations(clientName: String!, lotId: Int!): [PlanElevation] 
#   Get list of color schemes assignable to homes built on a lot
# 
# Arguments
#   clientName: name of client
#   lotId: ID of lot
baseLotSchemes(clientName: String!, lotId: Int!): [Scheme] 
#   get a list of all BlendElements
# 
# Arguments
#   clientName: optional client name to filter elements by client
blendElements(clientName: String): [BlendElement] 
#   retrieve a JSON structure of app customizations for a client
# 
# Arguments
#   clientName: name of client
builderAppConfig(clientName: String!): JSON 
#   get a MetroInfo type for a given community
# 
# Arguments
#   clientName: name of client
#   communityId: ID of community
citiesByCommunityMetro(
clientName: String!,
communityId: Int!
): MetroInfo 
#   get a MetroInfo type for a given metro
# 
# Arguments
#   metroId: ID of metro
citiesByMetro(metroId: Int!): MetroInfo 
#   get app customizations for a given client
# 
# Arguments
#   clientName: name of client
clientCustomizations(clientName: String): [Customization] 
#   get Client type by name
# 
# Arguments
#   clientName: name of client
clientByName(clientName: String): Client 
#   get all collections
# 
# Arguments
#   clientName: name of client
collections(clientName: String!): [Collection] 
#   Get a Color type by id
# 
# Arguments
#   colorId: ID of a color
color(colorId: Int!): Color 
#   Get all communities in a client
# 
# Arguments
#   clientName: name of client
#   active: set to true to filter results to active communities 
#   only
#   bonafide: set to true to filter results to bonafide communities
#   def: set to false (required)
communities(
clientName: String!,
active: Boolean,
bonafide: Boolean,
def: Boolean
): [Community] 
#   Get a single Community type by name or a list of Community type by IDs
# 
# Arguments
#   clientName: name of client
#   communityName: optional community name
#   communityIds: optional list of community IDs
communitiesByNameOrId(
clientName: String!,
communityName: String,
communityIds: [Int]!
): [Community] 
#   Get a Community by ID
# 
# Arguments
#   communityId: ID of community
#   clientName: name of client
#   planId: optional ID of plan
community(communityId: Int!, clientName: String!, planId: Int): Community 
#   Get a Community by name
# 
# Arguments
#   clientName: name of client
#   communityName: name of community
communityByName(clientName: String!, communityName: String!): Community 
#   Get a Community type that has been designated as a build_your_lot community
# 
# Arguments
#   clientName: name of client
communityBuildYourLot(clientName: String!): Community 
#   get a single community POI category
# 
# Arguments
#   clientName: 
#   poiCategoryId: 
communityPoiCategory(
clientName: String!,
poiCategoryId: Int!
): CommunityPoiCategory 
#   Get the salesAppConfig for a given community
# 
# Arguments
#   clientName: name of client
#   communityId: ID of community
communitySalesAppConfig(
clientName: String!,
communityId: Int!
): String! 
#   get a specific app customization value
# 
# Arguments
#   clientName: name of client
#   name: name of customization label
customization(clientName: String, name: String): Customization 
#   get the custom overlays for a given clientName from client's custom_overlay 
#   table
# 
# Arguments
#   clientName: 
customOverlays(clientName: String!): [Texture] 
# Arguments
#   clientName: 
defaultCommunity(clientName: String!): Community 
#   get elevation
# 
# Arguments
#   clientName: name of client
#   elevationId: ID of elevation
#   planId: optional plan ID
#   communityId: optional community ID
elevation(
clientName: String!,
elevationId: Int!,
planId: Int,
communityId: Int
): Elevation 
#   get elevations
#   Each resulting elevation corresponds to each one of the assignment inputs, 
#   queried by
#   the assignment's communityId, planId, and elevationId
# 
# Arguments
#   clientName: name of client
#   assignments: 
elevations(clientName: String!, assignments: [ElevationAssignment]): [Elevation] 
#   get elevation by name
#   only community and plan are name-based, elevation is still provided as ID
# 
# Arguments
#   clientName: 
#   elevationId: 
#   planName: 
#   communityName: 
elevationByName(
clientName: String!,
elevationId: Int!,
planName: String!,
communityName: String!
): Elevation 
#   Retrieve excluded Plan/Elevation for a given lot
# 
# Arguments
#   clientName: name of client
#   lotId: ID of lot
excludedLotPlanElevations(
clientName: String!,
lotId: Int!
): [PlanElevation] 
#   Retrieve excluded schemes for a single lot.
# 
# Arguments
#   clientName: name of client
#   lotId: ID of lot
excludedLotSchemes(clientName: String!, lotId: Int!): [Scheme] 
#   Get Plan Tags
allAnewgoPlanTags: [AnewgoPlanTag] 
#   Get Client specific Plan Tags
# 
# Arguments
#   clientName: name of Client
allClientPlanTags(clientName: String!): [ClientPlanTag] 
#   Get all categories for plan tags
allPlanTagCategories: [PlanTagCategory] 
#   Get all client-specific categories used by plan tags
# 
# Arguments
#   clientName: name of client
allClientPlanTagCategories(clientName: String!): [PlanTagCategory] 
#   Get Plan Tags by Category ID
# 
# Arguments
#   clientName: name of clienr
#   categoryId: ID of category
plansByTagCategoryId(clientName: String!, categoryId: Int!): [Plan] 
#   Get tags assigned to a plan
# 
# Arguments
#   clientName: name of Client
#   planId: ID of plan
tagsAssignedToPlan(clientName: String!, planId: Int!): [PlanTagElevation] 
#   Retrieve plans that match a Plan Tag
# 
# Arguments
#   clientName: name of client
#   tagId: ID of Plan Tag
plansByTagId(clientName: String!, tagId: Int!): [Plan] 
#   get a Floorplan Type
# 
# Arguments
#   clientName: name of client
#   floorplanId: ID of floorplan 
#   communityId: optional community ID
floorplan(clientName: String!, floorplanId: Int!, communityId: Int): Floorplan 
#   get floorplan alternate
# 
# Arguments
#   clientName: 
#   floorplanAltId: 
floorplanAlternate(clientName: String!, floorplanAltId: Int!): FloorplanAlternate 
#   get floorplans for a given elevation in a community
# 
# Arguments
#   clientName: name of client
#   communityName: name of community
#   planName: name of plan
#   elevationCaption: caption value for an elevation
floorplansByElevation(
clientName: String!,
communityName: String!,
planName: String!,
elevationCaption: String!
): ElevationFloorplans 
#   get floorplans for a given elevation in a community using IDs
#   this is preferred over the version that provides elevationCaption as an arg 
#   since some builders will not have
#   elevation caption specified if a plan only has 1 elevation
# 
# Arguments
#   clientName: name of client
#   communityId: ID of community
#   planId: ID of plan
#   elevationId: ID of elevation
floorplansByElevationId(
clientName: String!,
communityId: Int!,
planId: Int!,
elevationId: Int!
): ElevationFloorplans 
#   get floorplan group
# 
# Arguments
#   clientName: 
#   fpGroupId: 
fpGroup(clientName: String!, fpGroupId: Int!): FloorplanGroup 
#   get a community photo gallery
# 
# Arguments
#   clientName: name of client
#   galleryId: ID of gallery
gallery(clientName: String!, galleryId: Int!): CommunityGallery 
#   get a single community highlight photos
# 
# Arguments
#   clientName: name of client
#   highlightId: ID of highlight content
highlight(clientName: String!, highlightId: Int!): CommunityHighlight 
#   get a single home category
# 
# Arguments
#   categoryId: ID of the category
homeCategory(categoryId: Int!): HomeCategory 
#   get all home categories in the system.
homeCategories: [HomeCategory] 
#   get homesites for a given community. A Homesite type combines data in a Lot
#   type and Inventory type in a single flat structure.
# 
# Arguments
#   clientName: name of Client
#   communityId: ID of community
#   quickMoveInOnly: set to true for quick-move-in homes only
homesites(clientName: String!, communityId: Int!, quickMoveInOnly: Boolean): [Homesite] 
#   Get all home styles in the system.
homeStyles: [HomeStyle] 
#   Get a Siteplan Hotspot
# 
# Arguments
#   clientName: name of client
#   siteplanHotspotId: ID of the hotspot
hotspot(clientName: String!, siteplanHotspotId: Int!): SiteplanHotspot! 
#   Get included floorplans for a given inventory
# 
# Arguments
#   clientName: name of client
#   inventoryId: ID of the Inventory
includedInventoryFloorplans(
clientName: String!,
inventoryId: Int!
): [Floorplan] 
#   Retrieve a list of interiors, filtering by all specified fields.
# 
# Arguments
#   clientName: name of client
#   interior: an object with parameter specifying the interior
interiors(clientName: String!, interior: InteriorInput): [Interior] 
#   Retrieve a list of all interiors
# 
# Arguments
#   clientName: name of client
#   interiorId: an optional interior ID
interiorAssignments(clientName: String!, interiorId: Int): [InteriorAssignment] 
#   Retrieve interiorAssigments by CommunityId
# 
# Arguments
#   clientName: name of Client
#   communityId: ID of community
interiorAssignmentsByCommunity(
clientName: String!,
communityId: Int
): [InteriorAssignment] 
#   Retrieve a single interior package.
# 
# Arguments
#   clientName: name of client
#   currentInteriorPackageId: package ID
interiorPackage(
clientName: String!,
currentInteriorPackageId: Int!
): InteriorPackage 
#   Retrieve members of an interior package by ID
# 
# Arguments
#   clientName: name of client
#   currentInteriorPackageId: package ID
interiorPackageMembers(
clientName: String!,
currentInteriorPackageId: Int!
): [InteriorPackageMember] 
#   Retrieve all package member elements
# 
# Arguments
#   clientName: name of client
#   currentInteriorPackageId: package ID
#   interiorId: interior ID
interiorPackageMemberElements(
clientName: String!,
currentInteriorPackageId: Int!,
interiorId: Int!
): [InteriorPackageMemberElement] 
#   Retrieve a list of interior packages.
# 
# Arguments
#   clientName: name of client
#   interiorId: interior ID
interiorPackages(clientName: String, interiorId: Int): [InteriorPackage] 
#   Retrieve a list of inventory homes
# 
# Arguments
#   clientName: name of Client
#   inventoryIds: list of inventory IDs
inventories(clientName: String!, inventoryIds: [Int!]!): [Inventory] 
#   Retrieve an inventory
# 
# Arguments
#   clientName: name of client
#   lotId: optional ID for the lot
#   inventoryId: optional ID for the inventory 
inventory(clientName: String!, lotId: Int, inventoryId: Int): Inventory 
#   Retrieve lots with inventory homes
# 
# Arguments
#   clientName: name of client
#   communityIds: list of community IDs
inventoryLots(clientName: String!, communityIds: [Int]!): [Lot] 
#   Retrieve libraries by blendMode
# 
# Arguments
#   blendMode: 
libraries(blendMode: BlendModeTypes): [Library] 
#   Retrieve lot
# 
# Arguments
#   clientName: name of client
#   lotId: lot ID 
#   inventoryId: inventory ID 
lot(clientName: String!, lotId: Int, inventoryId: Int): Lot 
#   Retrieve a master development community
# 
# Arguments
#   clientName: name of client
#   masterCommunityId: ID of the master development community
#   masterCommunityName: Name of the master development community
masterCommunity(
clientName: String!,
masterCommunityId: Int,
masterCommunityName: String
): MasterCommunity 
#   Retrieve all master development communities
# 
# Arguments
#   clientName: name of client
masterCommunities(clientName: String!): [MasterCommunity] 
#   Retrieve all sub-communities in a master development community
# 
# Arguments
#   clientName: name of client
#   masterCommunityId: ID of master development community
subCommunities(clientName: String!, masterCommunityId: Int!): [Community] 
#   Get the salesAppConfig for a given master community
# 
# Arguments
#   clientName: name of client
#   masterCommunityId: ID of master development community
masterCommunitySalesAppConfig(
clientName: String!,
masterCommunityId: Int!
): String! 
#   get a list of all materials used in a client
# 
# Arguments
#   clientName: name of client
materials(clientName: String!): [BlendElement] 
#   get a list of all metros
# 
# Arguments
#   clientName: optional client name for retrieving metros filtered 
#   by client
metros(clientName: String): [MetroInfo] 
#   get all Metros by client, Cities by metroId, and Communities by cityId
# 
# Arguments
#   clientName: 
metrosCitiesCommunities(clientName: String!): [MetroInfo] 
#   checks if given client is an MLS Service paid client
# 
# Arguments
#   clientName: 
mlsServicesEnabled(clientName: String!): Boolean 
#   get a single Palette
# 
# Arguments
#   clientName: 
#   paletteId: 
palette(clientName: String!, paletteId: Int): Palette 
#   get all Palettes by client and (optionally) communityId
# 
# Arguments
#   clientName: 
#   communityId: 
#   elevationId: 
palettes(clientName: String!, communityId: Int, elevationId: Int): [Palette] 
#   get plan
# 
# Arguments
#   clientName: name of client
#   communityId: if provided, select elevations for plan filtered 
#   by this community
#   planId: ID of plan
#   defaultCommunity: set to false
plan(
clientName: String!,
communityId: Int,
planId: Int!,
defaultCommunity: Boolean
): Plan 
#   get plan
# 
# Arguments
#   clientName: name of client
#   communityName: name of community
#   planName: name of plan
planByName(clientName: String!, communityName: String!, planName: String!): Plan 
#   get the plan exterior photos for a specific client and plan
# 
# Arguments
#   clientName: name of client
#   planId: ID of plan
planExteriorAssets(clientName: String!, planId: Int!): [Photo] 
#   get the plan interior photos for a specific client and plan
# 
# Arguments
#   clientName: name of client
#   planId: ID of plan
planInteriorPhotos(clientName: String!, planId: Int!): [Photo] 
#   Get a list of plans.
# 
# Arguments
#   clientName: name of client
#   communityId: ID of community, if provided return only plans in 
#   the community
plans(clientName: String!, communityId: Int): [Plan] 
#   Get a list of paginated plans
# 
# Arguments
#   clientName: name of client
#   communityIds: list of communityIds to filter plans
#   limit: number of plans to return
#   offset: current cursor position
#   sortBy: value to sort plans by, PRICE, NAME
#   sortOrder: order, ASC, DESC
#   filter: 
paginatedPlans(
clientName: String!,
communityIds: [Int!],
limit: Int!,
offset: Int!,
sortBy: String!,
sortOrder: String!,
filter: SpecFilter
): PaginatedPlans 
#   Get a list of paginated lots
# 
# Arguments
#   clientName: name of client
#   communityIds: list of communities to filter plans
#   limit: number of inventory homes to return
#   offset: current cursor position,
#   sortBy: value to sort plans by, PRICE, NAME
#   filter: optional specification
paginatedInventoryLots(
clientName: String!,
communityIds: [Int]!,
limit: Int!,
offset: Int!,
sortBy: String!,
filter: SpecFilter
): PaginatedLots 
#   get paginated metro
# 
# Arguments
#   limit: number of Metro objects to return
#   offset: the current cursor position
#   sortBy: NAME
#   order: order for sort, ASC, DESC
#   filters: 
paginatedMetros(
limit: Int!,
offset: Int!,
sortBy: String!,
order: String!,
filters: JSON
): PaginatedMetros 
#   get paginated cities
# 
# Arguments
#   limit: number of City objects to return
#   offset: current cursor position
#   sortBy: valid values NAME
#   order: order for sort, ASC, DESC
#   filters: 
paginatedCities(
limit: Int!,
offset: Int!,
sortBy: String!,
order: String!,
filters: JSON
): PaginatedCities 
#   Get a list of plans by community ids
#   The list of plans returned is NOT deduped
# 
# Arguments
#   clientName: name of client
#   communityIds: list of community IDs 
plansByCommunities(clientName: String!, communityIds: [Int]!): [Plan] 
# Arguments
#   clientName: 
#   communityIds: 
planTagsByCommunities(
clientName: String!,
communityIds: [Int]!
): [ClientPlanTag] 
#   get a PM Floorplan
# 
# Arguments
#   clientName: 
#   pmFloorplanId: 
pmFloorplan(clientName: String!, pmFloorplanId: Int!): PMFloorplan 
#   get prospect data by email
# 
# Arguments
#   clientName: name of client
#   email: email address of prospect 
prospectByEmail(clientName: String!, email: String!): Prospect 
#   get prospect activities of prospect
# 
# Arguments
#   clientName: name of client
#   email: email address of prospect
getProspectActivities(clientName: String!, email: String!): JSON 
#   get base information of a prospect
# 
# Arguments
#   email: 
prospectBaseInfo(email: String!): ProspectBaseInfo 
#   get appointment requests made by a prospect
# 
# Arguments
#   clientName: client name
#   prospectId: ID of prospect
#   startDate: start date of a range of date to search
#   endDate: end date of a range of date to search
#   inventoryId: inventory ID
prospectSgtAppointments(
clientName: String!,
prospectId: Int,
startDate: Date,
endDate: Date,
inventoryId: Int
): [ProspectSgtData] 
#   get a particular color scheme
# 
# Arguments
#   clientName: 
#   communityId: 
#   planId: 
#   schemeId: 
scheme(clientName: String!, communityId: Int, planId: Int, schemeId: Int!): [Scheme] 
#   get all schemes for a client
# 
# Arguments
#   clientName: 
#   communityId: 
schemes(clientName: String!, communityId: Int): [Scheme] 
#   look for cities given a query string
# 
# Arguments
#   queryString: 
searchCities(queryString: String!): [CityInfo] 
#   get a siteplan
# 
# Arguments
#   clientName: name of client
#   communityId: community ID
#   communityName: community name
#   masterCommunityId: master development community ID
#   siteplanId: siteplan ID
#   siteplanName: siteplan Name
#   filter: other filter
#   active: set to true to retrieve active siteplan
siteplan(
clientName: String!,
communityId: Int,
communityName: String,
masterCommunityId: Int,
siteplanId: Int,
siteplanName: String,
filter: CommonQueryFilter,
active: Boolean
): Siteplan 
#   Get the siteplans for a single community.
#   Optionally get all lots with the site plan.
#   subDivison - identifies the subdivision to retrieve the siteplan from
# 
# Arguments
#   clientName: 
#   communityId: 
#   master: 
#   active: 
siteplans(
clientName: String!,
communityId: Int!,
master: Boolean,
active: Boolean
): [Siteplan!]! 
#   Front-end apps will not always have the communityId
# 
# Arguments
#   clientName: 
#   communityName: 
siteplanByName(clientName: String!, communityName: String!): Siteplan 
#   Get all SgtVendors, optionally filtered by given client
# 
# Arguments
#   clientName: 
sgtVendors(clientName: String): [SgtVendor] 
#   Get SgtVendor by id
# 
# Arguments
#   sgtVendorId: 
sgtVendor(sgtVendorId: Int!): SgtVendor 
#   get the standard features categories for the given clientName
# 
# Arguments
#   clientName: 
stdFeatureCategories(clientName: String!): [StdFeatureCategory] 
#   get the standard features for a given clientName
# 
# Arguments
#   clientName: 
#   sortByName: 
stdFeatures(clientName: String!, sortByName: Boolean): [StdFeature] 
#   get all standard features for a given community
# 
# Arguments
#   clientName: name of client
#   communityId: community ID
stdFeatureAssignments(clientName: String!, communityId: Int): [StdFeatureAssignment] 
#   get all community tags
# 
# Arguments
#   clientName: 
communityTagCategories(clientName: String!): [CommunityTagCategory] 
#   get all community tags
# 
# Arguments
#   clientName: 
#   sortByName: 
communityTags(clientName: String!, sortByName: Boolean): [CommunityTag] 
#   get community tags assigned to a community
# 
# Arguments
#   clientName: name of client
#   communityId: community ID
communityTagAssignments(
clientName: String!,
communityId: Int
): [CommunityTagAssignment] 
#   get all builder tag categories
builderTagCategories: [BuilderTagCategory] 
# Arguments
#   sortByName: 
builderTags(sortByName: Boolean): [BuilderTag] 
#   get tags for a given builder client
# 
# Arguments
#   clientName: name of client
builderTagAssignments(clientName: String!): [BuilderTagAssignment] 
#   Get a list of stories.
# 
# Arguments
#   clientName: 
stories(clientName: String!): [Story] 
testPublicQuery: String 
#   Get all the textures for brick library or stone library
# 
# Arguments
#   library: 
#   vendorId: 
textureLibrary(library: TextureLibraryType!, vendorId: Int!): [Texture] 
#   Get specific vendor for color, brick, or stone library. If you provide one or 
#   more vendor IDs
#   you will receive only the specified vendors. If you provide no vendor IDs you 
#   will
#   receive all vendors. If you provide an invalid ID you will receive an empty 
#   array.
# 
# Arguments
#   library: 
#   vendorIds: 
libraryVendors(library: LibraryType!, vendorIds: [Int]): [LibraryVendor] 
#   Get a texture by library and id
# 
# Arguments
#   clientName: 
#   library: 
#   textureId: 
texture(clientName: String, library: LibraryType, textureId: Int!): Texture 
#   return the selection state of a given prospect
# 
# Arguments
#   clientName: name of client
#   prospectIdentifier: a unique identifier string for a prospect
#   homeIdentifier: a unique identifier for a home designed by the 
#   prospect
getHomeSelection(
clientName: String!,
prospectIdentifier: String!,
homeIdentifier: String!
): JSON 
#   return the selection state of a given prospect using favorite ID
# 
# Arguments
#   clientName: name of client
#   favoriteIdentifier: favorite ID
getHomeSelectionByFavoriteId(
clientName: String!,
favoriteIdentifier: Int!
): JSON 
#   get cities
cities: [CityInfo] 
#   Get scheduled appointments for a given inventory
# 
# Arguments
#   clientName: name of client
#   inventoryId: ID of inventory home
inventorySgtAppointments(
clientName: String!,
inventoryId: Int!
): [ProspectSgtAppointment] 
#   get prospects for Client
# 
# Arguments
#   clientName: name of client
prospects(clientName: String!): [Prospect] 
#   get prospects by Community's external ID
# 
# Arguments
#   clientName: name of client
#   communityExternalId: external ID of a given community
prospectsByCommunityExternalId(
clientName: String!,
communityExternalId: String!
): [Prospect] 
#   Get all scheduled appointments
# 
# Arguments
#   clientName: name of client
sgtAppointments(clientName: String!): [ProspectSgtAppointment] 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
