POST v1/imports/emergency-contacts?importAction={importAction}&allowSameFile={allowSameFile}

Import Emergency Contacts

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Override
allowSameFile	Determines if the import allows the content to be imported multiple times	boolean	Default value is True

Body Parameters

The items to import.

Collection of EmployeeEmergencyContactImportDTO

Name	Type	Additional information
SerializableEmergencyContactKey	globally unique identifier	None.
FirstName	string	None.
MiddleInitial	character	None.
LastName	string	None.
Email	string	None.
HomePhone	string	None.
MobilePhone	string	None.
WorkPhone	string	None.
Relationship	string	None.
IsArrestDetentionContact	boolean	None.
Address	AddressDTO	None.
Documents	Collection of DivisionDocumentSubImportDTO	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "serializableEmergencyContactKey": "63b993d8-76aa-46d1-94e2-3cf117735c11",
    "emergencyContactKey": "63b993d8-76aa-46d1-94e2-3cf117735c11",
    "firstName": "sample string 1",
    "middleInitial": "A",
    "lastName": "sample string 2",
    "email": "sample string 3",
    "homePhone": "sample string 4",
    "mobilePhone": "sample string 5",
    "workPhone": "sample string 6",
    "relationship": "sample string 7",
    "isArrestDetentionContact": true,
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "documents": [
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      },
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      }
    ],
    "employeeNumber": "sample string 9",
    "employeePersonalId": 1,
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  },
  {
    "serializableEmergencyContactKey": "63b993d8-76aa-46d1-94e2-3cf117735c11",
    "emergencyContactKey": "63b993d8-76aa-46d1-94e2-3cf117735c11",
    "firstName": "sample string 1",
    "middleInitial": "A",
    "lastName": "sample string 2",
    "email": "sample string 3",
    "homePhone": "sample string 4",
    "mobilePhone": "sample string 5",
    "workPhone": "sample string 6",
    "relationship": "sample string 7",
    "isArrestDetentionContact": true,
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "documents": [
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      },
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      }
    ],
    "employeeNumber": "sample string 9",
    "employeePersonalId": 1,
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  }
]

text/xml

Sample:

<ArrayOfEmployeeEmergencyContactImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeEmergencyContactImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <Documents>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
    </Documents>
    <Email>sample string 3</Email>
    <EmergencyContactKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>true</d3p1:_hasValue>
        <d3p1:_value>63b993d8-76aa-46d1-94e2-3cf117735c11</d3p1:_value>
      </d3p1:_entityKey>
    </EmergencyContactKey>
    <FirstName>sample string 1</FirstName>
    <HomePhone>sample string 4</HomePhone>
    <IsArrestDetentionContact>true</IsArrestDetentionContact>
    <LastName>sample string 2</LastName>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 5</MobilePhone>
    <Relationship>sample string 7</Relationship>
    <SerializableEmergencyContactKey>63b993d8-76aa-46d1-94e2-3cf117735c11</SerializableEmergencyContactKey>
    <WorkPhone>sample string 6</WorkPhone>
  </EmployeeEmergencyContactImportDTO>
  <EmployeeEmergencyContactImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <Documents>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
    </Documents>
    <Email>sample string 3</Email>
    <EmergencyContactKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>true</d3p1:_hasValue>
        <d3p1:_value>63b993d8-76aa-46d1-94e2-3cf117735c11</d3p1:_value>
      </d3p1:_entityKey>
    </EmergencyContactKey>
    <FirstName>sample string 1</FirstName>
    <HomePhone>sample string 4</HomePhone>
    <IsArrestDetentionContact>true</IsArrestDetentionContact>
    <LastName>sample string 2</LastName>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 5</MobilePhone>
    <Relationship>sample string 7</Relationship>
    <SerializableEmergencyContactKey>63b993d8-76aa-46d1-94e2-3cf117735c11</SerializableEmergencyContactKey>
    <WorkPhone>sample string 6</WorkPhone>
  </EmployeeEmergencyContactImportDTO>
</ArrayOfEmployeeEmergencyContactImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the import.

ImportResultDTO

Name	Type	Additional information
NewRecords	integer	None.
UpdatedRecords	integer	None.
Errors	Collection of ImportErrorDTO	None.
NewRecordKeys	Collection of ImportKeyDTO	None.
UpdatedRecordKeys	Collection of ImportKeyDTO	None.
ImportKey	GlobalEntityKeyOfIImportSubmission	None.

Response Formats

application/json, text/json

Sample:

{
  "newRecords": 1,
  "updatedRecords": 2,
  "errors": [
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    },
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  ],
  "newRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "updatedRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "importKey": "<empty>"
}

text/xml

Sample:

<ImportResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <Errors>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
  </Errors>
  <ImportKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
    <d2p1:_entityKey>
      <d2p1:_hasValue>false</d2p1:_hasValue>
      <d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
    </d2p1:_entityKey>
  </ImportKey>
  <NewRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </NewRecordKeys>
  <NewRecords>1</NewRecords>
  <UpdatedRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </UpdatedRecordKeys>
  <UpdatedRecords>2</UpdatedRecords>
</ImportResultDTO>