POST api/v1/AllianderCase

Maak een dossier aan

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Debtor		AllianderDebtor	Required
Eans		Collection of AllianderEan	Required
CustomerReference	Opdrachtgeverreferentie: Dit is de referentie waaraan het dossier herkenbaar is voor de opdrachtgever. Dit is meestal het interne dossiernummer van de klant	string	Required Max length: 50
FlanderijnCustomerNumber	Flanderijnopdrachtgevernummer: Gezien vanuit Flanderijn en gezien vanuit een ‘generieke interface’ worden de aanleveringen van de klant herkend aan dit nummer	integer	Required
FlanderijnCustomerPortfolio	Flanderijnopdrachtgeverportefeuille: Indien een opdrachtgever namens verschillende werkmaatschappijen opdrachten aanlevert, kan hier onderscheid worden gemaakt	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "Debtor": {
    "Addresses": [
      {
        "IsLeveringsAdres": true,
        "City": "sample string 2",
        "Country": "sample string 3",
        "HouseNumber": 4,
        "HouseNumberAddition": "sample string 5",
        "PostalCode": "sample string 6",
        "Street": "sample string 7",
        "Type": "Residence"
      },
      {
        "IsLeveringsAdres": true,
        "City": "sample string 2",
        "Country": "sample string 3",
        "HouseNumber": 4,
        "HouseNumberAddition": "sample string 5",
        "PostalCode": "sample string 6",
        "Street": "sample string 7",
        "Type": "Residence"
      }
    ],
    "ChamberOfCommerceNumber": 1,
    "Email": "sample string 1",
    "Firstname": "sample string 2",
    "Infix": "sample string 3",
    "Initials": "sample string 4",
    "Language": "sample string 5",
    "MobileNumber": "sample string 6",
    "Name": "sample string 7",
    "PhoneNumber": "sample string 8",
    "Ssn": "sample string 9",
    "Type": "Person"
  },
  "Eans": [
    {
      "BezoekDatum": "2024-09-19T20:53:49.8302139+02:00",
      "BriefAchtergelaten": true,
      "DatumLeegstand": "2024-09-19T20:53:49.8302139+02:00",
      "Ean": "sample string 4",
      "EersteBrief": "2024-09-19T20:53:49.8302139+02:00",
      "EindeLeveringKlant": "2024-09-19T20:53:49.8302139+02:00",
      "Meter": "sample string 7",
      "TweedeBrief": "2024-09-19T20:53:49.8302139+02:00",
      "Type": "E",
      "TypeOfBuilding": 9,
      "TypeOfConnectionCode": "sample string 10",
      "TypeOfConnectionDescription": "sample string 11",
      "TypeOfCurrent": "sample string 12"
    },
    {
      "BezoekDatum": "2024-09-19T20:53:49.8302139+02:00",
      "BriefAchtergelaten": true,
      "DatumLeegstand": "2024-09-19T20:53:49.8302139+02:00",
      "Ean": "sample string 4",
      "EersteBrief": "2024-09-19T20:53:49.8302139+02:00",
      "EindeLeveringKlant": "2024-09-19T20:53:49.8302139+02:00",
      "Meter": "sample string 7",
      "TweedeBrief": "2024-09-19T20:53:49.8302139+02:00",
      "Type": "E",
      "TypeOfBuilding": 9,
      "TypeOfConnectionCode": "sample string 10",
      "TypeOfConnectionDescription": "sample string 11",
      "TypeOfCurrent": "sample string 12"
    }
  ],
  "CustomerReference": "sample string 1",
  "FlanderijnCustomerNumber": 2,
  "FlanderijnCustomerPortfolio": 3
}

application/xml, text/xml

Sample:

