totole/services
1
0
Fork 0
mirror of https://github.com/kevin-DL/services.git synced 2026-01-12 03:05:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

ship updated postcode api

Browse Source
This commit is contained in:
Asim Aslam
2021-08-26 18:31:34 +01:00
parent 487585a61a
commit eec2110f88
4 changed files with 487 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
postcode/proto/postcode.proto
View File

@@ -6,19 +6,60 @@ option go_package = "./proto;postcode";
service Postcode {
rpc Lookup(LookupRequest) returns (LookupResponse) {}
rpc Random(RandomRequest) returns (RandomResponse) {}
rpc Validate(ValidateRequest) returns (ValidateResponse) {}
}
// Lookup a postcode to retrieve the related region, county, etc
message LookupRequest {
// UK postcode e.g SW1A 2AA
string postcode = 1;
}
message LookupResponse {
// UK postcode e.g SW1A 2AA
string postcode = 1;
// country e.g United Kingdom
string country = 2;
// related region e.g London
string region = 3;
// e.g Westminster
string district = 4;
// e.g St James's
string ward = 5;
// e.g 51.50354
double latitude = 6;
// e.g -0.127695
double longitude = 7;
}
// Validate a postcode. Should return valid: true or valid: false
message ValidateRequest {
// UK postcode e.g SW1A 2AA
string postcode = 1;
}
message ValidateResponse {
bool valid = 1;
}
// Return a random postcode and its related info
message RandomRequest {}
message RandomResponse {
// UK postcode e.g SW1A 2AA
string postcode = 1;
// country e.g United Kingdom
string country = 2;
// related region e.g London
string region = 3;
// e.g Westminster
string district = 4;
// e.g St James's
string ward = 5;
// e.g 51.50354
double latitude = 6;
// e.g -0.127695
double longitude = 7;
}