s1 API Host

<back to all web services

BmfOrderRequest

The following routes are available for this service:
GET,OPTIONS/api/bmf/order/{orderId}Allows you to get an order created with the bmf 'velgenconfigurator'.User has to be authenticated.
Parameters:
NameParameterData TypeRequiredDescription
orderIdpathstringYesThe id of the order

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/BmfOrderRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<BmfOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Bmf">
  <OrderId>String</OrderId>
</BmfOrderRequest>

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

<BmfOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Bmf">
  <Order>
    <BmfOrderItems i:nil="true" />
    <Id>String</Id>
    <LastModified>0001-01-01T00:00:00</LastModified>
    <UserId>String</UserId>
  </Order>
  <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>
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</BmfOrderResponse>