Cím ellenőrzése

A következőre 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 a Partnerközpont hitelesítésében leírtak 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ímobjektumot , és töltse ki az érvényesítendő címmel. Ezután kérje le az Érvényesítési műveletek felületét 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

Metódus	Kérés URI-ja
POST	{baseURL}/v1/validations/address HTTP/1.1

Kérésfejlécek

További információ: Partnerközpont – REST fejlécek.

Kérés 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	húr	I	A cím első sora.
címvonal2	húr	N	A cím második sora. Ez a tulajdonság opcionális.
Város	húr	I	A város.
állapot	húr	I	Az állam.
irányítószám	húr	I	Az irányítószám.
Ország	húr	I	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 VerifiedShippable, 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ítható	A cím ellenőrizve van, és oda is szállítható.	Egyszeres	Folytassa az ellenőrzött címmel.
Verified	A cím ellenőrzése megtörtént.	Egyszeres	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.	Egyszeres	Folytassa a felhasználó által visszaigazolt címmel.
Utca részleges	A cím adott utcája részleges, és további információra van szüksége.	Többszörös – legfeljebb három	Folytassa a felhasználó által visszaigazolt címmel.
Helyiségek részlegesen	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 utcai részeket és a részleges helyiségeket 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: 29624f3c-90cb-4d34-a7e9-bd2de6d35218
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: 2c95c9bc-fdfb-4c6a-84f4-57c9b0826b43
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, 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 a Partnerközpont REST-hibakódjaiban találja.

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: 29624f3c-90cb-4d34-a7e9-bd2de6d35218
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: 2c95c9bc-fdfb-4c6a-84f4-57c9b0826b43
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'"
}