s1 API Host

<back to all web services

BmfOrdersRequest

The following routes are available for this service:
GET,OPTIONS/api/bmf/ordersAllows you to get all orders created with the bmf 'velgenconfigurator'.User has to be authenticated and be an Administrator.
Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintYesThe amount that needs to be skipped
TakequeryintYesThe amount that needs to be taken
DebtorquerystringNoOnly show orders for this user
StartDatequeryDateTimeNoOnly show orders after this date
EndDatequeryDateTimeNoOnly show orders before this date

To override the Content-type in your clients 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.

POST /xml/reply/BmfOrdersRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<BmfOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Admin.Bmf">
  <Debtor>String</Debtor>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <Skip>0</Skip>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Take>0</Take>
</BmfOrdersRequest>

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

<BmfOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Admin.Bmf">
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Bmf" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <TotalResults>0</TotalResults>
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</BmfOrdersResponse>