POST api/v1/Case

Maak een dossier aan

Request Information

URI Parameters

None.

Body Parameters

Case

Name	Description	Type	Additional information
Debtors		Collection of Debtor	None.
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:

{
  "Debtors": [
    {
      "Addresses": [
        {
          "City": "sample string 1",
          "Country": "sample string 2",
          "HouseNumber": 3,
          "HouseNumberAddition": "sample string 4",
          "PostalCode": "sample string 5",
          "Street": "sample string 6",
          "Type": "Residence"
        },
        {
          "City": "sample string 1",
          "Country": "sample string 2",
          "HouseNumber": 3,
          "HouseNumberAddition": "sample string 4",
          "PostalCode": "sample string 5",
          "Street": "sample string 6",
          "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"
    },
    {
      "Addresses": [
        {
          "City": "sample string 1",
          "Country": "sample string 2",
          "HouseNumber": 3,
          "HouseNumberAddition": "sample string 4",
          "PostalCode": "sample string 5",
          "Street": "sample string 6",
          "Type": "Residence"
        },
        {
          "City": "sample string 1",
          "Country": "sample string 2",
          "HouseNumber": 3,
          "HouseNumberAddition": "sample string 4",
          "PostalCode": "sample string 5",
          "Street": "sample string 6",
          "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"
    }
  ],
  "CustomerReference": "sample string 1",
  "FlanderijnCustomerNumber": 2,
  "FlanderijnCustomerPortfolio": 3
}

application/xml, text/xml

Sample:

<Case 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>
  <Debtors>
    <Debtor>
      <Addresses>
        <Address>
          <City>sample string 1</City>
          <Country>sample string 2</Country>
          <HouseNumber>3</HouseNumber>
          <HouseNumberAddition>sample string 4</HouseNumberAddition>
          <PostalCode>sample string 5</PostalCode>
          <Street>sample string 6</Street>
          <Type>Residence</Type>
        </Address>
        <Address>
          <City>sample string 1</City>
          <Country>sample string 2</Country>
          <HouseNumber>3</HouseNumber>
          <HouseNumberAddition>sample string 4</HouseNumberAddition>
          <PostalCode>sample string 5</PostalCode>
          <Street>sample string 6</Street>
          <Type>Residence</Type>
        </Address>
      </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>
    <Debtor>
      <Addresses>
        <Address>
          <City>sample string 1</City>
          <Country>sample string 2</Country>
          <HouseNumber>3</HouseNumber>
          <HouseNumberAddition>sample string 4</HouseNumberAddition>
          <PostalCode>sample string 5</PostalCode>
          <Street>sample string 6</Street>
          <Type>Residence</Type>
        </Address>
        <Address>
          <City>sample string 1</City>
          <Country>sample string 2</Country>
          <HouseNumber>3</HouseNumber>
          <HouseNumberAddition>sample string 4</HouseNumberAddition>
          <PostalCode>sample string 5</PostalCode>
          <Street>sample string 6</Street>
          <Type>Residence</Type>
        </Address>
      </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>
  </Debtors>
</Case>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Het dossiernummer

ApiResponse

Name	Description	Type	Additional information
Message		string	None.
Status		ResponseStatusCode	Required

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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