Mercedes.Agency.Orchestration.API

<back to all web services

ProcessBulkStatusAllocationRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/PerformBulkStatusAllocationsBulk allocates assistance statuses to back ordersTakes a list of previously validated back orders and assistance statuses and along with custom user messages, calls Agency API and updates the back orders with the provided statuses while adding audit records in the process.
ProcessBulkStatusAllocationRequest Parameters:
NameParameterData TypeRequiredDescription
AllocationsbodyList<BackOrderStatusAllocation>Yes
FilenamebodystringYes
BackOrderStatusAllocation Parameters:
NameParameterData TypeRequiredDescription
RowformintNo
BackOrderReferenceformstringNo
StatusformstringNo
MessageformstringNo

To override the Content-type in your clients, use the 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 /v1/BackOrder/PerformBulkStatusAllocations HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProcessBulkStatusAllocationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders">
  <Allocations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation">
    <d2p1:BackOrderStatusAllocation>
      <d2p1:BackOrderReference>String</d2p1:BackOrderReference>
      <d2p1:Message>String</d2p1:Message>
      <d2p1:Row>0</d2p1:Row>
      <d2p1:Status>String</d2p1:Status>
    </d2p1:BackOrderStatusAllocation>
  </Allocations>
  <Filename>String</Filename>
</ProcessBulkStatusAllocationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProcessBulkStatusAllocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation" />