Data Provisioning Service Job Instruction



DpsJobInstruction [Schema]

Name Type Required Description
HoldingDate xsd:dateTime no Optional date, used to defer execution of the job until a future point in time.
Retrieve xsd:boolean yes Flag to indicate that the job should retrieve messages.
Apply xsd:boolean yes Flag to indicate that the job should apply the messages processing.
FromDate xsd:date no Optional from date from which messages should be retrieved. If no date is specified then all messages will be retrieved.
Employer Link yes A link to the associated Employer resource.
MessageTypes DpsMessageType
(list of)		 no Optional list of message types to be processed.
MessagesToProcess Link
(list of)		 no An explicit list of messages. Can be used to apply processing to only a subset of retrieved messages.

Example

<?xml version="1.0"?>
<DpsJobInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <HoldingDate>2022-01-12T00:00:00+00:00</HoldingDate>
  <Retrieve>true</Retrieve>
  <Apply>true</Apply>
  <FromDate>2022-01-12</FromDate>
  <Employer title="string" href="string" rel="string" />
  <MessageTypes>
    <Type>P6</Type>
  </MessageTypes>
  <MessagesToProcess>
    <Message title="string" href="string" rel="string" />
  </MessagesToProcess>
</DpsJobInstruction>

{
  "DpsJobInstruction": {
    "HoldingDate": "2022-01-12T00:00:00+00:00",
    "Retrieve": "true",
    "Apply": "true",
    "FromDate": "2022-01-12",
    "Employer": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    },
    "MessageTypes": {
      "Type": [
        "P6"
      ]
    },
    "MessagesToProcess": {
      "Message": [
        {
          "@title": "string",
          "@href": "string",
          "@rel": "string"
        }
      ]
    }
  }
}