Mercedes.Agency.Orchestration.API

<back to all web services

GetAddressRequest

Address
Requires Authentication
The following routes are available for this service:
GET/v1/address/{Postcode}Get Address by PostCode
GET/v1/address/{Postcode}/{HouseNameOrNumber}Get Address by PostCode and Premise
"use strict";
export class Address {
    /** @param {{Property?:string,Street?:string,Town?:string,County?:string,Locality?:string,Postcode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Property;
    /** @type {string} */
    Street;
    /** @type {string} */
    Town;
    /** @type {string} */
    County;
    /** @type {string} */
    Locality;
    /** @type {string} */
    Postcode;
}
export class GetAddressResponse {
    /** @param {{Addresses?:Address[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Address[]} */
    Addresses = [];
}
export class GetAddressRequest {
    /** @param {{Postcode?:string,HouseNameOrNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Postcode;
    /** @type {string} */
    HouseNameOrNumber;
}

JavaScript GetAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/address/{Postcode} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Addresses">
  <Addresses xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:Address>
      <d2p1:County>String</d2p1:County>
      <d2p1:Locality>String</d2p1:Locality>
      <d2p1:Postcode>String</d2p1:Postcode>
      <d2p1:Property>String</d2p1:Property>
      <d2p1:Street>String</d2p1:Street>
      <d2p1:Town>String</d2p1:Town>
    </d2p1:Address>
  </Addresses>
</GetAddressResponse>