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.
"use strict";
export class TransfereeInitiationResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
}
export class CustomField {
    /** @param {{fieldName?:string,fieldValue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Custom field name */
    fieldName;
    /**
     * @type {string}
     * @description Custom field value */
    fieldValue;
}
export class Location {
    /** @param {{title?:string,city?:string,stateCode?:string,countryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    title;
    /** @type {string} */
    city;
    /** @type {string} */
    stateCode;
    /** @type {string} */
    countryCode;
}
export class Address extends Location {
    /** @param {{line1?:string,line2?:string,line3?:string,postalCode?:string,title?:string,city?:string,stateCode?:string,countryCode?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    line1;
    /** @type {string} */
    line2;
    /** @type {string} */
    line3;
    /** @type {string} */
    postalCode;
}
/** @typedef {'Single'|'Married'|'DomesticPartner'|'Divorcee'|'Defacto'|'Other'|'Separated'|'Interdependent'|'Widowed'|'Divorced'} */
export var MaritalStatus;
(function (MaritalStatus) {
    MaritalStatus["Single"] = "Single"
    MaritalStatus["Married"] = "Married"
    MaritalStatus["DomesticPartner"] = "DomesticPartner"
    MaritalStatus["Divorcee"] = "Divorcee"
    MaritalStatus["Defacto"] = "Defacto"
    MaritalStatus["Other"] = "Other"
    MaritalStatus["Separated"] = "Separated"
    MaritalStatus["Interdependent"] = "Interdependent"
    MaritalStatus["Widowed"] = "Widowed"
    MaritalStatus["Divorced"] = "Divorced"
})(MaritalStatus || (MaritalStatus = {}));
/** @typedef {'Homeowner'|'Renter'} */
export var HomeOwnerStatus;
(function (HomeOwnerStatus) {
    HomeOwnerStatus["Homeowner"] = "Homeowner"
    HomeOwnerStatus["Renter"] = "Renter"
})(HomeOwnerStatus || (HomeOwnerStatus = {}));
export class SpousePartner {
    /** @param {{firstName?:string,lastName?:string,birthDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {?string} */
    birthDate;
}
/** @typedef {'Child'|'Other'} */
export var DependentAssigneeRelationship;
(function (DependentAssigneeRelationship) {
    DependentAssigneeRelationship["Child"] = "Child"
    DependentAssigneeRelationship["Other"] = "Other"
})(DependentAssigneeRelationship || (DependentAssigneeRelationship = {}));
export class Dependent {
    /** @param {{firstName?:string,lastName?:string,birthDate?:string,relationshipToAssignee?:DependentAssigneeRelationship}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {?string} */
    birthDate;
    /** @type {DependentAssigneeRelationship} */
    relationshipToAssignee;
}
export class ServiceData {
    /** @param {{fieldName?:string,fieldValue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Service data field name */
    fieldName;
    /**
     * @type {string}
     * @description Service data field value */
    fieldValue;
}
export class Service {
    /** @param {{name?:string,data?:ServiceData[],cancel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Service name */
    name;
    /**
     * @type {ServiceData[]}
     * @description Service data */
    data;
    /**
     * @type {string}
     * @description Cancel */
    cancel;
}
export class TransfereeInitiation {
    /** @param {{clientId?:string,externalId?:string,firstName?:string,lastName?:string,assignmentType?:string,preDecision?:boolean,vip?:boolean,customFields?:CustomField[],employeeId?:string,startDate?:string,endDate?:string,originWorkLocation?:Location,originHomeAddress?:Address,destinationWorkLocation?:Location,repat?:string,repatFromCity?:string,repatFromStateCode?:string,repatFromCountryCode?:string,repatToCity?:string,repatToStateCode?:string,repatToCountryCode?:string,citizenshipCountry?:string,dualCitizenshipCountry?:string,policy?:string,jobTitle?:string,maritalStatus?:MaritalStatus,payGrade?:string,assignmentFamilySize?:number,homeOwnerStatus?:HomeOwnerStatus,lineOfBusiness?:string,hostCurrency?:string,serviceLevel?:string,companyCodePrimary?:string,companyCodeSecondary?:string,costCenterPrimary?:string,costCenterSecondary?:string,costCenterTertiary?:string,confidential?:boolean,specialInstructions?:string,destinationEntityLegalName?:string,mobilePhoneNumber?:string,workPhoneNumber?:string,homePhoneNumber?:string,primaryEmail?:string,secondaryEmail?:string,hrContactFirstName?:string,hrContactLastName?:string,hrContactFullName?:string,annualSalary?:string,spousePartner?:SpousePartner,dependents?:Dependent[],services?:Service[],relocationStatus?:string,cancel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Client ID */
    clientId;
    /**
     * @type {string}
     * @description External ID. This must be unique to the intiation's parent client */
    externalId;
    /**
     * @type {string}
     * @description Transferee first name */
    firstName;
    /**
     * @type {string}
     * @description Transferee last name */
    lastName;
    /**
     * @type {string}
     * @description Assignment type */
    assignmentType;
    /**
     * @type {?boolean}
     * @description Is this transferee pre-decision */
    preDecision;
    /**
     * @type {?boolean}
     * @description Is this transferee a VIP */
    vip;
    /**
     * @type {CustomField[]}
     * @description Custom fields */
    customFields;
    /**
     * @type {string}
     * @description Employee ID */
    employeeId;
    /**
     * @type {?string}
     * @description Start date */
    startDate;
    /**
     * @type {?string}
     * @description End date */
    endDate;
    /**
     * @type {Location}
     * @description Origin work location */
    originWorkLocation;
    /**
     * @type {Address}
     * @description Origin home address */
    originHomeAddress;
    /**
     * @type {Location}
     * @description Destination work location */
    destinationWorkLocation;
    /**
     * @type {string}
     * @description Repat */
    repat;
    /**
     * @type {string}
     * @description Repat From City */
    repatFromCity;
    /**
     * @type {string}
     * @description Repat From State code */
    repatFromStateCode;
    /**
     * @type {string}
     * @description Repat From Country Code */
    repatFromCountryCode;
    /**
     * @type {string}
     * @description Repat To City */
    repatToCity;
    /**
     * @type {string}
     * @description Repat To State Code */
    repatToStateCode;
    /**
     * @type {string}
     * @description Repat To Country Code */
    repatToCountryCode;
    /**
     * @type {string}
     * @description Transferee citizenship country */
    citizenshipCountry;
    /**
     * @type {string}
     * @description Transferee dual citizenship country */
    dualCitizenshipCountry;
    /**
     * @type {string}
     * @description Policy */
    policy;
    /**
     * @type {string}
     * @description Job title */
    jobTitle;
    /**
     * @type {?MaritalStatus}
     * @description Marital status */
    maritalStatus;
    /**
     * @type {string}
     * @description Pay grade */
    payGrade;
    /**
     * @type {?number}
     * @description Assignment family size */
    assignmentFamilySize;
    /**
     * @type {?HomeOwnerStatus}
     * @description Home owner status */
    homeOwnerStatus;
    /**
     * @type {string}
     * @description Line of business */
    lineOfBusiness;
    /**
     * @type {string}
     * @description HostCurrency */
    hostCurrency;
    /**
     * @type {string}
     * @description ServiceLevel */
    serviceLevel;
    /**
     * @type {string}
     * @description CompanyCodePrimary */
    companyCodePrimary;
    /**
     * @type {string}
     * @description CompanyCodeSecondary */
    companyCodeSecondary;
    /**
     * @type {string}
     * @description CostCenterPrimary */
    costCenterPrimary;
    /**
     * @type {string}
     * @description CostCenterSecondary */
    costCenterSecondary;
    /**
     * @type {string}
     * @description CostCenterTertiary */
    costCenterTertiary;
    /**
     * @type {?boolean}
     * @description Is the assignment confidential */
    confidential;
    /**
     * @type {string}
     * @description Special Instructions */
    specialInstructions;
    /**
     * @type {string}
     * @description Destination entity legal name */
    destinationEntityLegalName;
    /**
     * @type {string}
     * @description Transferee mobile phone number */
    mobilePhoneNumber;
    /**
     * @type {string}
     * @description Transferee work phone number */
    workPhoneNumber;
    /**
     * @type {string}
     * @description Transferee home phone number */
    homePhoneNumber;
    /**
     * @type {string}
     * @description Transferee primary email */
    primaryEmail;
    /**
     * @type {string}
     * @description Transferee secondary email */
    secondaryEmail;
    /**
     * @type {string}
     * @description HR Contact First Name */
    hrContactFirstName;
    /**
     * @type {string}
     * @description HR Contact Last Name */
    hrContactLastName;
    /**
     * @type {string}
     * @description HR contact full name */
    hrContactFullName;
    /**
     * @type {string}
     * @description Transferee annual salary */
    annualSalary;
    /**
     * @type {SpousePartner}
     * @description Transferee spouse/partner */
    spousePartner;
    /**
     * @type {Dependent[]}
     * @description Transferee dependents */
    dependents;
    /**
     * @type {Service[]}
     * @description Assignment Services */
    services;
    /**
     * @type {string}
     * @description Relocation Status */
    relocationStatus;
    /**
     * @type {string}
     * @description Cancel */
    cancel;
}
export class TransfereeInitiationRequest {
    /** @param {{initiationInfo?:TransfereeInitiation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {TransfereeInitiation}
     * @description Transferee initiation info needed for creation. */
    initiationInfo;
}

