SIRVA.Relocation.Services.InitiationGateway

TransfereeInitiationRequest

The following routes are available for this service:
POST	/Initiation/Transferee	Initiates a transferee.

**TransfereeInitiationRequest** Parameters:
Name	Parameter	Data Type	Required	Description
InitiationInfo	body	TransfereeInitiation	Yes	Transferee initiation info needed for creation.

**TransfereeInitiation** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	form	string	No	Client ID
ExternalId	form	string	Yes	External ID. This must be unique to the intiation's parent client
FirstName	form	string	Yes	Transferee first name
LastName	form	string	Yes	Transferee last name
AssignmentType	form	string	No	Assignment type
PreDecision	form	bool?	No	Is this transferee pre-decision
VIP	form	bool?	No	Is this transferee a VIP
CustomFields	form	List<CustomField>	No	Custom fields
EmployeeId	form	string	No	Employee ID
StartDate	form	DateTime?	No	Start date
EndDate	form	DateTime?	No	End date
OriginWorkLocation	form	Location	Yes	Origin work location
OriginHomeAddress	form	Address	Yes	Origin home address
DestinationWorkLocation	form	Location	Yes	Destination work location
Repat	form	string	No	Repat
RepatFromCity	form	string	No	Repat From City
RepatFromStateCode	form	string	No	Repat From State code
RepatFromCountryCode	form	string	No	Repat From Country Code
RepatToCity	form	string	No	Repat To City
RepatToStateCode	form	string	No	Repat To State Code
RepatToCountryCode	form	string	No	Repat To Country Code
CitizenshipCountry	form	string	No	Transferee citizenship country
DualCitizenshipCountry	form	string	No	Transferee dual citizenship country
Policy	form	string	Yes	Policy
JobTitle	form	string	No	Job title
MaritalStatus	form	MaritalStatus?	No	Marital status Allowable Values Single Married DomesticPartner Divorcee Defacto Other Separated Interdependent Widowed Divorced
PayGrade	form	string	No	Pay grade
AssignmentFamilySize	form	int?	No	Assignment family size
HomeOwnerStatus	form	HomeOwnerStatus?	No	Home owner status Allowable Values Homeowner Renter
LineOfBusiness	form	string	Yes	Line of business
HostCurrency	form	string	No	HostCurrency
ServiceLevel	form	string	No	ServiceLevel
CompanyCodePrimary	form	string	No	CompanyCodePrimary
CompanyCodeSecondary	form	string	No	CompanyCodeSecondary
CostCenterPrimary	form	string	No	CostCenterPrimary
CostCenterSecondary	form	string	No	CostCenterSecondary
CostCenterTertiary	form	string	No	CostCenterTertiary
Confidential	form	bool?	No	Is the assignment confidential
SpecialInstructions	form	string	No	Special Instructions
DestinationEntityLegalName	form	string	No	Destination entity legal name
MobilePhoneNumber	form	string	Yes	Transferee mobile phone number
WorkPhoneNumber	form	string	No	Transferee work phone number
HomePhoneNumber	form	string	No	Transferee home phone number
PrimaryEmail	form	string	Yes	Transferee primary email
SecondaryEmail	form	string	No	Transferee secondary email
HRContactFirstName	form	string	No	HR Contact First Name
HRContactLastName	form	string	No	HR Contact Last Name
HRContactFullName	form	string	No	HR contact full name
AnnualSalary	form	string	No	Transferee annual salary
SpousePartner	form	SpousePartner	No	Transferee spouse/partner
Dependents	form	List<Dependent>	No	Transferee dependents
Services	form	List<Service>	No	Assignment Services
RelocationStatus	form	string	No	Relocation Status
Cancel	form	string	No	Cancel

**CustomField** Parameters:
Name	Parameter	Data Type	Required	Description
FieldName	form	string	Yes	Custom field name
FieldValue	form	string	No	Custom field value

**Location** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
City	form	string	No
StateCode	form	string	No
CountryCode	form	string	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Line1	form	string	No
Line2	form	string	No
Line3	form	string	No
PostalCode	form	string	No

**MaritalStatus** Enum:
Single
Married
DomesticPartner
Divorcee
Defacto
Other
Separated
Interdependent
Widowed
Divorced

**HomeOwnerStatus** Enum:
Homeowner
Renter

**SpousePartner** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	No
LastName	form	string	No
BirthDate	form	DateTime?	No

**Dependent** Parameters:
Name	Parameter	Data Type	Required	Description
FirstName	form	string	No
LastName	form	string	No
BirthDate	form	DateTime?	No
RelationshipToAssignee	form	DependentAssigneeRelationship?	Yes	Allowable Values Child Other

**DependentAssigneeRelationship** Enum:
Child
Other

**Service** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	Service name
Data	form	List<ServiceData>	No	Service data
Cancel	form	string	No	Cancel

**ServiceData** Parameters:
Name	Parameter	Data Type	Required	Description
FieldName	form	string	Yes	Service data field name
FieldValue	form	string	Yes	Service data field value

**TransfereeInitiationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}

SIRVA.Relocation.Services.InitiationGateway

TransfereeInitiationRequest

Allowable Values

Allowable Values

Allowable Values

HTTP + JSV