PartnerHub

<back to all web services

MessageList

The following routes are available for this service:
All Verbs/MessageList/{RequestType}/{Status}/{DateFilter}
All Verbs/MessageList/{RequestType}/{Status}

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/MessageList HTTP/1.1 
Host: partnerhub.pbsdealers.com 
Content-Type: application/xml
Content-Length: length

<MessageList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBS.PartnerHub">
  <DateFilter>String</DateFilter>
  <Items>
    <MessageList.ListItem>
      <Messages>
        <MessageList.MessageItem>
          <FriendlyRequest>String</FriendlyRequest>
          <Message xmlns:d6p1="http://schemas.datacontract.org/2004/07/PBS.PartnerHub.ServiceModel">
            <d6p1:Attempts>0</d6p1:Attempts>
            <d6p1:Confirmation>String</d6p1:Confirmation>
            <d6p1:CreationDate>0001-01-01T00:00:00</d6p1:CreationDate>
            <d6p1:Endpoint>String</d6p1:Endpoint>
            <d6p1:Id>0</d6p1:Id>
            <d6p1:LastUpdate>0001-01-01T00:00:00</d6p1:LastUpdate>
            <d6p1:ReferenceId>String</d6p1:ReferenceId>
            <d6p1:RequestData>String</d6p1:RequestData>
            <d6p1:RequestType>String</d6p1:RequestType>
            <d6p1:Status>Pending</d6p1:Status>
          </Message>
        </MessageList.MessageItem>
      </Messages>
      <Name>String</Name>
      <SerialNumber>String</SerialNumber>
    </MessageList.ListItem>
  </Items>
  <RequestType>String</RequestType>
  <Status>String</Status>
</MessageList>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessageList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBS.PartnerHub">
  <DateFilter>String</DateFilter>
  <Items>
    <MessageList.ListItem>
      <Messages>
        <MessageList.MessageItem>
          <FriendlyRequest>String</FriendlyRequest>
          <Message xmlns:d6p1="http://schemas.datacontract.org/2004/07/PBS.PartnerHub.ServiceModel">
            <d6p1:Attempts>0</d6p1:Attempts>
            <d6p1:Confirmation>String</d6p1:Confirmation>
            <d6p1:CreationDate>0001-01-01T00:00:00</d6p1:CreationDate>
            <d6p1:Endpoint>String</d6p1:Endpoint>
            <d6p1:Id>0</d6p1:Id>
            <d6p1:LastUpdate>0001-01-01T00:00:00</d6p1:LastUpdate>
            <d6p1:ReferenceId>String</d6p1:ReferenceId>
            <d6p1:RequestData>String</d6p1:RequestData>
            <d6p1:RequestType>String</d6p1:RequestType>
            <d6p1:Status>Pending</d6p1:Status>
          </Message>
        </MessageList.MessageItem>
      </Messages>
      <Name>String</Name>
      <SerialNumber>String</SerialNumber>
    </MessageList.ListItem>
  </Items>
  <RequestType>String</RequestType>
  <Status>String</Status>
</MessageList>