JavaScript TransfereeInitiationRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<TransfereeInitiationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SIRVA.Relocation.Services.InitiationGateway.ServiceModel">
  <InitiationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/SIRVA.Relocation.Services.InitiationGateway.ServiceModel.Types">
    <d2p1:AnnualSalary>String</d2p1:AnnualSalary>
    <d2p1:AssignmentFamilySize>0</d2p1:AssignmentFamilySize>
    <d2p1:AssignmentType>String</d2p1:AssignmentType>
    <d2p1:Cancel>String</d2p1:Cancel>
    <d2p1:CitizenshipCountry>String</d2p1:CitizenshipCountry>
    <d2p1:ClientId>String</d2p1:ClientId>
    <d2p1:CompanyCodePrimary>String</d2p1:CompanyCodePrimary>
    <d2p1:CompanyCodeSecondary>String</d2p1:CompanyCodeSecondary>
    <d2p1:Confidential>false</d2p1:Confidential>
    <d2p1:CostCenterPrimary>String</d2p1:CostCenterPrimary>
    <d2p1:CostCenterSecondary>String</d2p1:CostCenterSecondary>
    <d2p1:CostCenterTertiary>String</d2p1:CostCenterTertiary>
    <d2p1:CustomFields>
      <d2p1:CustomField>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:FieldValue>String</d2p1:FieldValue>
      </d2p1:CustomField>
    </d2p1:CustomFields>
    <d2p1:Dependents>
      <d2p1:Dependent>
        <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:LastName>String</d2p1:LastName>
        <d2p1:RelationshipToAssignee>Child</d2p1:RelationshipToAssignee>
      </d2p1:Dependent>
    </d2p1:Dependents>
    <d2p1:DestinationEntityLegalName>String</d2p1:DestinationEntityLegalName>
    <d2p1:DestinationWorkLocation>
      <d2p1:City>String</d2p1:City>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:StateCode>String</d2p1:StateCode>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:DestinationWorkLocation>
    <d2p1:DualCitizenshipCountry>String</d2p1:DualCitizenshipCountry>
    <d2p1:EmployeeId>String</d2p1:EmployeeId>
    <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
    <d2p1:ExternalId>String</d2p1:ExternalId>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:HRContactFirstName>String</d2p1:HRContactFirstName>
    <d2p1:HRContactFullName>String</d2p1:HRContactFullName>
    <d2p1:HRContactLastName>String</d2p1:HRContactLastName>
    <d2p1:HomeOwnerStatus>Homeowner</d2p1:HomeOwnerStatus>
    <d2p1:HomePhoneNumber>String</d2p1:HomePhoneNumber>
    <d2p1:HostCurrency>String</d2p1:HostCurrency>
    <d2p1:JobTitle>String</d2p1:JobTitle>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:LineOfBusiness>String</d2p1:LineOfBusiness>
    <d2p1:MaritalStatus>Single</d2p1:MaritalStatus>
    <d2p1:MobilePhoneNumber>String</d2p1:MobilePhoneNumber>
    <d2p1:OriginHomeAddress>
      <d2p1:City>String</d2p1:City>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:StateCode>String</d2p1:StateCode>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Line1>String</d2p1:Line1>
      <d2p1:Line2>String</d2p1:Line2>
      <d2p1:Line3>String</d2p1:Line3>
      <d2p1:PostalCode>String</d2p1:PostalCode>
    </d2p1:OriginHomeAddress>
    <d2p1:OriginWorkLocation>
      <d2p1:City>String</d2p1:City>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:StateCode>String</d2p1:StateCode>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:OriginWorkLocation>
    <d2p1:PayGrade>String</d2p1:PayGrade>
    <d2p1:Policy>String</d2p1:Policy>
    <d2p1:PreDecision>false</d2p1:PreDecision>
    <d2p1:PrimaryEmail>String</d2p1:PrimaryEmail>
    <d2p1:RelocationStatus>String</d2p1:RelocationStatus>
    <d2p1:Repat>String</d2p1:Repat>
    <d2p1:RepatFromCity>String</d2p1:RepatFromCity>
    <d2p1:RepatFromCountryCode>String</d2p1:RepatFromCountryCode>
    <d2p1:RepatFromStateCode>String</d2p1:RepatFromStateCode>
    <d2p1:RepatToCity>String</d2p1:RepatToCity>
    <d2p1:RepatToCountryCode>String</d2p1:RepatToCountryCode>
    <d2p1:RepatToStateCode>String</d2p1:RepatToStateCode>
    <d2p1:SecondaryEmail>String</d2p1:SecondaryEmail>
    <d2p1:ServiceLevel>String</d2p1:ServiceLevel>
    <d2p1:Services>
      <d2p1:Service>
        <d2p1:Cancel>String</d2p1:Cancel>
        <d2p1:Data>
          <d2p1:ServiceData>
            <d2p1:FieldName>String</d2p1:FieldName>
            <d2p1:FieldValue>String</d2p1:FieldValue>
          </d2p1:ServiceData>
        </d2p1:Data>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Service>
    </d2p1:Services>
    <d2p1:SpecialInstructions>String</d2p1:SpecialInstructions>
    <d2p1:SpousePartner>
      <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
    </d2p1:SpousePartner>
    <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
    <d2p1:VIP>false</d2p1:VIP>
    <d2p1:WorkPhoneNumber>String</d2p1:WorkPhoneNumber>
  </InitiationInfo>
</TransfereeInitiationRequest>

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

<TransfereeInitiationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SIRVA.Relocation.Services.InitiationGateway.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</TransfereeInitiationResponse>