Here are the different codes that will work to add ads/listings output to your site:

First you need to know your company's cli #
Use your company's cli instead of the sample account cli=392
To find out our Agency CLI and your agent UID CLICK HERE TO LOG IN. The information is right on top next to the BostonApartments.com logo.

To display all the rental ads without a search:
http://www.bostonapartments.com/cli.php?cli=392

This link above displays with the following defaults: display advertised (active) listings, display 25 ads per page, display the results in a table that is 630 pixels wide and has a 4 column output.

You may customize the address and use the variables as follows:

http://www.bostonapartments.com/cli.php?cli=392&type=1&per_page=10&tablewidth=550&STATUS=avail&htype=ns&template=1colpix

tablewidth can be set by adding tablewidth=550 (where 550 is the # of pixels wide you want the output data)

FEATURES_FURNISHED can be set to "=on" or "=off" ( eg: http://www.bostonapartments.com/cli.php?cli=392&FEATURES_FURNISHED=on ) It on, only the furnished listings (where the box is checked in the features section of the input screen for listings/ads). If set to "=off" then only unfurnished ads will show. If not passed as a variable, all ads whether furnished or unfurnished will show.

type can be substituted as follows:

VALUE	TYPE
1	Rental (default)
2	Sale
3	Commercial Sale
4	Commercial Rental
5	Parking Spaces - Rent
6	Parking Spaces - Sale
7	Parking Spaces - Wanted
8	Vacation Rental
9	Rent To Own
10	Business Opportunities
11	Senior Living Rental
12	Senior Living Sale
13	Bank Owned

per_page is how many ads per page to paginate. The default is 25 ads per page.

You can pass different variable settings to cli.php producing links for different styles of output:

Setting STATUS variable to "avail" will show all "available listings" and NOT the "advertised". Setting STATUS to "active" will show advertised listings. (this is default). If you set the STATUS variable to "both", only listings that are marked available and advertised will show.

You can further customize the page by passing a "template" variable. Currently: 2col, 3col, 4col, templates are available. Customized list templates are available upon request. You can produce the output without stationary by setting "htype" variable to "ns". Custonm detail sheet layouts are also available.

You can use a form to search. There's a sample form at: http://www.bostonapartments.com/developer/form.html

You can pass along any fields in a hidden field like # of ads per page, the cli, etc.

If you want a photo gallery instead of a grid of photos (2x2 by how many rows - the default) you can pass the variable by adding " &gallery=yes ".

Other fields accepted are:

Date

VALUE	MONTH
01	January
02	February
03	March
04	April
05	May
06	June
07	July
08	August
09	September
10	October
11	November
12	December

agency this is used for agencies that have more than one office sharing a central database. Each office has an agency value in addition to the cli for the over all master agency. Not parsing an agency when you have sub-agencies will give only those listings assigned to the master account. adding &agency=off to the URL or as a value in a hidden field in a form will allow searching all listings for all sub-agencies as well as the master agency.

uid default is none so all the office listings show. You can add &uid=#### (where #### is the agent UID) so that only the ads for a specific agent in the company will be outputted vs. the whole office's listings.

usig default is no. You can add &usig=yes or parse as a hidden field in a form so that the Personalized Agent Signatures will appear in the output.

sig default is no. You can add &sig=yes or parse as a hidden field in a form so that the Company signature string will appear at the top of the list of ads.

If you want your company signature after each ad (a bit annoying to the reader), you need to have a custom ad template on line. You would then add &template=the_name_of_the_template to the request string or as a hidden field in a form.

Bedrooms

VALUE	# bedrooms
0.25	LOFT
0.50	STUDIO
0.75	STUDIO + ALCOVE
0.76	STUDIO - 2 ROOMS
0.79	STUDIO+LOFT BED
1.00	1 BEDROOM
1.50	1 BEDROOM SPLIT
1.75	1 BEDROOM PLUS
1.78	1 BEDROOM LOFT
2.00	2 BEDROOM
2.50	2 BEDROOM SPLIT
2.75	2 BEDROOM PLUS
2.78	2 BEDROOM LOFT
3.00	3 BEDROOM
3.50	3 BEDROOM SPLIT
3.75	3 BEDROOM PLUS
3.78	3 BEDROOM LOFT
4.00	4 BEDROOM
4.50	4 BEDROOM SPLIT
4.75	4 BEDROOM PLUS
4.78	4 BEDROOM LOFT
5.00	5 BEDROOM
5.50	5 BEDROOM SPLIT
5.75	5 BEDROOM PLUS
5.78	5 BEDROOM LOFT
6.00	6 BEDROOM
7.00	7 BEDROOM
8.00	8 BEDROOM
9.00	9 BEDROOM
10.00	10 BEDROOM
11.00	11 BEDROOM
12.00	12 BEDROOM
13.00	13 BEDROOM
14.00	14 BEDROOM
15.00	15 BEDROOM
16.00	16 BEDROOM
17.00	17 BEDROOM
18.00	18 BEDROOM
19.00	19 BEDROOM
20.00	20 BEDROOM

Location

VALUE	Town/Area
1	ABINGTON
2	ACTON
3	ACUSHNET
4	ADAMS
5	AGAWAM
6	ALFORD
7	AMESBURY
8	AMHERST
9	ANDOVER
10	ARLINGTON
11	ASHBY
12	ASHFIELD
13	ASHLAND
14	ATHOL
15	ATTLEBORO
16	AUBURN
17	AVON
18	AYER
19	BARNSTABLE
20	BARRE
481	BARRINGTON, RI
21	BECKET
22	BEDFORD
375	BEDFORD, NH
23	BELCHERTOWN
24	BELLINGHAM
25	BELMONT
26	BERKLEY
27	BERLIN
28	BERNARDSTON
29	BEVERLY
30	BILLERICA
31	BLACKSTONE
32	BLANDFORD
483	BLOCK ISLAND, RI
33	BOLTON
403	BONDSVILLE
34	BOSTON - ALLSTON
35	BOSTON - BACK BAY
36	BOSTON - BAY VILLAGE
37	BOSTON - BEACON HILL
38	BOSTON - BERKLEE COLLEGE AREA
39	BOSTON - BOSTON UNIVERSITY AREA
40	BOSTON - BRIGHAM CIRCLE
41	BOSTON - BRIGHTON
42	BOSTON - Brookline Line
398	BOSTON - CHARLES RIVER PARK
86	BOSTON - CHARLESTOWN
43	BOSTON - CHINATOWN
44	BOSTON - COPLEY SQUARE
45	BOSTON - DORCHESTER
46	BOSTON - DOWNTOWN
47	BOSTON - EAST BOSTON
381	BOSTON - EMERSON COLLEGE AREA
48	BOSTON - FENWAY
49	BOSTON - FINANCIAL DISTRICT
404	BOSTON - FORT HILL
389	BOSTON - FORT POINT
50	BOSTON - FORT POINT CHANNEL
51	BOSTON - GOVERNMENT CENTER
177	BOSTON - HYDE PARK
52	BOSTON - JAMAICA PLAIN
53	BOSTON - KENMORE SQUARE
400	BOSTON - LADDER DISTRICT
54	BOSTON - LEATHER DISTRICT
55	BOSTON - LONGWOOD
388	BOSTON - MATTAPAN
56	BOSTON - MISSION HILL
395	BOSTON - NEPONSET CIRCLE
57	BOSTON - NORTH END
58	BOSTON - NORTHEASTERN UNIV. AREA
379	BOSTON - PRUDENTIAL AREA
386	BOSTON - READVILLE
59	BOSTON - ROSLINDALE
60	BOSTON - ROXBURY
61	BOSTON - SEAPORT DISTRICT
62	BOSTON - SOUTH BOSTON
63	BOSTON - SOUTH END
382	BOSTON - SOUTH STATION
387	BOSTON - SUFFOLK UNIV. AREA
64	BOSTON - SYMPHONY
378	BOSTON - THEATER DISTRICT
65	BOSTON - WATERFRONT
66	BOSTON - WEST END
67	BOSTON - WEST ROXBURY
68	BOURNE
69	BOXBOROUGH
70	BOXFORD
71	BOYLSTON
392	BRADFORD
72	BRAINTREE
73	BREWSTER
74	BRIDGEWATER
75	BRIMFIELD
482	BRISTOL, RI
76	BROCKTON
77	BROOKFIELD
78	BROOKLINE
461	BROOKLINE - ASPINWALL HILL
462	BROOKLINE - BEACONSFIELD
463	BROOKLINE - BROOKLINE HILLS
464	BROOKLINE - BROOKLINE VILLAGE
465	BROOKLINE - BUTTONWOOD VILLAGE
466	BROOKLINE - CHESTNUT HILL
467	BROOKLINE - CLEVELAND CIRCLE
468	BROOKLINE - COOLIDGE CORNER
469	BROOKLINE - COREY FARM
470	BROOKLINE - COREY HILL
471	BROOKLINE - COTTAGE FARM
472	BROOKLINE - FISHER HILL
473	BROOKLINE - LONGWOOD
474	BROOKLINE - NORTH BROOKLINE
475	BROOKLINE - PILL HILL
476	BROOKLINE - PUTTERHAM CIRCLE
477	BROOKLINE - RUNKLE DISTRICT
478	BROOKLINE - SOUTH BROOKLINE
479	BROOKLINE - WASHINGTON SQUARE
480	BROOKLINE - WHISKEY POINT
79	BUCKLAND
80	BURLINGTON
484	BURRILLVILLE, RI
81	CAMBRIDGE
411	CAMBRIDGE - AGASSIZ
412	CAMBRIDGE - AVON HILL
413	CAMBRIDGE - CAMBRIDGE HIGHLANDS
414	CAMBRIDGE - CAMBRIDGEPORT
415	CAMBRIDGE - CENTRAL SQUARE
416	CAMBRIDGE - COOLIDGE HILL
417	CAMBRIDGE - EAST CAMBRIDGE
442	CAMBRIDGE - FRESH POND
418	CAMBRIDGE - HARVARD SQUARE
441	CAMBRIDGE - HURON VILLAGE
419	CAMBRIDGE - INMAN SQUARE
420	CAMBRIDGE - KENDALL SQUARE
421	CAMBRIDGE - MID CAMBRIDGE
443	CAMBRIDGE - Near Harvard
422	CAMBRIDGE - NORTH CAMBRIDGE
423	CAMBRIDGE - PORTER SQUARE
445	CAMBRIDGE - RADCLIFFE
424	CAMBRIDGE - RIVERSIDE
425	CAMBRIDGE - STRAWBERRY HILL
426	CAMBRIDGE - WEST CAMBRIDGE
82	CANTON
83	CAPE COD
391	CARLISLE
84	CARVER
485	CENTRAL FALLS, RI
85	CHARLEMONT
486	CHARLESTOWN, RI
87	CHATHAM
88	CHELMSFORD
89	CHELSEA
90	CHESHIRE
91	CHESTER
92	CHESTERFIELD
93	CHICOPEE
94	CHILMARK
95	CLARKSBURG
96	CLINTON
97	COHASSET
98	COLRAIN
99	CONCORD
100	CONWAY
487	COVENTRY, RI
405	CRANSTON, RI
401	CUMBERLAND, RI
101	CUMMINGTON
102	DALTON
103	DANVERS
104	DARTMOUTH
105	DEDHAM
106	DEERFIELD
107	DENNIS
376	DERRY, NH
108	DIGHTON
109	DOUGLAS
110	DOVER
111	DRACUT
112	DUDLEY
113	DUNSTABLE
114	DUXBURY
116	EAST BRIDGEWATER
117	EAST BROOKFIELD
488	EAST GREENWICH, RI
118	EAST LONGMEADOW
489	EAST PROVIDENCE, RI
119	EASTHAM
120	EASTHAMPTON
121	EASTON
122	EDGARTOWN
123	EGREMONT
124	ERVING
125	ESSEX
126	EVERETT
490	EXETER, RI
127	FAIRHAVEN
128	FALL RIVER
129	FALMOUTH
130	FITCHBURG
131	FLORIDA
491	FOSTER, RI
132	FOXBORO
133	FRAMINGHAM
134	FRANKLIN
135	FREETOWN
136	GARDNER
137	GAY HEAD
138	GEORGETOWN
139	GILL
140	GLOUCESTER
492	GLOUCESTER, RI
410	GOFFSTOWN, NH
141	GOSHEN
142	GOSNOLD
143	GRAFTON
144	GRANBY
145	GRANVILLE
146	GREAT BARRINGTON
147	GREENFIELD
148	GROTON
149	GROVELAND
150	HADLEY
151	HALIFAX
152	HAMILTON
153	HAMPDEN
154	HANCOCK
155	HANOVER
156	HANSON
157	HARDWICK
158	HARVARD
159	HARWICH
160	HATFIELD
161	HAVERHILL
162	HAWLEY
163	HEATH
164	HINGHAM
165	HINSDALE
166	HOLBROOK
167	HOLDEN
168	HOLLAND
169	HOLLISTON
170	HOLYOKE
171	HOPEDALE
172	HOPKINTON
493	HOPKINTON, RI
173	HUBBARDSTON
174	HUDSON
175	HULL
176	HUNTINGTON
178	IPSWICH
494	JAMESTOWN, RI
406	JOHNSTON, RI
180	KINGSTON
179	KINGSTON, RI
384	LAKE WINNIPESAUKEE, NH
181	LAKEVILLE
182	LANCASTER
183	LANESBOROUGH
184	LAWRENCE
185	LEE
186	LEICESTER
187	LENOX
188	LEOMINSTER
189	LEVERETT
190	LEXINGTON
191	LEYDEN
192	LINCOLN
495	LINCOLN, RI
496	LITTLE COMPTON, RI
193	LITTLETON
194	LONGMEADOW
195	LOWELL
196	LUDLOW
197	LUNENBURG
198	LYNN
199	LYNNFIELD
200	MALDEN
201	MANCHESTER
383	MANCHESTER, NH
202	MANSFIELD
203	MARBLEHEAD
204	MARION
205	MARLBOROUGH
206	MARSHFIELD
207	MARTHA'S VINEYARD
208	MASHPEE
210	MATTAPOISETT
211	MAYNARD
212	MEDFIELD
213	MEDFORD
214	MEDWAY
215	MELROSE
216	MENDON
217	MERRIMAC
218	METHUEN
219	MIDDLEBOROUGH
220	MIDDLEFIELD
221	MIDDLETON
497	MIDDLETOWN, RI
222	MILFORD
223	MILLBURY
224	MILLIS
225	MILLVILLE
226	MILTON
227	MONROE
228	MONSON
229	MONTAGUE
230	MONTEREY
231	MONTGOMERY
232	MOUNT WASHINGTON
233	NAHANT
234	NANTUCKET
498	NARRAGANSETT, RI
390	NASHUA, NH
235	NATICK
236	NEEDHAM
237	NEW ASHFORD
238	NEW BEDFORD
239	NEW BRAINTREE
240	NEW MARLBOROUGH
241	NEW SALEM
500	NEW SHOREHAM, RI
242	NEWBURY
243	NEWBURYPORT
447	NEWMARKET, NH
499	NEWPORT, RI
244	NEWTON
448	NEWTON - AUBURNDALE
449	NEWTON - CHESTNUT HILL
452	NEWTON - HIGHLANDS
453	NEWTON - LOWER FALLS
450	NEWTON - NEWTON CENTRE
451	NEWTON - NEWTON CORNER
455	NEWTON - NEWTONVILLE
456	NEWTON - NONANTUM
457	NEWTON - OAK HILL
458	NEWTON - THOMPSONVILLE
454	NEWTON - UPPER FALLS
459	NEWTON - WABAN
460	NEWTON - WEST NEWTON
245	NORFOLK
246	NORTH ADAMS
397	NORTH ANDOVER
247	NORTH ATTLEBOROUGH
248	NORTH BROOKFIELD
501	NORTH KINGSTOWN, RI
502	NORTH PROVIDENCE, RI
249	NORTH READING
503	NORTH SMITHFIELD, RI
250	NORTHAMPTON
251	NORTHBOROUGH
252	NORTHBRIDGE
253	NORTHFIELD
254	NORTON
255	NORWELL
256	NORWOOD
257	OAK BLUFFS
258	OAKHAM
393	ONSET
259	ORANGE
260	ORLEANS
399	OSTERVILLE
261	OTIS
262	OXFORD
263	PALMER
504	PAWTUCKET, RI
264	PAXTON
265	PEABODY
266	PELHAM
267	PEMBROKE
268	PEPPERELL
269	PERU
270	PETERSHAM
271	PHILLIPSTON
272	PITTSFIELD
273	PLAINFIELD
274	PLAINVILLE
275	PLYMOUTH
276	PLYMPTON
505	PORTSMOUTH, RI
277	PRINCETON
396	PROVIDENCE, RI
278	PROVINCETOWN
279	QUINCY
280	RANDOLPH
281	RAYNHAM
282	READING
283	REHOBOTH
284	REVERE
285	RICHMOND
506	RICHMOND, RI
286	ROCHESTER
446	ROCHESTER, NH
287	ROCKLAND
288	ROCKPORT
289	ROWE
290	ROWLEY
291	ROYALSTON
292	RUSSELL
293	RUTLAND
294	SALEM
394	SALEM, NH
295	SALISBURY
296	SANDISFIELD
297	SANDWICH
298	SAUGUS
299	SAVOY
300	SCITUATE
507	SCITUATE, RI
301	SEEKONK
302	SHARON
303	SHEFFIELD
304	SHELBURNE
305	SHERBORN
306	SHIRLEY
307	SHREWSBURY
308	SHUTESBURY
508	SMITHFIELD, RI
309	SOMERSET
310	SOMERVILLE
427	SOMERVILLE - BALL SQUARE
428	SOMERVILLE - DAVIS SQUARE
429	SOMERVILLE - EAST SOMERVILLE
430	SOMERVILLE - INMAN SQUARE
440	SOMERVILLE - KIRKLAND VILLAGE
439	SOMERVILLE - MAGOUN SQUARE
444	SOMERVILLE - Near Porter
431	SOMERVILLE - POWDERHOUSE SQUARE
432	SOMERVILLE - PROSPECT HILL
433	SOMERVILLE - SPRING HILL
434	SOMERVILLE - TEELE SQUARE
435	SOMERVILLE - TUFTS UNIVERSITY AREA
436	SOMERVILLE - UNION SQUARE
437	SOMERVILLE - WEST SOMERVILLE
438	SOMERVILLE - WINTER HILL
311	SOUTH HADLEY
509	SOUTH KINGSTOWN, RI
312	SOUTHAMPTON
313	SOUTHBOROUGH
314	SOUTHBRIDGE
315	SOUTHWICK
316	SPENCER
317	SPRINGFIELD
318	STERLING
319	STOCKBRIDGE
320	STONEHAM
321	STOUGHTON
322	STOWE
323	STURBRIDGE
324	SUDBURY
325	SUNDERLAND
326	SUTTON
327	SWAMPSCOTT
328	SWANSEA
329	TAUNTON
330	TEMPLETON
331	TEWKSBURY
332	TISBURY
510	TIVERTON, RI
333	TOLLAND
334	TOPSFIELD
335	TOWNSEND
402	TREMONT
336	TRURO
337	TYNGSBOROUGH
338	TYRINGHAM
339	UPTON
340	UXBRIDGE
341	WAKEFIELD
407	WAKEFIELD, RI
342	WALPOLE
343	WALTHAM
344	WARE
345	WAREHAM
346	WARREN
511	WARREN, RI
347	WARWICK
512	WARWICK, RI
348	WASHINGTON
349	WATERTOWN
350	WAYLAND
351	WEBSTER
352	WELLESLEY
353	WELLFLEET
354	WENDELL
355	WENHAM
385	WEST BRIDGEWATER
514	WEST GREENWICH, RI
408	WEST GREENWICH, RI
409	WEST WARWICK, RI
515	WEST WARWICK, RI
356	WESTBOROUGH
513	WESTERLY, RI
357	WESTFIELD
358	WESTFORD
359	WESTHAMPTON
360	WESTMINSTER
361	WESTON
362	WESTPORT
363	WESTWOOD
364	WEYMOUTH
365	WHITMAN
366	WILMINGTON
367	WINCHENDON
368	WINCHESTER
369	WINTHROP
370	WOBURN
516	WOONSOCKET, RI
371	WORCESTER
372	WORTHINGTON
373	WRENTHAM
374	YARMOUTH

A list of all the variables you can parse to cli are (Case sensitive):

cli
cid (the listings id number)
type
agency
usig
per_page
pageNum
Location
Bedrooms
Date
Price
BedroomsPlus
STATUS
template
htype
college
early_day
early_month
early_year
late_day
late_month
late_year
Rent_Low
Rent_High
LOC
TYPE
CLI
SCHOOL
luxury=on (Building Style 6)
luxury_apt=y (Luxury Apt. Checked)
building_type
not_building_type
featured
border
sig
MLS (=y for yes to include MLS listings)
nofee (=1 for yes)
new (=1 for yes)
shortterm (=1 for yes)
(can be lease type TAW or short-term or the body may contain "short-term", "short term" and many other terms used commonly in short term ads.)
furnished (=1 for yes)
(can be furnished checked in the features section or say "furnished" in the body of the ad.
agenteml (the agent's UID) - This feature allows the system to make the dynamic forms for listings go to a particular agent. For example if you search through an agent site vs. the office site response forms will be emailed to the agent vs. the office.
ahf=1 for agent headers and footers vs. office ones
dogs=1 for Dog Only Listings
pets=1 for Pet Only Listings

The natural sorting order is:
LOCNAME, STATUS_SALE (so sold show at the end in sales), PRICE, ROOMS (size).
You can sort by date by adding: &sort=date and the order will be:
LOCNAME, STATUS_SALE (so sold show at the end in sales), PRICE, ROOMS (size), AVAIL.
You can sort by price by adding: &sort=price and the order will be:
PRICE (lowest to highest), LOCNAME, STATUS_SALE (so sold show at the end in sales), ROOMS (size), AVAIL.
For the order to go highest price to lowest price add: &sort=priceh SIZE (smallest to biggest), AVAIL, PRICE (lowest to highest), LOCNAME.
For the order to go by size in the above order add: &sort=size2
SIZE (smallest to biggest), PRICE (lowest to highest), AVAIL, LOCNAME.
For the order to go by size in the above order add: &sort=size2 WhenUsing MLS you may want your listings to show before the MLS Listings. Which will sort High Price To Low, Location, etc. With Company Listings First.
For the order to go by size in the above order add: &sort=cosortph

You can submit to BostonApartments.com customized headers and footers or use a ns (non skinned output) for each type of ad/listing. Headers and footers must be written to have full URL's for all calls to graphics and links. The header and footer template files should be put in "BostonApartments.com Templates" under the "Admin" menu when logged into the database system.

Any questions, give me a call at 617-254-5501.

I do have some dynamic forms available that can be plugged in that'll only give search capability for options that have a positive result like only the towns where listing are rather than the whole list over every city/town. Documentation for those will be coming soon.