{"items":[{"type":"link","label":"LeadGen - Occupant","link":"/apis/leadgen-occupant","routeSlug":"/apis/leadgen-occupant","content":{"contentType":"overview","seo":{"description":"LeadGen Occupant API by Melissa. Access occupant-level data for targeted marketing and outreach campaigns."},"meta":{"name":"LeadGen - Occupant"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"leadgen-occupant.json","url":"/_bundle/apis/leadgen-occupant.json?download"},{"kind":"download","label":"leadgen-occupant.yaml","url":"/_bundle/apis/leadgen-occupant.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"csharpnewtonsoft","title":"C#+Newtonsoft","lang":"C#+Newtonsoft"},{"key":"java8","title":"Java8+Apache","lang":"Java8+Apache"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"http://list.melissadata.net/V1/occupant/rest/Service.svc","description":"Occupant Service Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"LeadGen - Occupant","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/apis/leadgen-occupant"}],"sectionId":"/apis/leadgen-occupant"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/leadgen-occupant-overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LeadGen - Occupant Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the LeadGen Occupant by Melissa. The Occupant Cloud API is a REST based Cloud API that can be used to select, get counts, and purchase targeted consumer mailing lists, in realtime, anytime. The LeadGen services are available to mailers for private, in-house use, or as a portal for your customers to use to make their list selections. You can custom-design a website to meet your own needs, as well as those of your customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Take advantage of your buying power with Melissa, and pass the discounted prices, along with an impressive selection of mailing lists and sales leads, onto your customers. They'll appreciate the convenience, the price, and your service. Please note that the Occupant Cloud API requires a License Key that has been activated for the Occupant Cloud API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/reference-data/leadgen-occupant/leadgen-occupant-reference-guide.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LeadGen Occupant Documentation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful Resources"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/MelissaData/MelissaCloudAPI-OpenAPI-Specification/blob/main/openapi/apis/leadgen-occupant.yaml"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GitHub - LeadGen Occupant Open API Specification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://releasenotes.melissa.com/reference-data/leadgen-occupant/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Release notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/other/status-codes-index.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status codes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.melissa.com/direct/mailing-lists-sales-leads/leadgen-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://www.melissa.com/direct/mailing-lists-sales-leads/leadgen-api"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support Center"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.melissa.com/company/product-support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://www.melissa.com/company/product-support"},"children":[]}]}]}]}]}],"sectionId":"/apis/leadgen-occupant/section/leadgen-occupant-overview"}]}]}},{"type":"link","label":"LeadGen - Occupant Overview","link":"/apis/leadgen-occupant/section/leadgen-occupant-overview","routeSlug":"/apis/leadgen-occupant/section/leadgen-occupant-overview","content":null},{"type":"group","label":"Occupant Service","link":"/apis/leadgen-occupant/occupant-service","routeSlug":"/apis/leadgen-occupant/occupant-service","items":[{"label":"Perform action for a single occupant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/leadgen-occupant/occupant-service/getoccupantservice","routeSlug":"/apis/leadgen-occupant/occupant-service/getoccupantservice","metadata":{"seo":{"title":"Perform action for a single occupant","description":"Uses HTTP GET to accept one input record and returns the response in XML format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOccupantService","name":"Perform action for a single occupant","isWebhook":false,"pointer":"/paths/~1{action}~1{format}~1{geographicType}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perform action for a single occupant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uses HTTP GET to accept one input record and returns the response in XML format."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"action","in":"path","schemaId":"schema_281","description":"There are two available actions: get and buy. get: Get count of addresses that fit in the given criteria. buy: Buy a list of addresses' info that fit the given criteria.\n","required":true,"example":"get"},{"name":"format","in":"path","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"json"},{"name":"geographicType","in":"path","schemaId":"schema_283","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each request must specify a single geographic type. Here are the available "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/reference-data/leadgen-occupant/leadgen-occupant-reference-guide.html#geographic-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": zip, city, county, radiusbymiles, radiusbyrecords, states, countiesbystate, citiesbystate, zipsbycity, crtsbyzip."},"children":[]}]}]}],"required":true,"example":"zip"}],"pointer":"/paths/~1{action}~1{format}~1{geographicType}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer ID, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/melissa/license/license-information.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"License Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or Email Address. This is checked against the list of registered customers."},"children":[]}]}]}],"required":true,"example":"REPLACE-WITH-YOUR-LICENSE-KEY"},{"name":"zip","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-delimited list of five-digit ZIP Codes. Can also include partial ZIP codes with a wild card. Ex: “92688, 90210” or “926*”"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: RadiusByMiles, RadiusByRecords, city, county"},"children":[]}]}]}]}],"required":true,"example":"92688"},{"name":"crrt","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-delimited list of carrier routes within the selected ZIP Codes. Format is “crrt-zip”.Ex: “C001-92688, R002-90210”"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: zip, city, RadiusByMiles"},"children":[]}]}]}]}],"required":true,"example":"b007-92688"},{"name":"mile","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to 1 to include residential addresses not located on rural routes, if any exist in the selected area. Do not include or set to 0 to exclude these addresses from the counts or purchased list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: RadiusByMiles"},"children":[]}]}]}]}]},{"name":"count","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of records around the submitted address to search. Maximum is 100,000 (65,535 when buying an Excel file)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: RadiusByRecords"},"children":[]}]}]}]}]},{"name":"address","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address that will be the center of the search area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: RadiusByMiles, RadiusByRecords"},"children":[]}]}]}]}]},{"name":"state","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-character abbreviation for the desired state. Ex: “state=ca”."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: city, county"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: RadiusByMiles, RadiusByRecords, CitiesByState, CountiesByState"},"children":[]}]}]}]}]},{"name":"city","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be the name of an existing city within the selected state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: city"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: RadiusByMiles, RadiusByRecords"},"children":[]}]}]}]}]},{"name":"county","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be the name of an existing county within the selected state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: county"},"children":[]}]}]}]}]},{"name":"cityres","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes residential addresses not located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: cityres=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: cityres=0 or do not include."},"children":[]}]}]}]},{"name":"cityapt","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes apartment addresses not located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: cityapt=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: cityapt=0 or do not include."},"children":[]}]}]}]},{"name":"citybiz","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes business and commercial addresses not located on rural routes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: citybiz=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: citybiz=0 or do not include."},"children":[]}]}]}]},{"name":"pores","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes PO Boxes rented by residential customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: pores=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: pores=0 or do not include."},"children":[]}]}]}]},{"name":"pobiz","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes PO Boxes rented by commercial customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: pobiz=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: pobiz=0 or do not include."},"children":[]}]}]}]},{"name":"ruralres","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes residential addresses located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: ruralres=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: ruralres=0 or do not include."},"children":[]}]}]}]},{"name":"ruralapt","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes apartment addresses located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: ruralapt=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: ruralapt=0 or do not include."},"children":[]}]}]}]},{"name":"ruralbiz","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes business and commercial addresses located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: ruralbiz=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: ruralbiz=0 or do not include."},"children":[]}]}]}]},{"name":"multi","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy Requests Only. By default, purchased lists may be used once. With this parameter included in the Buy call, you can purchase the right to use a list for multiple mailings. Specify the number of uses like this: multi=4. The maximum number of uses allowed for any purchased list is 5."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: multi=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output Parameter: multi=(1 through 5)"},"children":[]}]}]}]},{"name":"file","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy Requests Only. Defines the desired file format of a purchased list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: file=(none)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output Parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: Zipped .txt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: Zipped .csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: Zipped .xls (Excel)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: .txt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Default) File Format: .csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: .xls (Excel)"},"children":[]}]}]}]}]},{"name":"po","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy Requests Only. Defines the customer's purchase order number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: N/A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To specify: po=xxxx"},"children":[]}]}]}]},{"name":"name","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For count, a separate count of names will be given."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For purchase, extra columns will be added: pre name, first name, initial, last name, post name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to 1 to include personal names when they are available. Do not include or set to 0 to not include names."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: name=0"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To include: name=1"},"children":[]}]}]}]},{"name":"dbug","in":"query","schemaId":"schema_284","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter check. If a parameter in the url is spelled wrong or not suited for the given call, the request will be rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: dbug=0"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To check: dbug=1"},"children":[]}]}]}]}],"pointer":"/paths/~1{action}~1{format}~1{geographicType}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_285","description":"Format of the response.","required":true,"example":"application/xml"},{"name":"Content-Type","in":"header","schemaId":"schema_286","description":"Format of the request.","required":true}],"pointer":"/paths/~1{action}~1{format}~1{geographicType}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{action}/{format}/{geographicType}","servers":[{"url":"http://list.melissadata.net/V1/occupant/rest/Service.svc","description":"Occupant Service Server"}],"parameters":{"path":[{"name":"action","in":"path","required":true,"example":"get","schemaId":"schema_281"},{"name":"format","in":"path","required":true,"example":"json","schemaId":"schema_282"},{"name":"geographicType","in":"path","required":true,"example":"zip","schemaId":"schema_283"}],"query":[{"name":"id","in":"query","required":true,"example":"REPLACE-WITH-YOUR-LICENSE-KEY","schemaId":"schema_284"},{"name":"zip","in":"query","required":true,"example":"92688","schemaId":"schema_284"},{"name":"crrt","in":"query","required":true,"example":"b007-92688","schemaId":"schema_284"},{"name":"mile","in":"query","schemaId":"schema_284"},{"name":"count","in":"query","schemaId":"schema_284"},{"name":"address","in":"query","schemaId":"schema_284"},{"name":"state","in":"query","schemaId":"schema_284"},{"name":"city","in":"query","schemaId":"schema_284"},{"name":"county","in":"query","schemaId":"schema_284"},{"name":"cityres","in":"query","schemaId":"schema_284"},{"name":"cityapt","in":"query","schemaId":"schema_284"},{"name":"citybiz","in":"query","schemaId":"schema_284"},{"name":"pores","in":"query","schemaId":"schema_284"},{"name":"pobiz","in":"query","schemaId":"schema_284"},{"name":"ruralres","in":"query","schemaId":"schema_284"},{"name":"ruralapt","in":"query","schemaId":"schema_284"},{"name":"ruralbiz","in":"query","schemaId":"schema_284"},{"name":"multi","in":"query","schemaId":"schema_284"},{"name":"file","in":"query","schemaId":"schema_284"},{"name":"po","in":"query","schemaId":"schema_284"},{"name":"name","in":"query","schemaId":"schema_284"},{"name":"dbug","in":"query","schemaId":"schema_284"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/xml","schemaId":"schema_285"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_286"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/{action}/{format}/{geographicType}","href":"occupant-service/getoccupantservice","openApiOperationId":"getOccupantService","summary":"Perform action for a single occupant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://list.melissadata.net/V1/occupant/rest/Service.svc","description":"Occupant Service Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupantServiceResponse","exampleIds":["paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1json/examples/default"]},"application/xml":{"exampleIds":["paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1xml/example"]}},"schemaId":"components/schemas/OccupantServiceResponse","exampleIds":["paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_287"}},"schemaId":"schema_287"}],"pointer":"/paths/~1{action}~1{format}~1{geographicType}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OccupantServiceResponse","exampleIds":["paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupantServiceResponse","exampleIds":["paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1json/examples/default"]},"application/xml":{"exampleIds":["paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1xml/example"]}}},{"code":"400","schemaId":"schema_287","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_287"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupant-service/getoccupantservice"}],"panels":[]}]},"httpPath":"/{action}/{format}/{geographicType}"},{"label":"Check order (file) status after a buy request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/leadgen-occupant/occupant-service/getfilestatus","routeSlug":"/apis/leadgen-occupant/occupant-service/getfilestatus","metadata":{"seo":{"title":"Check order (file) status after a buy request","description":"Uses HTTP POST to accept a URL or OrderId and returns the File Status response in JSON format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFileStatus","name":"Check order (file) status after a buy request","isWebhook":false,"pointer":"/paths/~1getFileStatus/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check order (file) status after a buy request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uses HTTP POST to accept a URL or OrderId and returns the File Status response in JSON format."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_286","description":"Format of the request.","required":true}],"pointer":"/paths/~1getFileStatus/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileStatusRequest","exampleIds":["paths/~1getFileStatus/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/FileStatusRequest","exampleIds":["paths/~1getFileStatus/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1getFileStatus/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/getFileStatus","servers":[{"url":"http://list.melissadata.net/V1/occupant/rest/Service.svc","description":"Occupant Service Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_286"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/FileStatusRequest","exampleIds":["paths/~1getFileStatus/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400"],"pointer":"/getFileStatus","href":"occupant-service/getfilestatus","openApiOperationId":"getFileStatus","summary":"Check order (file) status after a buy request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://list.melissadata.net/V1/occupant/rest/Service.svc","description":"Occupant Service Server"}],"schemaId":"components/schemas/FileStatusRequest","exampleIds":["paths/~1getFileStatus/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileStatusRequest","exampleIds":["paths/~1getFileStatus/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileStatusResponse","exampleIds":["paths/~1getFileStatus/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/FileStatusResponse","exampleIds":["paths/~1getFileStatus/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_287"}},"schemaId":"schema_287"}],"pointer":"/paths/~1getFileStatus/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileStatusResponse","exampleIds":["paths/~1getFileStatus/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileStatusResponse","exampleIds":["paths/~1getFileStatus/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_287","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_287"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupant-service/getfilestatus"}],"panels":[]}]},"httpPath":"/getFileStatus"}],"content":{"contentType":"group","meta":{"name":"Occupant Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Occupant Service","showPageActions":true},{"nodeType":"markdoc","content":"Use Occupant Service endpoint to request various occupant service actions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{action}/{format}/{geographicType}","summary":"Perform action for a single occupant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/occupant-service/getoccupantservice","deprecated":false},{"title":"/getFileStatus","summary":"Check order (file) status after a buy request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/occupant-service/getfilestatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/OccupantServiceRequest":{"id":"components/schemas/OccupantServiceRequest","kind":"json-schema","title":"OccupantServiceRequest","data":{"type":"object","properties":{"CustomerID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer ID, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/melissa/license/license-information.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"License Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or Email Address. This is checked against the list of registered customers."},"children":[]}]}]}]},"Zip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-delimited list of five-digit ZIP Codes. Can also include partial ZIP codes with a wild card. Ex: “92688, 90210” or “926*”"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: RadiusByMiles, RadiusByRecords, city, county"},"children":[]}]}]}]}]},"Crrt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-delimited list of carrier routes within the selected ZIP Codes. Format is “crrt-zip”.Ex: “C001-92688, R002-90210”"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: zip, city, RadiusByMiles"},"children":[]}]}]}]}]},"Mile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to 1 to include residential addresses not located on rural routes, if any exist in the selected area. Do not include or set to 0 to exclude these addresses from the counts or purchased list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: RadiusByMiles"},"children":[]}]}]}]}]},"Count":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of records around the submitted address to search. Maximum is 100,000 (65,535 when buying an Excel file)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: RadiusByRecords"},"children":[]}]}]}]}]},"Address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address that will be the center of the search area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: RadiusByMiles, RadiusByRecords"},"children":[]}]}]}]}]},"State":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-character abbreviation for the desired state. Ex: “state=ca”."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: city, county"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: RadiusByMiles, RadiusByRecords, CitiesByState, CountiesByState"},"children":[]}]}]}]}]},"City":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be the name of an existing city within the selected state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: city"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: RadiusByMiles, RadiusByRecords"},"children":[]}]}]}]}]},"County":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be the name of an existing county within the selected state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: county"},"children":[]}]}]}]}]},"cityres":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes residential addresses not located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: cityres=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: cityres=0 or do not include."},"children":[]}]}]}]},"cityapt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes apartment addresses not located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: cityapt=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: cityapt=0 or do not include."},"children":[]}]}]}]},"citybiz":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes business and commercial addresses not located on rural routes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: citybiz=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: citybiz=0 or do not include."},"children":[]}]}]}]},"pores":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes PO Boxes rented by residential customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: pores=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: pores=0 or do not include."},"children":[]}]}]}]},"pobiz":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes PO Boxes rented by commercial customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: pobiz=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: pobiz=0 or do not include."},"children":[]}]}]}]},"ruralres":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes residential addresses located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: ruralres=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: ruralres=0 or do not include."},"children":[]}]}]}]},"ruralapt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes apartment addresses located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: ruralapt=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: ruralapt=0 or do not include."},"children":[]}]}]}]},"ruralbiz":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes business and commercial addresses located on rural routes, if any exist in the selected area."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: ruralbiz=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To exclude: ruralbiz=0 or do not include."},"children":[]}]}]}]},"multi":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy Requests Only. By default, purchased lists may be used once. With this parameter included in the Buy call, you can purchase the right to use a list for multiple mailings. Specify the number of uses like this: multi=4. The maximum number of uses allowed for any purchased list is 5."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: multi=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output Parameter: multi=(1 through 5)"},"children":[]}]}]}]},"file":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy Requests Only. Defines the desired file format of a purchased list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: file=(none)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output Parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: Zipped .txt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: Zipped .csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: Zipped .xls (Excel)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: .txt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Default) File Format: .csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - File Format: .xls (Excel)"},"children":[]}]}]}]}]},"po":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy Requests Only. Defines the customer's purchase order number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: N/A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To specify: po=xxxx"},"children":[]}]}]}]},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For count, a separate count of names will be given."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For purchase, extra columns will be added: pre name, first name, initial, last name, post name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to 1 to include personal names when they are available. Do not include or set to 0 to not include names."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: name=0"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To include: name=1"},"children":[]}]}]}]},"dbug":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter check. If a parameter in the url is spelled wrong or not suited for the given call, the request will be rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Value: dbug=0"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To check: dbug=1"},"children":[]}]}]}]}}}},"components/schemas/OccupantServiceResponse":{"id":"components/schemas/OccupantServiceResponse","kind":"json-schema","title":"OccupantServiceResponse","data":{"type":"object","properties":{"Occupant":{"type":"object","description":"Tag encapsulating the whole XML document","properties":{"Geography":{"type":"object","description":"Geo request","properties":{"Address":{"type":"string","description":"Returned if radius by records or miles is called."},"City":{"type":"string","description":"Returned if city, radius by records, or radius by miles is called."},"County":{"type":"string","description":"Returned if county is called."},"State":{"type":"string","description":"Returned if city, county, radius by records, or radius by miles is called."},"Zip":{"type":"string","description":"Returned if zip, radius by records, radius by miles is called. City and county calls are option only when zip is given by user."},"CarrierRoute":{"type":"string","description":"Returned if user requested for zip, city, radius by miles geo types."},"Records":{"type":"string","description":"Returned if radius by records is called."},"Miles":{"type":"string","description":"Returned if radius by miles is called."}}},"Options":{"type":"object","description":"Occupant options requested","properties":{"CityDeliveries_ResidentialAddresses":{"type":"string"},"CityDeliveries_Apartments":{"type":"string"},"CityDeliveries_BusinessAddresses":{"type":"string"},"POBoxes_ResidentialAddresses":{"type":"string"},"POBoxes_BusinessAddresses":{"type":"string"},"RuralRoutes_ResidentialAddresses":{"type":"string"},"RuralRoutes_Apartments":{"type":"string"},"RuralRoutes_BusinessAddresses":{"type":"string"},"IncludeNamesWhereAvailable":{"type":"string"}}},"CarrierRoutes":{"type":"array","description":"Breakdown by carrier routes - for ZIP, city, radius by miles types.","items":{"type":"object","properties":{"CarrierRoute":{"type":"object","description":"Detailed info of each carrier route","properties":{"Zip":{"type":"string","description":"5 digit ZIP"},"Route":{"type":"string","description":"4 digit carrier route"},"Count":{"type":"string","description":"Number of occupants within this carrier route"}}}}}},"ZipCodes":{"type":"object","description":"Breakdown by ZIP - for city, county types.","properties":{"Zip":{"type":"array","description":"Detailed info of each ZIP","items":{"type":"object","properties":{"ZipCode":{"type":"string","description":"5 digit ZIP"},"Count":{"type":"string","description":"Number of occupants within this ZIP"}}}}}},"Streets":{"type":"array","description":"Breakdown by street - for radius by miles, radius by records type.","items":{"type":"object","properties":{"Street":{"type":"object","properties":{"Street":{"type":"string","description":"Detailed info of each street. Format: street name, city, state ZIP\n"},"StartNumber":{"type":"string","description":"Start number of the street with the requested criteria"},"EndNumber":{"type":"string","description":"End number of the street with the requested criteria"},"Count":{"type":"string","description":"Number of occupants within this carrier route"}}}}}},"TotalCount":{"type":"object","properties":{"Count":{"type":"string","description":"Total number of records returned."},"NameCount":{"type":"string","description":"Total number of records with name returned"}}},"Result":{"type":"object","properties":{"StatusCode":{"type":"string","description":"Indicates the status of a request. Returns Declined, Approved, or Err."}}}}}}}},"components/schemas/FileStatusRequest":{"id":"components/schemas/FileStatusRequest","kind":"json-schema","title":"FileStatusRequest","data":{"type":"object","additionalProperties":false,"properties":{"Url":{"type":"string","description":"Download link provided from the buy request."},"OrderId":{"type":"string","description":"OrderId provided by the buy request."}}}},"components/schemas/FileStatusResponse":{"id":"components/schemas/FileStatusResponse","kind":"json-schema","title":"FileStatusResponse","data":{"type":"object","properties":{"url":{"type":"string"},"fileStatus":{"type":"string"},"orderTime":{"type":"string"},"finishTime":{"type":"string"}}}},"schema_281":{"kind":"json-schema","data":{"type":"string","enum":["get","buy"]},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"string","enum":["json","xml"]},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"type":"string","enum":["zip","city","county","RadiusByMiles","RadiusByRecords","state","CountiesByState","CitiesByState","ZipsByCity","CrtsByZip"]},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"type":"string"},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"type":"string","enum":["application/xml","*/*"]},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"type":"string","enum":["application/xml","application/json"]},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred."},"title":{"type":"string","description":"A short summary of the error."},"status":{"type":"string","description":"The HTTP status code for the error."},"errors":{"type":"object","properties":{"$.<PropertyName>":{"type":"array","description":"A detailed message about the error.","items":{"type":"string"}}}},"traceId":{"type":"string","description":"A unique identifier for the request, useful for debugging."}}},"id":"schema_287"}},"exampleStore":{"paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1json/examples/default":{"value":{"Occupant":{"Geography":{"Zip":"92688","CarrierRoute":"b007-92688"},"Options":{"CityDeliveries_ResidentialAddresses":"True","CityDeliveries_Apartments":"True","CityDeliveries_BusinessAddresses":"True","POBoxes_ResidentialAddresses":"True","POBoxes_BusinessAddresses":"True","RuralRoutes_ResidentialAddresses":"True","RuralRoutes_Apartments":"True","RuralRoutes_BusinessAddresses":"True","IncludeNamesWhereAvailable":"False"},"CarrierRoutes":{"CarrierRoute":{"Zip":"92688","Route":"B007","Count":"55"}},"Streets":"","TotalCount":{"Count":"55"},"Result":{"StatusCode":"Approved"}}},"key":"default","summary":"Example Response","id":"paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1json/examples/default"},"paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1xml/example":{"value":"<Occupant>\n  <Geography>\n    <Zip>92688</Zip>\n    <CarrierRoute>b007-92688</CarrierRoute>\n  </Geography>\n  <Options>\n    <CityDeliveries_ResidentialAddresses>True</CityDeliveries_ResidentialAddresses>\n    <CityDeliveries_Apartments>True</CityDeliveries_Apartments>\n    <CityDeliveries_BusinessAddresses>True</CityDeliveries_BusinessAddresses>\n    <POBoxes_ResidentialAddresses>True</POBoxes_ResidentialAddresses>\n    <POBoxes_BusinessAddresses>True</POBoxes_BusinessAddresses>\n    <RuralRoutes_ResidentialAddresses>True</RuralRoutes_ResidentialAddresses>\n    <RuralRoutes_Apartments>True</RuralRoutes_Apartments>\n    <RuralRoutes_BusinessAddresses>True</RuralRoutes_BusinessAddresses>\n    <IncludeNamesWhereAvailable>False</IncludeNamesWhereAvailable>\n  </Options>\n  <CarrierRoutes>\n    <CarrierRoute>\n      <Zip>92688</Zip>\n      <Route>B007</Route>\n      <Count>55</Count>\n    </CarrierRoute>\n  </CarrierRoutes>\n  <Streets></Streets>\n  <TotalCount>\n    <Count>55</Count>\n  </TotalCount>\n  <Result>\n    <StatusCode>Approved</StatusCode>\n  </Result>\n</Occupant>\n","id":"paths/~1{action}~1{format}~1{geographicType}/get/responses/200/content/application~1xml/example"},"paths/~1getFileStatus/post/requestBody/content/application~1json/example":{"value":{"Url":"Url"},"id":"paths/~1getFileStatus/post/requestBody/content/application~1json/example"},"paths/~1getFileStatus/post/responses/200/content/application~1json/example":{"value":{"url":"https://list.melissadata.com/ListOrderFiles/1234567.csv","fileStatus":"Ready","orderTime":"04/27/2026 09:18:00 PST","finishTime":"04/27/2026 09:18:13 PST"},"id":"paths/~1getFileStatus/post/responses/200/content/application~1json/example"}},"securitySchemeStore":{},"servers":[{"url":"http://list.melissadata.net/V1/occupant/rest/Service.svc","description":"Occupant Service Server"}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"hideSchemaTitles":true,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl"},{"lang":"C#"},{"lang":"Python"},{"lang":"Java"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"},{"lang":"C#+Newtonsoft"},{"lang":"Java8+Apache"},{"lang":"Payload"}]},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/leadgen-occupant.json?download"},{"url":"/_bundle/apis/leadgen-occupant.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"LeadGen - Occupant","description":"## LeadGen - Occupant Overview ##\nWelcome to the LeadGen Occupant by Melissa. The Occupant Cloud API is a REST based Cloud API that can be used to select, get counts, and purchase targeted consumer mailing lists, in realtime, anytime. The LeadGen services are available to mailers for private, in-house use, or as a portal for your customers to use to make their list selections. You can custom-design a website to meet your own needs, as well as those of your customers.\n\nTake advantage of your buying power with Melissa, and pass the discounted prices, along with an impressive selection of mailing lists and sales leads, onto your customers. They'll appreciate the convenience, the price, and your service. Please note that the Occupant Cloud API requires a License Key that has been activated for the Occupant Cloud API.\n\n**Documentation**\n- [LeadGen Occupant Documentation](https://docs.melissa.com/reference-data/leadgen-occupant/leadgen-occupant-reference-guide.html)\n\n**Useful Resources**\n- [GitHub - LeadGen Occupant Open API Specification](https://github.com/MelissaData/MelissaCloudAPI-OpenAPI-Specification/blob/main/openapi/apis/leadgen-occupant.yaml)\n- [Release notes](https://releasenotes.melissa.com/reference-data/leadgen-occupant/)\n- [Status codes](https://docs.melissa.com/other/status-codes-index.html)\n\n**Product Page**\n\n[https://www.melissa.com/direct/mailing-lists-sales-leads/leadgen-api](https://www.melissa.com/direct/mailing-lists-sales-leads/leadgen-api)\n\n**Support Center**\n\n[https://www.melissa.com/company/product-support](https://www.melissa.com/company/product-support)\n"}},"baseSlug":"/apis/leadgen-occupant","routesMapping":{}}