POST papi/v1/integration/feeds/submithr?batchUid={batchUid}&batchName={batchName}

Security

Secured API

Request Information

URI Parameters

Name	Description	Type	Additional information
batchUid		globally unique identifier	Required
batchName		string	Required

Required Headers

Name	Description	Sample	Type	Default
Authorization	Represents the value of the authentication token. Allow multiple values: no.	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ...	string	None
ConsumerId	Represents the value of the consumer id. Allow multiple values: no.	2426	integer	None

Optional Headers

Name	Description	Sample	Type	Default
ApplicationType	Represents the value of the consumer's application type. Allow multiple values: no.	1	ApplicationType	None
Accept-Language	Represents the value of the desired language for translations. Allow multiple values: yes.	es	string	en

Body Parameters

Collection of HRItem

Name	Type	Additional information
PersonInformation	Person	None.
EmployeeInformation	Employee	None.
IsUser	boolean	None.
UserInformation	User	None.
Id	string	None.
RecordUid	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "PersonInformation": {
      "Name": {
        "FirstName": "sample string 1",
        "MiddleName": "sample string 2",
        "LastName": "sample string 3",
        "PreferredName": "sample string 4",
        "Suffix": "sample string 5",
        "Salutation": "sample string 6"
      },
      "EmailAddress": "sample string 1",
      "Address": {
        "AddressLine1": "sample string 1",
        "AddressLine2": "sample string 2",
        "City": "sample string 3",
        "StateProvince": "sample string 4",
        "PostalCode": "sample string 5",
        "Country": "sample string 6",
        "County": "sample string 7",
        "Type": "sample string 8"
      },
      "DateOfBirth": "2025-07-04T11:59:37.622Z",
      "GenderType": "sample string 2",
      "MaritalStatusType": "sample string 3",
      "PrimaryLanguage": "sample string 4",
      "SecondaryLanguage": "sample string 5",
      "TaxpayerId": "sample string 6",
      "DependentCount": 7
    },
    "EmployeeInformation": {
      "DateHired": "2025-07-04T11:59:37.623Z",
      "TerminationDate": "2025-07-04T11:59:37.623Z",
      "Location": "sample string 1",
      "Occupation": "sample string 2",
      "EmergencyContactInfo": "sample string 3",
      "EmployeeType": "sample string 4",
      "JobRole": {
        "JobTitle": "sample string 1",
        "Department": "sample string 2",
        "IsCreateDepartment": true,
        "StartDate": "2025-07-04T11:59:37.623Z",
        "EffectiveDate": "2025-07-04T11:59:37.623Z",
        "SupervisorId": "sample string 4",
        "Shift": "sample string 5",
        "DailyHoursWorked": 1.0,
        "WeeklyDaysWorked": 1.0,
        "Wages": 1.0,
        "WageCurrencyType": "sample string 6",
        "WageIntervalType": "sample string 7"
      },
      "EmploymentStatus": "sample string 5"
    },
    "IsUser": true,
    "UserInformation": {
      "UserId": "sample string 1",
      "Level": {
        "Scope": "sample string 1",
        "Roles": [
          {
            "RoleName": "sample string 1",
            "ModuleName": "sample string 2"
          },
          {
            "RoleName": "sample string 1",
            "ModuleName": "sample string 2"
          }
        ]
      },
      "Locations": [
        {
          "Scope": "sample string 1",
          "Roles": [
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            },
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            }
          ]
        },
        {
          "Scope": "sample string 1",
          "Roles": [
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            },
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            }
          ]
        }
      ]
    },
    "Id": "sample string 2",
    "RecordUid": "f2577fbb-92fe-4392-b96a-b64d882794c3"
  },
  {
    "PersonInformation": {
      "Name": {
        "FirstName": "sample string 1",
        "MiddleName": "sample string 2",
        "LastName": "sample string 3",
        "PreferredName": "sample string 4",
        "Suffix": "sample string 5",
        "Salutation": "sample string 6"
      },
      "EmailAddress": "sample string 1",
      "Address": {
        "AddressLine1": "sample string 1",
        "AddressLine2": "sample string 2",
        "City": "sample string 3",
        "StateProvince": "sample string 4",
        "PostalCode": "sample string 5",
        "Country": "sample string 6",
        "County": "sample string 7",
        "Type": "sample string 8"
      },
      "DateOfBirth": "2025-07-04T11:59:37.622Z",
      "GenderType": "sample string 2",
      "MaritalStatusType": "sample string 3",
      "PrimaryLanguage": "sample string 4",
      "SecondaryLanguage": "sample string 5",
      "TaxpayerId": "sample string 6",
      "DependentCount": 7
    },
    "EmployeeInformation": {
      "DateHired": "2025-07-04T11:59:37.623Z",
      "TerminationDate": "2025-07-04T11:59:37.623Z",
      "Location": "sample string 1",
      "Occupation": "sample string 2",
      "EmergencyContactInfo": "sample string 3",
      "EmployeeType": "sample string 4",
      "JobRole": {
        "JobTitle": "sample string 1",
        "Department": "sample string 2",
        "IsCreateDepartment": true,
        "StartDate": "2025-07-04T11:59:37.623Z",
        "EffectiveDate": "2025-07-04T11:59:37.623Z",
        "SupervisorId": "sample string 4",
        "Shift": "sample string 5",
        "DailyHoursWorked": 1.0,
        "WeeklyDaysWorked": 1.0,
        "Wages": 1.0,
        "WageCurrencyType": "sample string 6",
        "WageIntervalType": "sample string 7"
      },
      "EmploymentStatus": "sample string 5"
    },
    "IsUser": true,
    "UserInformation": {
      "UserId": "sample string 1",
      "Level": {
        "Scope": "sample string 1",
        "Roles": [
          {
            "RoleName": "sample string 1",
            "ModuleName": "sample string 2"
          },
          {
            "RoleName": "sample string 1",
            "ModuleName": "sample string 2"
          }
        ]
      },
      "Locations": [
        {
          "Scope": "sample string 1",
          "Roles": [
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            },
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            }
          ]
        },
        {
          "Scope": "sample string 1",
          "Roles": [
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            },
            {
              "RoleName": "sample string 1",
              "ModuleName": "sample string 2"
            }
          ]
        }
      ]
    },
    "Id": "sample string 2",
    "RecordUid": "f2577fbb-92fe-4392-b96a-b64d882794c3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfHRItem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <HRItem>
    <Id>sample string 2</Id>
    <RecordUid>f2577fbb-92fe-4392-b96a-b64d882794c3</RecordUid>
    <PersonInformation>
      <Name>
        <FirstName>sample string 1</FirstName>
        <MiddleName>sample string 2</MiddleName>
        <LastName>sample string 3</LastName>
        <PreferredName>sample string 4</PreferredName>
        <Suffix>sample string 5</Suffix>
        <Salutation>sample string 6</Salutation>
      </Name>
      <EmailAddress>sample string 1</EmailAddress>
      <Address>
        <AddressLine1>sample string 1</AddressLine1>
        <AddressLine2>sample string 2</AddressLine2>
        <City>sample string 3</City>
        <StateProvince>sample string 4</StateProvince>
        <PostalCode>sample string 5</PostalCode>
        <Country>sample string 6</Country>
        <County>sample string 7</County>
        <Type>sample string 8</Type>
      </Address>
      <DateOfBirth>2025-07-04T07:59:37.6222432-04:00</DateOfBirth>
      <GenderType>sample string 2</GenderType>
      <MaritalStatusType>sample string 3</MaritalStatusType>
      <PrimaryLanguage>sample string 4</PrimaryLanguage>
      <SecondaryLanguage>sample string 5</SecondaryLanguage>
      <TaxpayerId>sample string 6</TaxpayerId>
      <DependentCount>7</DependentCount>
    </PersonInformation>
    <EmployeeInformation>
      <DateHired>2025-07-04T07:59:37.6232436-04:00</DateHired>
      <TerminationDate>2025-07-04T07:59:37.6232436-04:00</TerminationDate>
      <Location>sample string 1</Location>
      <Occupation>sample string 2</Occupation>
      <EmergencyContactInfo>sample string 3</EmergencyContactInfo>
      <EmployeeType>sample string 4</EmployeeType>
      <JobRole>
        <JobTitle>sample string 1</JobTitle>
        <Department>sample string 2</Department>
        <IsCreateDepartment>true</IsCreateDepartment>
        <StartDate>2025-07-04T07:59:37.6232436-04:00</StartDate>
        <EffectiveDate>2025-07-04T07:59:37.6232436-04:00</EffectiveDate>
        <SupervisorId>sample string 4</SupervisorId>
        <Shift>sample string 5</Shift>
        <DailyHoursWorked>1</DailyHoursWorked>
        <WeeklyDaysWorked>1</WeeklyDaysWorked>
        <Wages>1</Wages>
        <WageCurrencyType>sample string 6</WageCurrencyType>
        <WageIntervalType>sample string 7</WageIntervalType>
      </JobRole>
      <EmploymentStatus>sample string 5</EmploymentStatus>
    </EmployeeInformation>
    <IsUser>true</IsUser>
    <UserInformation>
      <UserId>sample string 1</UserId>
      <Level>
        <Scope>sample string 1</Scope>
        <Roles>
          <RolePermission>
            <RoleName>sample string 1</RoleName>
            <ModuleName>sample string 2</ModuleName>
          </RolePermission>
          <RolePermission>
            <RoleName>sample string 1</RoleName>
            <ModuleName>sample string 2</ModuleName>
          </RolePermission>
        </Roles>
      </Level>
      <Locations>
        <UserScope>
          <Scope>sample string 1</Scope>
          <Roles>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
          </Roles>
        </UserScope>
        <UserScope>
          <Scope>sample string 1</Scope>
          <Roles>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
          </Roles>
        </UserScope>
      </Locations>
    </UserInformation>
  </HRItem>
  <HRItem>
    <Id>sample string 2</Id>
    <RecordUid>f2577fbb-92fe-4392-b96a-b64d882794c3</RecordUid>
    <PersonInformation>
      <Name>
        <FirstName>sample string 1</FirstName>
        <MiddleName>sample string 2</MiddleName>
        <LastName>sample string 3</LastName>
        <PreferredName>sample string 4</PreferredName>
        <Suffix>sample string 5</Suffix>
        <Salutation>sample string 6</Salutation>
      </Name>
      <EmailAddress>sample string 1</EmailAddress>
      <Address>
        <AddressLine1>sample string 1</AddressLine1>
        <AddressLine2>sample string 2</AddressLine2>
        <City>sample string 3</City>
        <StateProvince>sample string 4</StateProvince>
        <PostalCode>sample string 5</PostalCode>
        <Country>sample string 6</Country>
        <County>sample string 7</County>
        <Type>sample string 8</Type>
      </Address>
      <DateOfBirth>2025-07-04T07:59:37.6222432-04:00</DateOfBirth>
      <GenderType>sample string 2</GenderType>
      <MaritalStatusType>sample string 3</MaritalStatusType>
      <PrimaryLanguage>sample string 4</PrimaryLanguage>
      <SecondaryLanguage>sample string 5</SecondaryLanguage>
      <TaxpayerId>sample string 6</TaxpayerId>
      <DependentCount>7</DependentCount>
    </PersonInformation>
    <EmployeeInformation>
      <DateHired>2025-07-04T07:59:37.6232436-04:00</DateHired>
      <TerminationDate>2025-07-04T07:59:37.6232436-04:00</TerminationDate>
      <Location>sample string 1</Location>
      <Occupation>sample string 2</Occupation>
      <EmergencyContactInfo>sample string 3</EmergencyContactInfo>
      <EmployeeType>sample string 4</EmployeeType>
      <JobRole>
        <JobTitle>sample string 1</JobTitle>
        <Department>sample string 2</Department>
        <IsCreateDepartment>true</IsCreateDepartment>
        <StartDate>2025-07-04T07:59:37.6232436-04:00</StartDate>
        <EffectiveDate>2025-07-04T07:59:37.6232436-04:00</EffectiveDate>
        <SupervisorId>sample string 4</SupervisorId>
        <Shift>sample string 5</Shift>
        <DailyHoursWorked>1</DailyHoursWorked>
        <WeeklyDaysWorked>1</WeeklyDaysWorked>
        <Wages>1</Wages>
        <WageCurrencyType>sample string 6</WageCurrencyType>
        <WageIntervalType>sample string 7</WageIntervalType>
      </JobRole>
      <EmploymentStatus>sample string 5</EmploymentStatus>
    </EmployeeInformation>
    <IsUser>true</IsUser>
    <UserInformation>
      <UserId>sample string 1</UserId>
      <Level>
        <Scope>sample string 1</Scope>
        <Roles>
          <RolePermission>
            <RoleName>sample string 1</RoleName>
            <ModuleName>sample string 2</ModuleName>
          </RolePermission>
          <RolePermission>
            <RoleName>sample string 1</RoleName>
            <ModuleName>sample string 2</ModuleName>
          </RolePermission>
        </Roles>
      </Level>
      <Locations>
        <UserScope>
          <Scope>sample string 1</Scope>
          <Roles>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
          </Roles>
        </UserScope>
        <UserScope>
          <Scope>sample string 1</Scope>
          <Roles>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
            <RolePermission>
              <RoleName>sample string 1</RoleName>
              <ModuleName>sample string 2</ModuleName>
            </RolePermission>
          </Roles>
        </UserScope>
      </Locations>
    </UserInformation>
  </HRItem>
</ArrayOfHRItem>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

FeedSubmissionResponse

Name	Type	Additional information
BatchUid	globally unique identifier	None.
IsBatchSuccessful	boolean	None.
BatchExceptionMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "BatchUid": "97c853ce-ad08-41f8-bb94-bfac615ffbbe",
  "IsBatchSuccessful": true,
  "BatchExceptionMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<FeedSubmissionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BatchUid>97c853ce-ad08-41f8-bb94-bfac615ffbbe</BatchUid>
  <IsBatchSuccessful>true</IsBatchSuccessful>
  <BatchExceptionMessage>sample string 3</BatchExceptionMessage>
</FeedSubmissionResponse>