Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Sometimes, zipcode and postal code lists may be very large (>10,000 codes), causing issues in API performance.  You may pass in an alternate query string parameter in the GET calls, "&postcoderef=1" which will substitute the "condition_codes" array of zipcodes, with a key called "post_code_ref".

Usage


Without Query String Parameter:

GET /suppliers/v2/surveys/:survey_id
{
	"qualification_code":229,
	"condition_code":[
		"01234",
		"01235",
		"01236"
	]
}

With Query String Parameter:
GET /suppliers/v2/surveys/:survey_id?post_code_ref=1
{
	"qualification_code":229,
	"post_code_ref":[
		"a1bc0a0aa322ca"
	]
}

GET /suppliers/v2/postcodes/a1bc0a0aa322ca
{
	"01234",
	"01235",
	"01236"
}

Considerations

Postcodes and zipcodes are strings.  They will always use the qualification code "229".

It is possible that the key "post_code_ref" includes more than one value in its array.

You should check the mod_on date of a quota to determine if the targeting has changed.  If the mod_on date has changed, you should check that the value of the post_code_ref has not changed.

The values in the "post_code_ref" list will not change - in the event of a change in targeting, this value will change.


  • No labels