<AllianderCase xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerReference>sample string 1</CustomerReference>
  <FlanderijnCustomerNumber>2</FlanderijnCustomerNumber>
  <FlanderijnCustomerPortfolio>3</FlanderijnCustomerPortfolio>
  <Debtor>
    <Addresses>
      <AllianderAddress>
        <City>sample string 2</City>
        <Country>sample string 3</Country>
        <HouseNumber>4</HouseNumber>
        <HouseNumberAddition>sample string 5</HouseNumberAddition>
        <PostalCode>sample string 6</PostalCode>
        <Street>sample string 7</Street>
        <Type>Residence</Type>
        <IsLeveringsAdres>true</IsLeveringsAdres>
      </AllianderAddress>
      <AllianderAddress>
        <City>sample string 2</City>
        <Country>sample string 3</Country>
        <HouseNumber>4</HouseNumber>
        <HouseNumberAddition>sample string 5</HouseNumberAddition>
        <PostalCode>sample string 6</PostalCode>
        <Street>sample string 7</Street>
        <Type>Residence</Type>
        <IsLeveringsAdres>true</IsLeveringsAdres>
      </AllianderAddress>
    </Addresses>
    <ChamberOfCommerceNumber>1</ChamberOfCommerceNumber>
    <Email>sample string 1</Email>
    <Firstname>sample string 2</Firstname>
    <Infix>sample string 3</Infix>
    <Initials>sample string 4</Initials>
    <Language>sample string 5</Language>
    <MobileNumber>sample string 6</MobileNumber>
    <Name>sample string 7</Name>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Ssn>sample string 9</Ssn>
    <Type>Person</Type>
  </Debtor>
  <Eans>
    <AllianderEan>
      <BezoekDatum>2024-09-19T20:53:49.8302139+02:00</BezoekDatum>
      <BriefAchtergelaten>true</BriefAchtergelaten>
      <DatumLeegstand>2024-09-19T20:53:49.8302139+02:00</DatumLeegstand>
      <Ean>sample string 4</Ean>
      <EersteBrief>2024-09-19T20:53:49.8302139+02:00</EersteBrief>
      <EindeLeveringKlant>2024-09-19T20:53:49.8302139+02:00</EindeLeveringKlant>
      <Meter>sample string 7</Meter>
      <TweedeBrief>2024-09-19T20:53:49.8302139+02:00</TweedeBrief>
      <Type>E</Type>
      <TypeOfBuilding>9</TypeOfBuilding>
      <TypeOfConnectionCode>sample string 10</TypeOfConnectionCode>
      <TypeOfConnectionDescription>sample string 11</TypeOfConnectionDescription>
      <TypeOfCurrent>sample string 12</TypeOfCurrent>
    </AllianderEan>
    <AllianderEan>
      <BezoekDatum>2024-09-19T20:53:49.8302139+02:00</BezoekDatum>
      <BriefAchtergelaten>true</BriefAchtergelaten>
      <DatumLeegstand>2024-09-19T20:53:49.8302139+02:00</DatumLeegstand>
      <Ean>sample string 4</Ean>
      <EersteBrief>2024-09-19T20:53:49.8302139+02:00</EersteBrief>
      <EindeLeveringKlant>2024-09-19T20:53:49.8302139+02:00</EindeLeveringKlant>
      <Meter>sample string 7</Meter>
      <TweedeBrief>2024-09-19T20:53:49.8302139+02:00</TweedeBrief>
      <Type>E</Type>
      <TypeOfBuilding>9</TypeOfBuilding>
      <TypeOfConnectionCode>sample string 10</TypeOfConnectionCode>
      <TypeOfConnectionDescription>sample string 11</TypeOfConnectionDescription>
      <TypeOfCurrent>sample string 12</TypeOfCurrent>
    </AllianderEan>
  </Eans>
</AllianderCase>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Het dossiernummer

CaseCreatedResponse

Name	Type	Additional information
FlanderijnCaseNumber	integer	Required
Message	string	None.
Status	ResponseStatusCode	Required

Response Formats

application/json, text/json

Sample:

{
  "FlanderijnCaseNumber": 1,
  "Message": "sample string 2",
  "Status": "Success"
}

application/xml, text/xml

Sample:

<CaseCreatedResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Message>sample string 2</Message>
  <Status>Success</Status>
  <FlanderijnCaseNumber>1</FlanderijnCaseNumber>
</CaseCreatedResponse>