GET api/MifData/{id}

Gets a MifData requests identified by the unique id returned when the request was originally successfully Posted

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

NameDescriptionTypeAdditional information
id

Returns the one MifData request with a MifData of Id. Do not use /id={id} but rather just /{id}, as in api/MifData/5 to get request 5.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The requested MifData request in the form of a MifDataView

MifDataView
NameDescriptionTypeAdditional information
MifDataId

The unique id assigned to this Mif transaction import request once it is validated and saved.

integer

None.
Description

The additional information to descript the Mif transaction import. E.g. the details for a weekly transaction import.

string

None.
EffectiveDate

The date the Mif transaction import takes effect. E.g. the date of period start.

date

None.
EndDate

The date the Mif transaction import end to. E.g. the date of period end.

date

None.
Data

The contents of the Mif transaction import.

string

Required
Reference

The field is used for identification the Mif transaction import. Optional.

string

None.
ChangeType

Indicates the type of request being made: Using Add to request creation of a new ChangeEmployee record.

string

Required
ChangeStatus

Indicates the status of the current request. Not required for HTTP POST. ReadOnly

string

None.
ErrorMessage

May contain errors identified when the request is processed by payroll. ReadOnly

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "mifDataId": 1,
  "description": "sample string 1",
  "effectiveDate": "2024-05-19T03:59:37.4245753+10:00",
  "endDate": "2024-05-19T03:59:37.4245753+10:00",
  "data": "sample string 4",
  "reference": "sample string 5",
  "changeType": "sample string 6",
  "changeStatus": "sample string 7",
  "errorMessage": "sample string 8"
}

application/xml, text/xml

Sample: 
<MifDataView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MifDataId>1</MifDataId>
  <Description>sample string 1</Description>
  <EffectiveDate>2024-05-19T03:59:37.4245753+10:00</EffectiveDate>
  <EndDate>2024-05-19T03:59:37.4245753+10:00</EndDate>
  <Data>sample string 4</Data>
  <Reference>sample string 5</Reference>
  <ChangeType>sample string 6</ChangeType>
  <ChangeStatus>sample string 7</ChangeStatus>
  <ErrorMessage>sample string 8</ErrorMessage>
</MifDataView>