POST api/Addresses?customerId={customerId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

string

Required

Body Parameters

Address
NameDescriptionTypeAdditional information
Id

string

None.

Salutation

string

None.

Name1

string

None.

Name2

string

None.

Name3

string

None.

City

string

None.

Street

string

None.

HouseNumber

string

None.

HouseNumberAddition

string

None.

Email

string

None.

Zip

string

None.

Gender

string

None.

Phone

string

None.

Phone2

string

None.

Country

string

None.

Title

string

None.

AddressType

AddressType

None.

DateOfBirth

date

None.

ValidFrom

date

None.

ValidUntil

date

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Salutation": "sample string 2",
  "Name1": "sample string 3",
  "Name2": "sample string 4",
  "Name3": "sample string 5",
  "City": "sample string 6",
  "Street": "sample string 7",
  "HouseNumber": "sample string 8",
  "HouseNumberAddition": "sample string 9",
  "Email": "sample string 10",
  "Zip": "sample string 11",
  "Gender": "sample string 12",
  "Phone": "sample string 13",
  "Phone2": "sample string 14",
  "Country": "sample string 15",
  "Title": "sample string 16",
  "AddressType": {
    "Name": "sample string 1",
    "Id": 2.0
  },
  "DateOfBirth": "2025-07-01T23:52:37.5056745+02:00",
  "ValidFrom": "2025-07-01T23:52:37.5056745+02:00",
  "ValidUntil": "2025-07-01T23:52:37.5056745+02:00"
}

application/xml, text/xml

Sample:
<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sts.Vas.ProcessesDebitor.Models">
  <AddressType>
    <Id>2</Id>
    <Name>sample string 1</Name>
  </AddressType>
  <City>sample string 6</City>
  <Country>sample string 15</Country>
  <DateOfBirth>2025-07-01T23:52:37.5056745+02:00</DateOfBirth>
  <Email>sample string 10</Email>
  <Gender>sample string 12</Gender>
  <HouseNumber>sample string 8</HouseNumber>
  <HouseNumberAddition>sample string 9</HouseNumberAddition>
  <Id>sample string 1</Id>
  <Name1>sample string 3</Name1>
  <Name2>sample string 4</Name2>
  <Name3>sample string 5</Name3>
  <Phone>sample string 13</Phone>
  <Phone2>sample string 14</Phone2>
  <Salutation>sample string 2</Salutation>
  <Street>sample string 7</Street>
  <Title>sample string 16</Title>
  <ValidFrom>2025-07-01T23:52:37.5056745+02:00</ValidFrom>
  <ValidUntil>2025-07-01T23:52:37.5056745+02:00</ValidUntil>
  <Zip>sample string 11</Zip>
</Address>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Address'.

Response Information

Resource Description

ResponseDataOfAddress
NameDescriptionTypeAdditional information
Token

string

None.

Data

Address

None.

Response Formats

application/json, text/json

Sample:
{
  "Token": "sample string 1",
  "Data": {
    "Id": "sample string 1",
    "Salutation": "sample string 2",
    "Name1": "sample string 3",
    "Name2": "sample string 4",
    "Name3": "sample string 5",
    "City": "sample string 6",
    "Street": "sample string 7",
    "HouseNumber": "sample string 8",
    "HouseNumberAddition": "sample string 9",
    "Email": "sample string 10",
    "Zip": "sample string 11",
    "Gender": "sample string 12",
    "Phone": "sample string 13",
    "Phone2": "sample string 14",
    "Country": "sample string 15",
    "Title": "sample string 16",
    "AddressType": {
      "Name": "sample string 1",
      "Id": 2.0
    },
    "DateOfBirth": "2025-07-01T23:52:37.5056745+02:00",
    "ValidFrom": "2025-07-01T23:52:37.5056745+02:00",
    "ValidUntil": "2025-07-01T23:52:37.5056745+02:00"
  }
}

application/xml, text/xml

Sample:
<ResponseDataOfAddressNdVm6wV7 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sts.Vas.Stp.Api.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sts.Vas.ProcessesDebitor.Models">
    <d2p1:AddressType>
      <d2p1:Id>2</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:AddressType>
    <d2p1:City>sample string 6</d2p1:City>
    <d2p1:Country>sample string 15</d2p1:Country>
    <d2p1:DateOfBirth>2025-07-01T23:52:37.5056745+02:00</d2p1:DateOfBirth>
    <d2p1:Email>sample string 10</d2p1:Email>
    <d2p1:Gender>sample string 12</d2p1:Gender>
    <d2p1:HouseNumber>sample string 8</d2p1:HouseNumber>
    <d2p1:HouseNumberAddition>sample string 9</d2p1:HouseNumberAddition>
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:Name1>sample string 3</d2p1:Name1>
    <d2p1:Name2>sample string 4</d2p1:Name2>
    <d2p1:Name3>sample string 5</d2p1:Name3>
    <d2p1:Phone>sample string 13</d2p1:Phone>
    <d2p1:Phone2>sample string 14</d2p1:Phone2>
    <d2p1:Salutation>sample string 2</d2p1:Salutation>
    <d2p1:Street>sample string 7</d2p1:Street>
    <d2p1:Title>sample string 16</d2p1:Title>
    <d2p1:ValidFrom>2025-07-01T23:52:37.5056745+02:00</d2p1:ValidFrom>
    <d2p1:ValidUntil>2025-07-01T23:52:37.5056745+02:00</d2p1:ValidUntil>
    <d2p1:Zip>sample string 11</d2p1:Zip>
  </Data>
  <Token>sample string 1</Token>
</ResponseDataOfAddressNdVm6wV7>