| POST | /Initiation/Transferee | Initiates a transferee. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class TransfereeInitiationRequest implements IRequireClientScoped, IPost
{
/**
* Transferee initiation info needed for creation.
*/
@ApiMember(Description="Transferee initiation info needed for creation.", IsRequired=true, ParameterType="body")
public TransfereeInitiation initiationInfo = null;
public TransfereeInitiation getInitiationInfo() { return initiationInfo; }
public TransfereeInitiationRequest setInitiationInfo(TransfereeInitiation value) { this.initiationInfo = value; return this; }
}
public static class TransfereeInitiation
{
/**
* Client ID
*/
@ApiMember(Description="Client ID")
public String clientId = null;
/**
* External ID. This must be unique to the intiation's parent client
*/
@ApiMember(Description="External ID. This must be unique to the intiation's parent client", IsRequired=true)
public String externalId = null;
/**
* Transferee first name
*/
@ApiMember(Description="Transferee first name", IsRequired=true)
public String firstName = null;
/**
* Transferee last name
*/
@ApiMember(Description="Transferee last name", IsRequired=true)
public String lastName = null;
/**
* Assignment type
*/
@ApiMember(Description="Assignment type")
public String assignmentType = null;
/**
* Is this transferee pre-decision
*/
@ApiMember(Description="Is this transferee pre-decision")
public Boolean preDecision = null;
/**
* Is this transferee a VIP
*/
@ApiMember(Description="Is this transferee a VIP")
public Boolean vip = null;
/**
* Custom fields
*/
@ApiMember(Description="Custom fields")
public ArrayList<CustomField> customFields = null;
/**
* Employee ID
*/
@ApiMember(Description="Employee ID")
public String employeeId = null;
/**
* Start date
*/
@ApiMember(Description="Start date")
public Date startDate = null;
/**
* End date
*/
@ApiMember(Description="End date")
public Date endDate = null;
/**
* Origin work location
*/
@ApiMember(Description="Origin work location", IsRequired=true)
public Location originWorkLocation = null;
/**
* Origin home address
*/
@ApiMember(Description="Origin home address", IsRequired=true)
public Address originHomeAddress = null;
/**
* Destination work location
*/
@ApiMember(Description="Destination work location", IsRequired=true)
public Location destinationWorkLocation = null;
/**
* Repat
*/
@ApiMember(Description="Repat")
public String repat = null;
/**
* Repat From City
*/
@ApiMember(Description="Repat From City")
public String repatFromCity = null;
/**
* Repat From State code
*/
@ApiMember(Description="Repat From State code")
public String repatFromStateCode = null;
/**
* Repat From Country Code
*/
@ApiMember(Description="Repat From Country Code")
public String repatFromCountryCode = null;
/**
* Repat To City
*/
@ApiMember(Description="Repat To City")
public String repatToCity = null;
/**
* Repat To State Code
*/
@ApiMember(Description="Repat To State Code")
public String repatToStateCode = null;
/**
* Repat To Country Code
*/
@ApiMember(Description="Repat To Country Code")
public String repatToCountryCode = null;
/**
* Transferee citizenship country
*/
@ApiMember(Description="Transferee citizenship country")
public String citizenshipCountry = null;
/**
* Transferee dual citizenship country
*/
@ApiMember(Description="Transferee dual citizenship country")
public String dualCitizenshipCountry = null;
/**
* Policy
*/
@ApiMember(Description="Policy", IsRequired=true)
public String policy = null;
/**
* Job title
*/
@ApiMember(Description="Job title")
public String jobTitle = null;
/**
* Marital status
*/
@ApiMember(Description="Marital status", Name="MaritalStatus")
public MaritalStatus maritalStatus = null;
/**
* Pay grade
*/
@ApiMember(Description="Pay grade")
public String payGrade = null;
/**
* Assignment family size
*/
@ApiMember(Description="Assignment family size")
public Integer assignmentFamilySize = null;
/**
* Home owner status
*/
@ApiMember(Description="Home owner status", Name="HomeOwnerStatus")
public HomeOwnerStatus homeOwnerStatus = null;
/**
* Line of business
*/
@ApiMember(Description="Line of business", IsRequired=true)
public String lineOfBusiness = null;
/**
* HostCurrency
*/
@ApiMember(Description="HostCurrency")
public String hostCurrency = null;
/**
* ServiceLevel
*/
@ApiMember(Description="ServiceLevel")
public String serviceLevel = null;
/**
* CompanyCodePrimary
*/
@ApiMember(Description="CompanyCodePrimary")
public String companyCodePrimary = null;
/**
* CompanyCodeSecondary
*/
@ApiMember(Description="CompanyCodeSecondary")
public String companyCodeSecondary = null;
/**
* CostCenterPrimary
*/
@ApiMember(Description="CostCenterPrimary")
public String costCenterPrimary = null;
/**
* CostCenterSecondary
*/
@ApiMember(Description="CostCenterSecondary")
public String costCenterSecondary = null;
/**
* CostCenterTertiary
*/
@ApiMember(Description="CostCenterTertiary")
public String costCenterTertiary = null;
/**
* Is the assignment confidential
*/
@ApiMember(Description="Is the assignment confidential")
public Boolean confidential = null;
/**
* Special Instructions
*/
@ApiMember(Description="Special Instructions")
public String specialInstructions = null;
/**
* Destination entity legal name
*/
@ApiMember(Description="Destination entity legal name")
public String destinationEntityLegalName = null;
/**
* Transferee mobile phone number
*/
@ApiMember(Description="Transferee mobile phone number", IsRequired=true)
public String mobilePhoneNumber = null;
/**
* Transferee work phone number
*/
@ApiMember(Description="Transferee work phone number")
public String workPhoneNumber = null;
/**
* Transferee home phone number
*/
@ApiMember(Description="Transferee home phone number")
public String homePhoneNumber = null;
/**
* Transferee primary email
*/
@ApiMember(Description="Transferee primary email", IsRequired=true)
public String primaryEmail = null;
/**
* Transferee secondary email
*/
@ApiMember(Description="Transferee secondary email")
public String secondaryEmail = null;
/**
* HR Contact First Name
*/
@ApiMember(Description="HR Contact First Name")
public String hrContactFirstName = null;
/**
* HR Contact Last Name
*/
@ApiMember(Description="HR Contact Last Name")
public String hrContactLastName = null;
/**
* HR contact full name
*/
@ApiMember(Description="HR contact full name")
public String hrContactFullName = null;
/**
* Transferee annual salary
*/
@ApiMember(Description="Transferee annual salary")
public String annualSalary = null;
/**
* Transferee spouse/partner
*/
@ApiMember(Description="Transferee spouse/partner")
public SpousePartner spousePartner = null;
/**
* Transferee dependents
*/
@ApiMember(Description="Transferee dependents")
public ArrayList<Dependent> dependents = null;
/**
* Assignment Services
*/
@ApiMember(Description="Assignment Services")
public ArrayList<Service> services = null;
/**
* Relocation Status
*/
@ApiMember(Description="Relocation Status")
public String relocationStatus = null;
/**
* Cancel
*/
@ApiMember(Description="Cancel")
public String cancel = null;
public String getClientId() { return clientId; }
public TransfereeInitiation setClientId(String value) { this.clientId = value; return this; }
public String getExternalId() { return externalId; }
public TransfereeInitiation setExternalId(String value) { this.externalId = value; return this; }
public String getFirstName() { return firstName; }
public TransfereeInitiation setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public TransfereeInitiation setLastName(String value) { this.lastName = value; return this; }
public String getAssignmentType() { return assignmentType; }
public TransfereeInitiation setAssignmentType(String value) { this.assignmentType = value; return this; }
public Boolean isPreDecision() { return preDecision; }
public TransfereeInitiation setPreDecision(Boolean value) { this.preDecision = value; return this; }
public Boolean isVip() { return vip; }
public TransfereeInitiation setVip(Boolean value) { this.vip = value; return this; }
public ArrayList<CustomField> getCustomFields() { return customFields; }
public TransfereeInitiation setCustomFields(ArrayList<CustomField> value) { this.customFields = value; return this; }
public String getEmployeeId() { return employeeId; }
public TransfereeInitiation setEmployeeId(String value) { this.employeeId = value; return this; }
public Date getStartDate() { return startDate; }
public TransfereeInitiation setStartDate(Date value) { this.startDate = value; return this; }
public Date getEndDate() { return endDate; }
public TransfereeInitiation setEndDate(Date value) { this.endDate = value; return this; }
public Location getOriginWorkLocation() { return originWorkLocation; }
public TransfereeInitiation setOriginWorkLocation(Location value) { this.originWorkLocation = value; return this; }
public Address getOriginHomeAddress() { return originHomeAddress; }
public TransfereeInitiation setOriginHomeAddress(Address value) { this.originHomeAddress = value; return this; }
public Location getDestinationWorkLocation() { return destinationWorkLocation; }
public TransfereeInitiation setDestinationWorkLocation(Location value) { this.destinationWorkLocation = value; return this; }
public String getRepat() { return repat; }
public TransfereeInitiation setRepat(String value) { this.repat = value; return this; }
public String getRepatFromCity() { return repatFromCity; }
public TransfereeInitiation setRepatFromCity(String value) { this.repatFromCity = value; return this; }
public String getRepatFromStateCode() { return repatFromStateCode; }
public TransfereeInitiation setRepatFromStateCode(String value) { this.repatFromStateCode = value; return this; }
public String getRepatFromCountryCode() { return repatFromCountryCode; }
public TransfereeInitiation setRepatFromCountryCode(String value) { this.repatFromCountryCode = value; return this; }
public String getRepatToCity() { return repatToCity; }
public TransfereeInitiation setRepatToCity(String value) { this.repatToCity = value; return this; }
public String getRepatToStateCode() { return repatToStateCode; }
public TransfereeInitiation setRepatToStateCode(String value) { this.repatToStateCode = value; return this; }
public String getRepatToCountryCode() { return repatToCountryCode; }
public TransfereeInitiation setRepatToCountryCode(String value) { this.repatToCountryCode = value; return this; }
public String getCitizenshipCountry() { return citizenshipCountry; }
public TransfereeInitiation setCitizenshipCountry(String value) { this.citizenshipCountry = value; return this; }
public String getDualCitizenshipCountry() { return dualCitizenshipCountry; }
public TransfereeInitiation setDualCitizenshipCountry(String value) { this.dualCitizenshipCountry = value; return this; }
public String getPolicy() { return policy; }
public TransfereeInitiation setPolicy(String value) { this.policy = value; return this; }
public String getJobTitle() { return jobTitle; }
public TransfereeInitiation setJobTitle(String value) { this.jobTitle = value; return this; }
public MaritalStatus getMaritalStatus() { return maritalStatus; }
public TransfereeInitiation setMaritalStatus(MaritalStatus value) { this.maritalStatus = value; return this; }
public String getPayGrade() { return payGrade; }
public TransfereeInitiation setPayGrade(String value) { this.payGrade = value; return this; }
public Integer getAssignmentFamilySize() { return assignmentFamilySize; }
public TransfereeInitiation setAssignmentFamilySize(Integer value) { this.assignmentFamilySize = value; return this; }
public HomeOwnerStatus getHomeOwnerStatus() { return homeOwnerStatus; }
public TransfereeInitiation setHomeOwnerStatus(HomeOwnerStatus value) { this.homeOwnerStatus = value; return this; }
public String getLineOfBusiness() { return lineOfBusiness; }
public TransfereeInitiation setLineOfBusiness(String value) { this.lineOfBusiness = value; return this; }
public String getHostCurrency() { return hostCurrency; }
public TransfereeInitiation setHostCurrency(String value) { this.hostCurrency = value; return this; }
public String getServiceLevel() { return serviceLevel; }
public TransfereeInitiation setServiceLevel(String value) { this.serviceLevel = value; return this; }
public String getCompanyCodePrimary() { return companyCodePrimary; }
public TransfereeInitiation setCompanyCodePrimary(String value) { this.companyCodePrimary = value; return this; }
public String getCompanyCodeSecondary() { return companyCodeSecondary; }
public TransfereeInitiation setCompanyCodeSecondary(String value) { this.companyCodeSecondary = value; return this; }
public String getCostCenterPrimary() { return costCenterPrimary; }
public TransfereeInitiation setCostCenterPrimary(String value) { this.costCenterPrimary = value; return this; }
public String getCostCenterSecondary() { return costCenterSecondary; }
public TransfereeInitiation setCostCenterSecondary(String value) { this.costCenterSecondary = value; return this; }
public String getCostCenterTertiary() { return costCenterTertiary; }
public TransfereeInitiation setCostCenterTertiary(String value) { this.costCenterTertiary = value; return this; }
public Boolean isConfidential() { return confidential; }
public TransfereeInitiation setConfidential(Boolean value) { this.confidential = value; return this; }
public String getSpecialInstructions() { return specialInstructions; }
public TransfereeInitiation setSpecialInstructions(String value) { this.specialInstructions = value; return this; }
public String getDestinationEntityLegalName() { return destinationEntityLegalName; }
public TransfereeInitiation setDestinationEntityLegalName(String value) { this.destinationEntityLegalName = value; return this; }
public String getMobilePhoneNumber() { return mobilePhoneNumber; }
public TransfereeInitiation setMobilePhoneNumber(String value) { this.mobilePhoneNumber = value; return this; }
public String getWorkPhoneNumber() { return workPhoneNumber; }
public TransfereeInitiation setWorkPhoneNumber(String value) { this.workPhoneNumber = value; return this; }
public String getHomePhoneNumber() { return homePhoneNumber; }
public TransfereeInitiation setHomePhoneNumber(String value) { this.homePhoneNumber = value; return this; }
public String getPrimaryEmail() { return primaryEmail; }
public TransfereeInitiation setPrimaryEmail(String value) { this.primaryEmail = value; return this; }
public String getSecondaryEmail() { return secondaryEmail; }
public TransfereeInitiation setSecondaryEmail(String value) { this.secondaryEmail = value; return this; }
public String getHrContactFirstName() { return hrContactFirstName; }
public TransfereeInitiation setHrContactFirstName(String value) { this.hrContactFirstName = value; return this; }
public String getHrContactLastName() { return hrContactLastName; }
public TransfereeInitiation setHrContactLastName(String value) { this.hrContactLastName = value; return this; }
public String getHrContactFullName() { return hrContactFullName; }
public TransfereeInitiation setHrContactFullName(String value) { this.hrContactFullName = value; return this; }
public String getAnnualSalary() { return annualSalary; }
public TransfereeInitiation setAnnualSalary(String value) { this.annualSalary = value; return this; }
public SpousePartner getSpousePartner() { return spousePartner; }
public TransfereeInitiation setSpousePartner(SpousePartner value) { this.spousePartner = value; return this; }
public ArrayList<Dependent> getDependents() { return dependents; }
public TransfereeInitiation setDependents(ArrayList<Dependent> value) { this.dependents = value; return this; }
public ArrayList<Service> getServices() { return services; }
public TransfereeInitiation setServices(ArrayList<Service> value) { this.services = value; return this; }
public String getRelocationStatus() { return relocationStatus; }
public TransfereeInitiation setRelocationStatus(String value) { this.relocationStatus = value; return this; }
public String getCancel() { return cancel; }
public TransfereeInitiation setCancel(String value) { this.cancel = value; return this; }
}
public static class CustomField
{
/**
* Custom field name
*/
@ApiMember(Description="Custom field name", IsRequired=true)
public String fieldName = null;
/**
* Custom field value
*/
@ApiMember(Description="Custom field value")
public String fieldValue = null;
public String getFieldName() { return fieldName; }
public CustomField setFieldName(String value) { this.fieldName = value; return this; }
public String getFieldValue() { return fieldValue; }
public CustomField setFieldValue(String value) { this.fieldValue = value; return this; }
}
public static class Location
{
public String title = null;
public String city = null;
public String stateCode = null;
public String countryCode = null;
public String getTitle() { return title; }
public Location setTitle(String value) { this.title = value; return this; }
public String getCity() { return city; }
public Location setCity(String value) { this.city = value; return this; }
public String getStateCode() { return stateCode; }
public Location setStateCode(String value) { this.stateCode = value; return this; }
public String getCountryCode() { return countryCode; }
public Location setCountryCode(String value) { this.countryCode = value; return this; }
}
public static class Address extends Location
{
public String line1 = null;
public String line2 = null;
public String line3 = null;
public String postalCode = null;
public String getLine1() { return line1; }
public Address setLine1(String value) { this.line1 = value; return this; }
public String getLine2() { return line2; }
public Address setLine2(String value) { this.line2 = value; return this; }
public String getLine3() { return line3; }
public Address setLine3(String value) { this.line3 = value; return this; }
public String getPostalCode() { return postalCode; }
public Address setPostalCode(String value) { this.postalCode = value; return this; }
}
public static enum MaritalStatus
{
Single,
Married,
DomesticPartner,
Divorcee,
Defacto,
Other,
Separated,
Interdependent,
Widowed,
Divorced;
}
public static enum HomeOwnerStatus
{
Homeowner,
Renter;
}
public static class SpousePartner
{
public String firstName = null;
public String lastName = null;
public Date birthDate = null;
public String getFirstName() { return firstName; }
public SpousePartner setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public SpousePartner setLastName(String value) { this.lastName = value; return this; }
public Date getBirthDate() { return birthDate; }
public SpousePartner setBirthDate(Date value) { this.birthDate = value; return this; }
}
public static class Dependent
{
public String firstName = null;
public String lastName = null;
public Date birthDate = null;
@ApiMember(IsRequired=true, Name="RelationshipToAssignee")
public DependentAssigneeRelationship relationshipToAssignee = null;
public String getFirstName() { return firstName; }
public Dependent setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public Dependent setLastName(String value) { this.lastName = value; return this; }
public Date getBirthDate() { return birthDate; }
public Dependent setBirthDate(Date value) { this.birthDate = value; return this; }
public DependentAssigneeRelationship getRelationshipToAssignee() { return relationshipToAssignee; }
public Dependent setRelationshipToAssignee(DependentAssigneeRelationship value) { this.relationshipToAssignee = value; return this; }
}
public static enum DependentAssigneeRelationship
{
Child,
Other;
}
public static class Service
{
/**
* Service name
*/
@ApiMember(Description="Service name", IsRequired=true)
public String name = null;
/**
* Service data
*/
@ApiMember(Description="Service data")
public ArrayList<ServiceData> data = null;
/**
* Cancel
*/
@ApiMember(Description="Cancel")
public String cancel = null;
public String getName() { return name; }
public Service setName(String value) { this.name = value; return this; }
public ArrayList<ServiceData> getData() { return data; }
public Service setData(ArrayList<ServiceData> value) { this.data = value; return this; }
public String getCancel() { return cancel; }
public Service setCancel(String value) { this.cancel = value; return this; }
}
public static class ServiceData
{
/**
* Service data field name
*/
@ApiMember(Description="Service data field name", IsRequired=true)
public String fieldName = null;
/**
* Service data field value
*/
@ApiMember(Description="Service data field value", IsRequired=true)
public String fieldValue = null;
public String getFieldName() { return fieldName; }
public ServiceData setFieldName(String value) { this.fieldName = value; return this; }
public String getFieldValue() { return fieldValue; }
public ServiceData setFieldValue(String value) { this.fieldValue = value; return this; }
}
public static class TransfereeInitiationResponse
{
public ResponseStatus responseStatus = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public TransfereeInitiationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
}
Java TransfereeInitiationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Initiation/Transferee HTTP/1.1
Host: initiation-api-test.sirva.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
initiationInfo:
{
clientId: String,
externalId: String,
firstName: String,
lastName: String,
assignmentType: String,
preDecision: False,
vip: False,
customFields:
[
{
fieldName: String,
fieldValue: String
}
],
employeeId: String,
startDate: 0001-01-01,
endDate: 0001-01-01,
originWorkLocation:
{
title: String,
city: String,
stateCode: String,
countryCode: String
},
originHomeAddress:
{
line1: String,
line2: String,
line3: String,
postalCode: String,
title: String,
city: String,
stateCode: String,
countryCode: String
},
destinationWorkLocation:
{
title: String,
city: String,
stateCode: String,
countryCode: String
},
repat: String,
repatFromCity: String,
repatFromStateCode: String,
repatFromCountryCode: String,
repatToCity: String,
repatToStateCode: String,
repatToCountryCode: String,
citizenshipCountry: String,
dualCitizenshipCountry: String,
policy: String,
jobTitle: String,
maritalStatus: Single,
payGrade: String,
assignmentFamilySize: 0,
homeOwnerStatus: Homeowner,
lineOfBusiness: String,
hostCurrency: String,
serviceLevel: String,
companyCodePrimary: String,
companyCodeSecondary: String,
costCenterPrimary: String,
costCenterSecondary: String,
costCenterTertiary: String,
confidential: False,
specialInstructions: String,
destinationEntityLegalName: String,
mobilePhoneNumber: String,
workPhoneNumber: String,
homePhoneNumber: String,
primaryEmail: String,
secondaryEmail: String,
hrContactFirstName: String,
hrContactLastName: String,
hrContactFullName: String,
annualSalary: String,
spousePartner:
{
firstName: String,
lastName: String,
birthDate: 0001-01-01
},
dependents:
[
{
firstName: String,
lastName: String,
birthDate: 0001-01-01,
relationshipToAssignee: Child
}
],
services:
[
{
name: String,
data:
[
{
fieldName: String,
fieldValue: String
}
],
cancel: String
}
],
relocationStatus: String,
cancel: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}