POST api/V3/Beat/CreateEmployeePositionBeatMapping

creates user beat mapping or position beat mapping based on company setting

Request Information

URI Parameters

None.

Body Parameters

List of employee beat mapping or position beat mapping to be added(Max 100)

Collection of V3.EmployeePositionBeatMappingInput
NameDescriptionTypeAdditional information
UserErpId

ERP Id of the User to be mapped with Beat

 string

String length: inclusive between 0 and 100
BeatErpId

ERP ID of the Beat getting mapped to User or Position

 string

Required

String length: inclusive between 0 and 100
PositionCode

Position Code of the Position to be mapped with Beats

 string

String length: inclusive between 0 and 100
ProductDivision

ProductDivision to which Position Beat mapping is to be done. Default value: "Null"

 string

String length: inclusive between 0 and 100
IsSecondaryMapping

Is Position getting mapped as a Secondary Position to the Beat

 boolean

None.
Action

Attach or Detach

 string

Required

String length: inclusive between 0 and 6

Request Formats

application/json, text/json

Sample: 
[
  {
    "UserErpId": "sample string 1",
    "BeatErpId": "sample string 2",
    "PositionCode": "sample string 3",
    "ProductDivision": "sample string 4",
    "IsSecondaryMapping": true,
    "Action": "sample string 6"
  },
  {
    "UserErpId": "sample string 1",
    "BeatErpId": "sample string 2",
    "PositionCode": "sample string 3",
    "ProductDivision": "sample string 4",
    "IsSecondaryMapping": true,
    "Action": "sample string 6"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfEmployeePositionBeatMappingInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <EmployeePositionBeatMappingInput>
    <Action>sample string 6</Action>
    <BeatErpId>sample string 2</BeatErpId>
    <IsSecondaryMapping>true</IsSecondaryMapping>
    <PositionCode>sample string 3</PositionCode>
    <ProductDivision>sample string 4</ProductDivision>
    <UserErpId>sample string 1</UserErpId>
  </EmployeePositionBeatMappingInput>
  <EmployeePositionBeatMappingInput>
    <Action>sample string 6</Action>
    <BeatErpId>sample string 2</BeatErpId>
    <IsSecondaryMapping>true</IsSecondaryMapping>
    <PositionCode>sample string 3</PositionCode>
    <ProductDivision>sample string 4</ProductDivision>
    <UserErpId>sample string 1</UserErpId>
  </EmployeePositionBeatMappingInput>
</ArrayOfEmployeePositionBeatMappingInput>

Response Information

Resource Description

Response Description with Error messages

ApiResponse
NameDescriptionTypeAdditional information
Message

Message Indicating the Overall Response Summary of the Requested API

 string

None.
ResponseList

List of Errors

 Collection of ApiResponseMessage

None.
Response

Enum Indicating the Response status

 ResponseStatus

None.
ResponseStatusCount

Summary containing Number of SuccessFull And Failed Tasks

 ResponseStatusCount

None.

Response Formats

application/json, text/json

Sample: 
{
  "Message": "sample string 1",
  "ResponseList": [
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    },
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    }
  ],
  "Response": "Failure",
  "ResponseStatusCount": {
    "Updated": 1,
    "Failed": 2,
    "Ignored": 3,
    "Name": "sample string 1",
    "Total": 6,
    "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
    "ResponseStatus": "PartialSuccess"
  }
}

application/xml, text/xml

Sample: 
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <Message>sample string 1</Message>
  <Response>Failure</Response>
  <ResponseList>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
  </ResponseList>
  <ResponseStatusCount>
    <Failed>2</Failed>
    <Ignored>3</Ignored>
    <Name>sample string 1</Name>
    <Updated>1</Updated>
  </ResponseStatusCount>
</ApiResponse>