Console Connect logo

Geographic Address Management

Creates a GeographicAddressValidation

This operation creates a GeographicAddressValidation entity.

Securityx-sonata-buyer-key-and-api-key
Request
query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 79 (Sn 8.8)

Request Body schema: application/json;charset=utf-8
required

The GeographicAddressValidation to be created

provideAlternative
required
boolean

Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result. MEF: The attribute is kept for TMF API compliance. MEF requires this attribute always to be set to 'true'. Alternatives should be provided regardless of whether best match was found. The Seller is allowed not to implement the support for 'false'

required
object (GeographicAddress)

Structured textual way of describing how to find a property in an urban area (country properties are often defined differently). Note: Address corresponds to SID UrbanPropertyAddress

Responses
200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems

500

Internal Server Error

post/mefApi/sonata/geographicAddressManagement/v7/geographicAddressValidation
Request samples
application/json;charset=utf-8
{
  • "provideAlternative": true,
  • "submittedGeographicAddress": {
    }
}
Response samples
application/json;charset=utf-8

Notes:

address id will be used in quote

address keyName will be used in order

{
  • "validationResult": "partial",
  • "alternateGeographicAddress": [
    ],
  • "provideAlternative": true,
  • "submittedGeographicAddress": {
    }
}

Retrieves a GeographicAddress by ID

This operation retrieves a GeographicAddress entity.

Securityx-sonata-buyer-key-and-api-key
Request
path Parameters
id
required
string

Identifier of the GeographicAddress

query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 79 (Sn 8.8)

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/mefApi/sonata/geographicAddressManagement/v7/geographicAddress/{id}
Response samples
application/json;charset=utf-8
{
  • "id": "5a25e13b0c23371f1cd5f7ff",
  • "@type": "FieldedAddress",
  • "associatedGeographicAddress": {
    }
}
➔ Next to Quote Management