address-segment-resource

getAllAddressSegments

get/api/address-segments

Query parameters

acceptorId.equalsinteger
acceptorId.greaterThaninteger
acceptorId.greaterThanOrEqualinteger
acceptorId.ininteger[]
acceptorId.lessThaninteger
acceptorId.lessThanOrEqualinteger
acceptorId.notEqualsinteger
acceptorId.notIninteger[]
acceptorId.specifiedboolean
id.equalsinteger
id.greaterThaninteger
id.greaterThanOrEqualinteger
id.ininteger[]
id.lessThaninteger
id.lessThanOrEqualinteger
id.notEqualsinteger
id.notIninteger[]
id.specifiedboolean
index.equalsinteger
index.greaterThaninteger
index.greaterThanOrEqualinteger
index.ininteger[]
index.lessThaninteger
index.lessThanOrEqualinteger
index.notEqualsinteger
index.notIninteger[]
index.specifiedboolean
pageinteger

Page number of the requested page

prefix.equals'THE_BEGINNING' | 'END_OF' | 'AFTER' | 'BEFORE' | 'NEXT' | 'IN_FRONT_OF_THE' | 'EAST' | 'WEST' | 'NORTH' | 'SOUTH' | 'NORTHEAST' | 'NORTHWEST' | 'SOUTHEAST' | 'SOUTHWEST'
prefix.instring[]
prefix.notEquals'THE_BEGINNING' | 'END_OF' | 'AFTER' | 'BEFORE' | 'NEXT' | 'IN_FRONT_OF_THE' | 'EAST' | 'WEST' | 'NORTH' | 'SOUTH' | 'NORTHEAST' | 'NORTHWEST' | 'SOUTHEAST' | 'SOUTHWEST'
prefix.notInstring[]
prefix.specifiedboolean
preflex.equals'HIGHWAY' | 'HIGHWAY2' | 'THE_NEIGHBOURHOOD' | 'ROAD' | 'THE_WAY_OUT' | 'RING_ROAD' | 'KILOMETER' | 'THE_PART' | 'VILLAGE' | 'PHASE' | 'MARKET' | 'SMALL_MARKET' | 'BOULEVARD' | 'INTERSECTION' | 'AVENUE' | 'THREE_WAYS' | 'TOWN' | 'SQUARE' | 'BRIDGE' | 'FOUR_WAYS' | 'ALLEY' | 'BLOCK' | 'TIMCHE' | 'STRAIGHT' | 'SARAY' | 'CROSSING' | 'DEADEND' | 'STREET' | 'TOWER' | 'CORRIDOR' | 'BUILDING' | 'COMPLEX' | 'ENTRANCE' | 'MALL' | 'ROW' | 'FLOOR' | 'PIEACE' | 'PLAQUE' | 'BOOTH' | 'THE_UNIT'
preflex.instring[]
preflex.notEquals'HIGHWAY' | 'HIGHWAY2' | 'THE_NEIGHBOURHOOD' | 'ROAD' | 'THE_WAY_OUT' | 'RING_ROAD' | 'KILOMETER' | 'THE_PART' | 'VILLAGE' | 'PHASE' | 'MARKET' | 'SMALL_MARKET' | 'BOULEVARD' | 'INTERSECTION' | 'AVENUE' | 'THREE_WAYS' | 'TOWN' | 'SQUARE' | 'BRIDGE' | 'FOUR_WAYS' | 'ALLEY' | 'BLOCK' | 'TIMCHE' | 'STRAIGHT' | 'SARAY' | 'CROSSING' | 'DEADEND' | 'STREET' | 'TOWER' | 'CORRIDOR' | 'BUILDING' | 'COMPLEX' | 'ENTRANCE' | 'MALL' | 'ROW' | 'FLOOR' | 'PIEACE' | 'PLAQUE' | 'BOOTH' | 'THE_UNIT'
preflex.notInstring[]
preflex.specifiedboolean
segment.containsstring
segment.doesNotContainstring
segment.equalsstring
segment.instring[]
segment.notEqualsstring
segment.notInstring[]
segment.specifiedboolean
sizeinteger

Size of a page

sortstring[]

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK

Changes

No recorded changes to this endpoint across all 1 revision of this API.