SIRVA.Relocation.Services.InitiationGateway

<back to all web services

TransfereeInitiationRequest

Requires Authentication
The following routes are available for this service:
POST/Initiation/TransfereeInitiates a transferee.
TransfereeInitiationRequest Parameters:
NameParameterData TypeRequiredDescription
InitiationInfobodyTransfereeInitiationYesTransferee initiation info needed for creation.
TransfereeInitiation Parameters:
NameParameterData TypeRequiredDescription
ClientIdformstringNoClient ID
ExternalIdformstringYesExternal ID. This must be unique to the intiation's parent client
FirstNameformstringYesTransferee first name
LastNameformstringYesTransferee last name
AssignmentTypeformstringNoAssignment type
PreDecisionformbool?NoIs this transferee pre-decision
VIPformbool?NoIs this transferee a VIP
CustomFieldsformList<CustomField>NoCustom fields
EmployeeIdformstringNoEmployee ID
StartDateformDateTime?NoStart date
EndDateformDateTime?NoEnd date
OriginWorkLocationformLocationYesOrigin work location
OriginHomeAddressformAddressYesOrigin home address
DestinationWorkLocationformLocationYesDestination work location
RepatformstringNoRepat
RepatFromCityformstringNoRepat From City
RepatFromStateCodeformstringNoRepat From State code
RepatFromCountryCodeformstringNoRepat From Country Code
RepatToCityformstringNoRepat To City
RepatToStateCodeformstringNoRepat To State Code
RepatToCountryCodeformstringNoRepat To Country Code
CitizenshipCountryformstringNoTransferee citizenship country
DualCitizenshipCountryformstringNoTransferee dual citizenship country
PolicyformstringYesPolicy
JobTitleformstringNoJob title
MaritalStatusformMaritalStatus?NoMarital status

Allowable Values

  • Single
  • Married
  • DomesticPartner
  • Divorcee
  • Defacto
  • Other
  • Separated
  • Interdependent
  • Widowed
  • Divorced
PayGradeformstringNoPay grade
AssignmentFamilySizeformint?NoAssignment family size
HomeOwnerStatusformHomeOwnerStatus?NoHome owner status

Allowable Values

  • Homeowner
  • Renter
LineOfBusinessformstringYesLine of business
HostCurrencyformstringNoHostCurrency
ServiceLevelformstringNoServiceLevel
CompanyCodePrimaryformstringNoCompanyCodePrimary
CompanyCodeSecondaryformstringNoCompanyCodeSecondary
CostCenterPrimaryformstringNoCostCenterPrimary
CostCenterSecondaryformstringNoCostCenterSecondary
CostCenterTertiaryformstringNoCostCenterTertiary
Confidentialformbool?NoIs the assignment confidential
SpecialInstructionsformstringNoSpecial Instructions
DestinationEntityLegalNameformstringNoDestination entity legal name
MobilePhoneNumberformstringYesTransferee mobile phone number
WorkPhoneNumberformstringNoTransferee work phone number
HomePhoneNumberformstringNoTransferee home phone number
PrimaryEmailformstringYesTransferee primary email
SecondaryEmailformstringNoTransferee secondary email
HRContactFirstNameformstringNoHR Contact First Name
HRContactLastNameformstringNoHR Contact Last Name
HRContactFullNameformstringNoHR contact full name
AnnualSalaryformstringNoTransferee annual salary
SpousePartnerformSpousePartnerNoTransferee spouse/partner
DependentsformList<Dependent>NoTransferee dependents
ServicesformList<Service>NoAssignment Services
RelocationStatusformstringNoRelocation Status
CancelformstringNoCancel
CustomField Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringYesCustom field name
FieldValueformstringNoCustom field value
Location Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
CityformstringNo
StateCodeformstringNo
CountryCodeformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
Line1formstringNo
Line2formstringNo
Line3formstringNo
PostalCodeformstringNo
MaritalStatus Enum:
Single
Married
DomesticPartner
Divorcee
Defacto
Other
Separated
Interdependent
Widowed
Divorced
HomeOwnerStatus Enum:
Homeowner
Renter
SpousePartner Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
BirthDateformDateTime?No
Dependent Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
BirthDateformDateTime?No
RelationshipToAssigneeformDependentAssigneeRelationship?Yes

Allowable Values

  • Child
  • Other
DependentAssigneeRelationship Enum:
Child
Other
Service Parameters:
NameParameterData TypeRequiredDescription
NameformstringYesService name
DataformList<ServiceData>NoService data
CancelformstringNoCancel
ServiceData Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringYesService data field name
FieldValueformstringYesService data field value
TransfereeInitiationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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.sirva.com 
Accept: application/json
Content-Type: application/json
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-01T00:00:00.0000000","endDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000"},"dependents":[{"firstName":"String","lastName":"String","birthDate":"0001-01-01T00:00:00.0000000","relationshipToAssignee":"Child"}],"services":[{"name":"String","data":[{"fieldName":"String","fieldValue":"String"}],"cancel":"String"}],"relocationStatus":"String","cancel":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}