Cím ellenőrzése
A következővonatkozik: Partnerközpont | A 21Vianet által üzemeltetett Partnerközpont | Partnerközpont a Microsoft Cloud for US Government számára
Ez a cikk bemutatja, hogyan érvényesíthet címeket a címérvényesítési API használatával.
A címérvényesítési API csak az ügyfélprofil-frissítések előértékeléséhez használható. Az API válaszállapota alapján a hívónak ki kell választania az ügyfél számára legmegfelelőbb címet.
Előfeltételek
Hitelesítő adatok az Partnerközpont azonosítás szerint. Ez a forgatókönyv támogatja az önálló alkalmazással és az App+Felhasználói hitelesítő adatokkal való hitelesítést is.
C#
Egy cím érvényesítéséhez először példányosítjon egy új Cím objektumot, és töltse ki az érvényesítendő címmel. Ezután kérjen le egy interfészt az Ellenőrzések műveleteihez az IAggregatePartner.Validations tulajdonságból, és hívja meg az IsAddressValid metódust a címobjektummal.
IAggregatePartner partnerOperations;
// Create an address to validate.
Address address = new Address()
{
AddressLine1 = "One Microsoft Way",
City = "Redmond",
State = "WA",
PostalCode = "98052",
Country = "US"
};
// Validate the address.
AddressValidationResponse result = partnerOperations.Validations.IsAddressValid(address);
// If the request completes successfully, you can inspect the response object.
// See the status of the validation.
Console.WriteLine($"Status: {addressValidationResult.Status}");
// See the validation message returned.
Console.WriteLine($"Validation Message Returned: {addressValidationResult.ValidationMessage ?? "No message returned."}");
// See the original address submitted for validation.
Console.WriteLine($"Original Address:\n{this.DisplayAddress(addressValidationResult.OriginalAddress)}");
// See the suggested addresses returned by the API, if any exist.
Console.WriteLine($"Suggested Addresses Returned: {addressValidationResult.SuggestedAddresses?.Count ?? "None."}");
if (addressValidationResult.SuggestedAddresses != null && addressValidationResult.SuggestedAddresses.Any())
{
addressValidationResult.SuggestedAddresses.ForEach(a => Console.WriteLine(this.DisplayAddress(a)));
}
// Helper method to pretty-print an Address object.
private string DisplayAddress(Address address)
{
StringBuilder sb = new StringBuilder();
foreach (var property in address.GetType().GetProperties())
{
sb.AppendLine($"{property.Name}: {property.GetValue(address) ?? "None to Display."}");
}
return sb.ToString();
}
REST-kérés
Kérés szintaxisa
Módszer | URI kérése |
---|---|
BEJEGYZÉS | {baseURL}/v1/validations/address HTTP/1.1 |
Kérelemfejlécek
További információért lásd: Partnerközpont REST-fejlécei.
Kérelem törzse
Ez a táblázat a kérelem törzsében található szükséges tulajdonságokat ismerteti.
Név | Típus | Szükséges* | Leírás |
---|---|---|---|
címsor1 | karakterlánc | Y | A cím első sora. |
címvonal2 | húr | N | Az cím második sora. Ez a tulajdonság nem kötelező. |
város | húr | Y | A város. |
állam | húr | Y | Az állam. |
irányítószám | karakterlánc | Y | Az irányítószám. |
ország | zsinór | Y | A két karakterből álló ISO alpha-2 országkód. |
* A szükséges tulajdonságok ország vagy régió alapján változhatnak.
Válasz részletei
A válasz az alábbi állapotüzenetek egyikét adja vissza. Ha az állapotválasz nem Ellenőrzött vagy EllenőrzöttKüldhető, tekintse át a megadott címet és/vagy javasolt címet. A hívónak kell kiválasztania az ügyfél számára legmegfelelőbb címet.
Állapot | Leírás | A visszaadott javasolt címek száma | Állapotválaszra vonatkozó javaslat |
---|---|---|---|
Ellenőrzött szállításra kész | A cím ellenőrizve van, és oda is szállítható. | Egyedülálló | Folytassa az ellenőrzött címmel. |
Ellenőrzött | A cím ellenőrzése megtörtént. | Egyedülálló | Folytassa az ellenőrzött címmel. |
Interakció szükséges | A javasolt cím jelentősen módosult, és felhasználói megerősítést igényel. | Egyedülálló | Folytassa a felhasználó által visszaigazolt címmel. |
Utcarészlet | A megadott címben lévő utca adatai hiányosak, és további információ szükséges. | Többszörös – legfeljebb három | Folytassa a felhasználó által visszaigazolt címmel. |
Helyiségek részleges állapota | A megadott helyiségek (épületszám, lakosztályszám és egyéb) részlegesek, és további információra van szükségük. | Többszörös – legfeljebb három | Folytassa a felhasználó által visszaigazolt címmel. |
Többszörös | A címben több mező is részleges (beleértve az utcarészleteket és a helyiség részleteket is). | Többszörös – legfeljebb három | Folytassa a felhasználó által visszaigazolt címmel. |
Egyik sem | A cím helytelen. | Egyik sem | Folytassa a felhasználó által visszaigazolt címmel. |
Nincs érvényesítve | A cím nem küldhető el az érvényesítési folyamaton keresztül. | Egyik sem | Folytassa a felhasználó által visszaigazolt címmel. |
Példa kérése
# "VerifiedShippable" Request Example
POST https://api.partnercenter.microsoft.com/v1/validations/address HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: eb55c2b8-6f4b-4b44-9557-f76df624b8c0
Host: api.partnercenter.microsoft.com
Content-Length: 137
X-Locale: en-US
{
"AddressLine1": "1 Microsoft Way",
"City": "Redmond",
"State": "WA",
"PostalCode": "98052",
"Country": "US"
}
# "StreetPartial" Request Example
POST https://api.partnercenter.microsoft.com/v1/validations/address HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <token>
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: ee6cf74c-3ab5-48d6-9269-4a4b75bd59dc
Host: api.partnercenter.microsoft.com
Content-Length: 135
X-Locale: en-US
{
"AddressLine1": "Microsoft Way",
"City": "Redmond",
"State": "WA",
"PostalCode": "98052",
"Country": "US"
}
REST-válasz
Ha sikeres, a metódus egy AddressValidationResponse objektumot ad vissza a válasz törzsében egy HTTP 200 állapotkóddal. Egy példa a következő.
Válasz sikeresség és hibakódok
Minden válaszhoz tartozik egy HTTP-állapotkód, amely jelzi a sikert vagy a hibát és a hibakeresési információkat. A kód, hibatípus és egyéb paraméterek olvasásához használjon hálózati nyomkövetési eszközt. A teljes listát lásd: Partnerközpont REST-hibakódjai.
Példa válaszra
# "VerifiedShippable" Response Example
HTTP/1.1 200 OK
Date: Mon, 17 May 2021 23:19:19 GMT
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: eb55c2b8-6f4b-4b44-9557-f76df624b8c0
X-Locale: en-US
{
"originalAddress": {
"country": "US",
"city": "Redmond",
"state": "WA",
"addressLine1": "1 Microsoft Way",
"postalCode": "98052"
},
"suggestedAddresses": [
{
"country": "US",
"city": "Redmond",
"state": "WA",
"addressLine1": "1 Microsoft Way",
"postalCode": "98052-8300"
}
],
"status": "VerifiedShippable"
}
# "StreetPartial" Response Example
HTTP/1.1 200 OK
Date: Mon, 17 May 2021 23:34:08 GMT
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: ee6cf74c-3ab5-48d6-9269-4a4b75bd59dc
X-Locale: en-US
{
"originalAddress": {
"country": "US",
"city": "Redmond",
"state": "WA",
"addressLine1": "Microsoft Way",
"postalCode": "98052"
},
"suggestedAddresses": [
{
"country": "US",
"city": "Redmond",
"state": "WA",
"addressLine1": "1 Microsoft Way",
"postalCode": "98052-6399"
}
],
"status": "StreetPartial",
"validationMessage": "Address field invalid for property: 'Region', 'PostalCode', 'City'"
}