DPS Message



Represents a data provisioning service message within the API.

DpsMessage [Schema]

Name Type Required Description
MessageType xsd:string (enumeration)
  • P6
  • P9
  • SL1
  • SL2
  • AR
  • NOT
  • RTI
  • PGL1
  • PGL2
yes The Message Type property. Indicates the DPS message type of this message instance.
FormType xsd:string no The Form Type property. Indicates the DPS message form type of this message instance.
Message xsd:string yes The Message property. Contains the raw message data for this message instance.
MessageStatus xsd:string (enumeration)
  • Retrieved
  • Applied
  • Unresolved
  • Ignored
  • Information
yes The Message Status property. Indicates the current status of the DPS message instance.
IssueDate xsd:date yes The Issue Date property. Indicates the date HMRC issued this DPS notice.
SequenceNumber xsd:integer yes The Sequence Number property. Indicates the DPS message sequence number.
RetrieveDate xsd:dateTime yes The Retrieve Date property. Indicates the date and time the DPS message was retrieved from the HMRC service.
LastUpdated xsd:dateTime yes The Last Updated property. Indicates the date and time the DPS message was last updated.
ProcessingResult xsd:string no The Processing Result property. Contains textual notes on the DPS message auto processing result.

Example

<?xml version="1.0"?>
<DpsMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MessageType>string</MessageType>
  <FormType>string</FormType>
  <Message>string</Message>
  <MessageStatus>Retrieved</MessageStatus>
  <IssueDate>2021-09-24</IssueDate>
  <SequenceNumber>123</SequenceNumber>
  <RetrieveDate>2021-09-24T00:00:00+00:00</RetrieveDate>
  <LastUpdated>2021-09-24T00:00:00+00:00</LastUpdated>
  <ProcessingResult>string</ProcessingResult>
</DpsMessage>
{
  "DpsMessage": {
    "MessageType": "string",
    "FormType": "string",
    "Message": "string",
    "MessageStatus": "Retrieved",
    "IssueDate": "2021-09-24",
    "SequenceNumber": "123",
    "RetrieveDate": "2021-09-24T00:00:00+00:00",
    "LastUpdated": "2021-09-24T00:00:00+00:00",
    "ProcessingResult": "string"
  }
}