POST CreditController/HandleCreditRequest?apiKey={apiKey}&encryptionKey={encryptionKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required

encryptionKey

string

Required

Body Parameters

CreditDTO
NameDescriptionTypeAdditional information
CustomerNumber

integer

None.

Handler

string

None.

Initials

string

None.

CreditInvoices

Collection of CreditInvoiceDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerNumber": 1,
  "Handler": "sample string 2",
  "Initials": "sample string 3",
  "CreditInvoices": [
    {
      "InvoiceNumber": 1,
      "CreditState": 0,
      "CreditLines": [
        {
          "InvoiceLineId": "34bc5d76-adc3-4962-a137-252d073b2674",
          "Amount": 2,
          "Type": 0
        },
        {
          "InvoiceLineId": "34bc5d76-adc3-4962-a137-252d073b2674",
          "Amount": 2,
          "Type": 0
        }
      ]
    },
    {
      "InvoiceNumber": 1,
      "CreditState": 0,
      "CreditLines": [
        {
          "InvoiceLineId": "34bc5d76-adc3-4962-a137-252d073b2674",
          "Amount": 2,
          "Type": 0
        },
        {
          "InvoiceLineId": "34bc5d76-adc3-4962-a137-252d073b2674",
          "Amount": 2,
          "Type": 0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<CreditDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataTransferObjects.Credit">
  <CreditInvoices>
    <CreditInvoiceDTO>
      <CreditLines>
        <CreditLineDTO>
          <Amount>2</Amount>
          <InvoiceLineId>34bc5d76-adc3-4962-a137-252d073b2674</InvoiceLineId>
          <Type>None</Type>
        </CreditLineDTO>
        <CreditLineDTO>
          <Amount>2</Amount>
          <InvoiceLineId>34bc5d76-adc3-4962-a137-252d073b2674</InvoiceLineId>
          <Type>None</Type>
        </CreditLineDTO>
      </CreditLines>
      <CreditState>None</CreditState>
      <InvoiceNumber>1</InvoiceNumber>
    </CreditInvoiceDTO>
    <CreditInvoiceDTO>
      <CreditLines>
        <CreditLineDTO>
          <Amount>2</Amount>
          <InvoiceLineId>34bc5d76-adc3-4962-a137-252d073b2674</InvoiceLineId>
          <Type>None</Type>
        </CreditLineDTO>
        <CreditLineDTO>
          <Amount>2</Amount>
          <InvoiceLineId>34bc5d76-adc3-4962-a137-252d073b2674</InvoiceLineId>
          <Type>None</Type>
        </CreditLineDTO>
      </CreditLines>
      <CreditState>None</CreditState>
      <InvoiceNumber>1</InvoiceNumber>
    </CreditInvoiceDTO>
  </CreditInvoices>
  <CustomerNumber>1</CustomerNumber>
  <Handler>sample string 2</Handler>
  <Initials>sample string 3</Initials>
</CreditDTO>

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 'CreditDTO'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.