POST ESRAssignment

Request Parameters
Request Samples
Response Samples

Parameters

Name	Description	Additional information
request	The EsrAssignmentRequest	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "EsrAssignment": {
    "SysInternalAssignmentId": 1,
    "Assignmentid": 1,
    "EsrAssignId": 2,
    "AssignmentNumber": "sample string 3",
    "Active": true,
    "Earliestassignmentstartdate": "2025-01-26T06:55:56.1535158+00:00",
    "Finalassignmentenddate": "2025-01-26T06:55:56.1535158+00:00",
    "Assignmentstatus": 0,
    "Payrollpaytype": "sample string 5",
    "Payrollname": "sample string 6",
    "Payrollperiodtype": "sample string 7",
    "Assignmentaddress1": "sample string 8",
    "Assignmentaddress2": "sample string 9",
    "Assignmentaddresstown": "sample string 10",
    "Assignmentaddresscountry": "sample string 11",
    "Assignmentaddresspostcode": "sample string 12",
    "Assignmentaddresscounty": "sample string 13",
    "Supervisorflag": true,
    "Supervisorassignmentnumber": "sample string 15",
    "Supervisoremployementnumber": "sample string 16",
    "Supervisorfullname": "sample string 17",
    "Accrualplan": "sample string 18",
    "Employeecategory": "sample string 19",
    "Assignmentcategory": "sample string 20",
    "Primaryassignment": true,
    "Esrprimaryassignmentstring": "sample string 22",
    "Normalhours": 23.0,
    "Normalhoursfrequency": "sample string 24",
    "Gradecontracthours": 25.0,
    "Noofsessions": 26.0,
    "Sessionsfrequency": "sample string 27",
    "Workpatterndetails": "sample string 28",
    "Workpatternstartday": "sample string 29",
    "Flexibleworkingpattern": "sample string 30",
    "Availabilityschedule": "sample string 31",
    "Organisation": "sample string 32",
    "Legalentity": "sample string 33",
    "Positionname": "sample string 34",
    "Jobrole": "sample string 35",
    "Occupationcode": "sample string 36",
    "Assignmentlocation": "sample string 37",
    "Grade": "sample string 38",
    "Jobname": "sample string 39",
    "Group": "sample string 40",
    "Tandaflag": "sample string 41",
    "Nightworkeroptout": "sample string 42",
    "Projectedhiredate": "2025-01-26T06:55:56.1535158+00:00",
    "Vacancyid": 1,
    "EsrLocationId": 1,
    "EffectiveStartDate": "2025-01-26T06:55:56.1535158+00:00",
    "EffectiveEndDate": "2025-01-26T06:55:56.1535158+00:00",
    "SignOffOwner": null,
    "NumberOfSessions": 43.0,
    "EmployeeId": 44
  }
}

application/xml, text/xml

Sample:

<EsrAssignmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Requests">
  <EsrAssignment xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
    <d2p1:Accrualplan>sample string 18</d2p1:Accrualplan>
    <d2p1:Active>true</d2p1:Active>
    <d2p1:AssignmentNumber>sample string 3</d2p1:AssignmentNumber>
    <d2p1:Assignmentaddress1>sample string 8</d2p1:Assignmentaddress1>
    <d2p1:Assignmentaddress2>sample string 9</d2p1:Assignmentaddress2>
    <d2p1:Assignmentaddresscountry>sample string 11</d2p1:Assignmentaddresscountry>
    <d2p1:Assignmentaddresscounty>sample string 13</d2p1:Assignmentaddresscounty>
    <d2p1:Assignmentaddresspostcode>sample string 12</d2p1:Assignmentaddresspostcode>
    <d2p1:Assignmentaddresstown>sample string 10</d2p1:Assignmentaddresstown>
    <d2p1:Assignmentcategory>sample string 20</d2p1:Assignmentcategory>
    <d2p1:Assignmentid>1</d2p1:Assignmentid>
    <d2p1:Assignmentlocation>sample string 37</d2p1:Assignmentlocation>
    <d2p1:Assignmentstatus>NotSpecified</d2p1:Assignmentstatus>
    <d2p1:Availabilityschedule>sample string 31</d2p1:Availabilityschedule>
    <d2p1:Earliestassignmentstartdate>2025-01-26T06:55:56.1535158+00:00</d2p1:Earliestassignmentstartdate>
    <d2p1:EffectiveEndDate>2025-01-26T06:55:56.1535158+00:00</d2p1:EffectiveEndDate>
    <d2p1:EffectiveStartDate>2025-01-26T06:55:56.1535158+00:00</d2p1:EffectiveStartDate>
    <d2p1:EmployeeId>44</d2p1:EmployeeId>
    <d2p1:Employeecategory>sample string 19</d2p1:Employeecategory>
    <d2p1:EsrAssignId>2</d2p1:EsrAssignId>
    <d2p1:EsrLocationId>1</d2p1:EsrLocationId>
    <d2p1:Esrprimaryassignmentstring>sample string 22</d2p1:Esrprimaryassignmentstring>
    <d2p1:Finalassignmentenddate>2025-01-26T06:55:56.1535158+00:00</d2p1:Finalassignmentenddate>
    <d2p1:Flexibleworkingpattern>sample string 30</d2p1:Flexibleworkingpattern>
    <d2p1:Grade>sample string 38</d2p1:Grade>
    <d2p1:Gradecontracthours>25</d2p1:Gradecontracthours>
    <d2p1:Group>sample string 40</d2p1:Group>
    <d2p1:Jobname>sample string 39</d2p1:Jobname>
    <d2p1:Jobrole>sample string 35</d2p1:Jobrole>
    <d2p1:Legalentity>sample string 33</d2p1:Legalentity>
    <d2p1:Nightworkeroptout>sample string 42</d2p1:Nightworkeroptout>
    <d2p1:Noofsessions>26</d2p1:Noofsessions>
    <d2p1:Normalhours>23</d2p1:Normalhours>
    <d2p1:Normalhoursfrequency>sample string 24</d2p1:Normalhoursfrequency>
    <d2p1:NumberOfSessions>43</d2p1:NumberOfSessions>
    <d2p1:Occupationcode>sample string 36</d2p1:Occupationcode>
    <d2p1:Organisation>sample string 32</d2p1:Organisation>
    <d2p1:Payrollname>sample string 6</d2p1:Payrollname>
    <d2p1:Payrollpaytype>sample string 5</d2p1:Payrollpaytype>
    <d2p1:Payrollperiodtype>sample string 7</d2p1:Payrollperiodtype>
    <d2p1:Positionname>sample string 34</d2p1:Positionname>
    <d2p1:Primaryassignment>true</d2p1:Primaryassignment>
    <d2p1:Projectedhiredate>2025-01-26T06:55:56.1535158+00:00</d2p1:Projectedhiredate>
    <d2p1:Sessionsfrequency>sample string 27</d2p1:Sessionsfrequency>
    <d2p1:SignOffOwner i:nil="true" />
    <d2p1:Supervisorassignmentnumber>sample string 15</d2p1:Supervisorassignmentnumber>
    <d2p1:Supervisoremployementnumber>sample string 16</d2p1:Supervisoremployementnumber>
    <d2p1:Supervisorflag>true</d2p1:Supervisorflag>
    <d2p1:Supervisorfullname>sample string 17</d2p1:Supervisorfullname>
    <d2p1:SysInternalAssignmentId>1</d2p1:SysInternalAssignmentId>
    <d2p1:Tandaflag>sample string 41</d2p1:Tandaflag>
    <d2p1:Vacancyid>1</d2p1:Vacancyid>
    <d2p1:Workpatterndetails>sample string 28</d2p1:Workpatterndetails>
    <d2p1:Workpatternstartday>sample string 29</d2p1:Workpatternstartday>
  </EsrAssignment>
</EsrAssignmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

The ESRResponse

application/json, text/json

Sample:

{
  "Item": {
    "SysInternalAssignmentId": 1,
    "Assignmentid": 1,
    "EsrAssignId": 2,
    "AssignmentNumber": "sample string 3",
    "Active": true,
    "Earliestassignmentstartdate": "2025-01-26T06:55:56.1535158+00:00",
    "Finalassignmentenddate": "2025-01-26T06:55:56.1535158+00:00",
    "Assignmentstatus": 0,
    "Payrollpaytype": "sample string 5",
    "Payrollname": "sample string 6",
    "Payrollperiodtype": "sample string 7",
    "Assignmentaddress1": "sample string 8",
    "Assignmentaddress2": "sample string 9",
    "Assignmentaddresstown": "sample string 10",
    "Assignmentaddresscountry": "sample string 11",
    "Assignmentaddresspostcode": "sample string 12",
    "Assignmentaddresscounty": "sample string 13",
    "Supervisorflag": true,
    "Supervisorassignmentnumber": "sample string 15",
    "Supervisoremployementnumber": "sample string 16",
    "Supervisorfullname": "sample string 17",
    "Accrualplan": "sample string 18",
    "Employeecategory": "sample string 19",
    "Assignmentcategory": "sample string 20",
    "Primaryassignment": true,
    "Esrprimaryassignmentstring": "sample string 22",
    "Normalhours": 23.0,
    "Normalhoursfrequency": "sample string 24",
    "Gradecontracthours": 25.0,
    "Noofsessions": 26.0,
    "Sessionsfrequency": "sample string 27",
    "Workpatterndetails": "sample string 28",
    "Workpatternstartday": "sample string 29",
    "Flexibleworkingpattern": "sample string 30",
    "Availabilityschedule": "sample string 31",
    "Organisation": "sample string 32",
    "Legalentity": "sample string 33",
    "Positionname": "sample string 34",
    "Jobrole": "sample string 35",
    "Occupationcode": "sample string 36",
    "Assignmentlocation": "sample string 37",
    "Grade": "sample string 38",
    "Jobname": "sample string 39",
    "Group": "sample string 40",
    "Tandaflag": "sample string 41",
    "Nightworkeroptout": "sample string 42",
    "Projectedhiredate": "2025-01-26T06:55:56.1535158+00:00",
    "Vacancyid": 1,
    "EsrLocationId": 1,
    "EffectiveStartDate": "2025-01-26T06:55:56.1535158+00:00",
    "EffectiveEndDate": "2025-01-26T06:55:56.1535158+00:00",
    "SignOffOwner": null,
    "NumberOfSessions": 43.0,
    "EmployeeId": 44
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ESRResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Accrualplan>sample string 18</d2p1:Accrualplan>
    <d2p1:Active>true</d2p1:Active>
    <d2p1:AssignmentNumber>sample string 3</d2p1:AssignmentNumber>
    <d2p1:Assignmentaddress1>sample string 8</d2p1:Assignmentaddress1>
    <d2p1:Assignmentaddress2>sample string 9</d2p1:Assignmentaddress2>
    <d2p1:Assignmentaddresscountry>sample string 11</d2p1:Assignmentaddresscountry>
    <d2p1:Assignmentaddresscounty>sample string 13</d2p1:Assignmentaddresscounty>
    <d2p1:Assignmentaddresspostcode>sample string 12</d2p1:Assignmentaddresspostcode>
    <d2p1:Assignmentaddresstown>sample string 10</d2p1:Assignmentaddresstown>
    <d2p1:Assignmentcategory>sample string 20</d2p1:Assignmentcategory>
    <d2p1:Assignmentid>1</d2p1:Assignmentid>
    <d2p1:Assignmentlocation>sample string 37</d2p1:Assignmentlocation>
    <d2p1:Assignmentstatus>NotSpecified</d2p1:Assignmentstatus>
    <d2p1:Availabilityschedule>sample string 31</d2p1:Availabilityschedule>
    <d2p1:Earliestassignmentstartdate>2025-01-26T06:55:56.1535158+00:00</d2p1:Earliestassignmentstartdate>
    <d2p1:EffectiveEndDate>2025-01-26T06:55:56.1535158+00:00</d2p1:EffectiveEndDate>
    <d2p1:EffectiveStartDate>2025-01-26T06:55:56.1535158+00:00</d2p1:EffectiveStartDate>
    <d2p1:EmployeeId>44</d2p1:EmployeeId>
    <d2p1:Employeecategory>sample string 19</d2p1:Employeecategory>
    <d2p1:EsrAssignId>2</d2p1:EsrAssignId>
    <d2p1:EsrLocationId>1</d2p1:EsrLocationId>
    <d2p1:Esrprimaryassignmentstring>sample string 22</d2p1:Esrprimaryassignmentstring>
    <d2p1:Finalassignmentenddate>2025-01-26T06:55:56.1535158+00:00</d2p1:Finalassignmentenddate>
    <d2p1:Flexibleworkingpattern>sample string 30</d2p1:Flexibleworkingpattern>
    <d2p1:Grade>sample string 38</d2p1:Grade>
    <d2p1:Gradecontracthours>25</d2p1:Gradecontracthours>
    <d2p1:Group>sample string 40</d2p1:Group>
    <d2p1:Jobname>sample string 39</d2p1:Jobname>
    <d2p1:Jobrole>sample string 35</d2p1:Jobrole>
    <d2p1:Legalentity>sample string 33</d2p1:Legalentity>
    <d2p1:Nightworkeroptout>sample string 42</d2p1:Nightworkeroptout>
    <d2p1:Noofsessions>26</d2p1:Noofsessions>
    <d2p1:Normalhours>23</d2p1:Normalhours>
    <d2p1:Normalhoursfrequency>sample string 24</d2p1:Normalhoursfrequency>
    <d2p1:NumberOfSessions>43</d2p1:NumberOfSessions>
    <d2p1:Occupationcode>sample string 36</d2p1:Occupationcode>
    <d2p1:Organisation>sample string 32</d2p1:Organisation>
    <d2p1:Payrollname>sample string 6</d2p1:Payrollname>
    <d2p1:Payrollpaytype>sample string 5</d2p1:Payrollpaytype>
    <d2p1:Payrollperiodtype>sample string 7</d2p1:Payrollperiodtype>
    <d2p1:Positionname>sample string 34</d2p1:Positionname>
    <d2p1:Primaryassignment>true</d2p1:Primaryassignment>
    <d2p1:Projectedhiredate>2025-01-26T06:55:56.1535158+00:00</d2p1:Projectedhiredate>
    <d2p1:Sessionsfrequency>sample string 27</d2p1:Sessionsfrequency>
    <d2p1:SignOffOwner i:nil="true" />
    <d2p1:Supervisorassignmentnumber>sample string 15</d2p1:Supervisorassignmentnumber>
    <d2p1:Supervisoremployementnumber>sample string 16</d2p1:Supervisoremployementnumber>
    <d2p1:Supervisorflag>true</d2p1:Supervisorflag>
    <d2p1:Supervisorfullname>sample string 17</d2p1:Supervisorfullname>
    <d2p1:SysInternalAssignmentId>1</d2p1:SysInternalAssignmentId>
    <d2p1:Tandaflag>sample string 41</d2p1:Tandaflag>
    <d2p1:Vacancyid>1</d2p1:Vacancyid>
    <d2p1:Workpatterndetails>sample string 28</d2p1:Workpatterndetails>
    <d2p1:Workpatternstartday>sample string 29</d2p1:Workpatternstartday>
  </Item>
</ESRResponse>

POST ESRAssignment

Parameters

Request body formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response body formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body