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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SIRVA.Relocation.Services.InitiationGateway.ServiceModel
Imports SIRVA.Relocation.Services.InitiationGateway.ServiceModel.Types

Namespace Global

    Namespace SIRVA.Relocation.Services.InitiationGateway.ServiceModel

        Public Partial Class TransfereeInitiationRequest
            Implements IRequireClientScoped
            Implements IPost
            '''<Summary>
            '''Transferee initiation info needed for creation.
            '''</Summary>
            <ApiMember(Description:="Transferee initiation info needed for creation.", IsRequired:=true, ParameterType:="body")>
            Public Overridable Property InitiationInfo As TransfereeInitiation
        End Class

        Public Partial Class TransfereeInitiationResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace SIRVA.Relocation.Services.InitiationGateway.ServiceModel.Types

        Public Partial Class Address
            Inherits Location
            Public Overridable Property Line1 As String
            Public Overridable Property Line2 As String
            Public Overridable Property Line3 As String
            Public Overridable Property PostalCode As String
        End Class

        Public Partial Class CustomField
            '''<Summary>
            '''Custom field name
            '''</Summary>
            <ApiMember(Description:="Custom field name", IsRequired:=true)>
            Public Overridable Property FieldName As String

            '''<Summary>
            '''Custom field value
            '''</Summary>
            <ApiMember(Description:="Custom field value")>
            Public Overridable Property FieldValue As String
        End Class

        Public Partial Class Dependent
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property BirthDate As Nullable(Of Date)
            <ApiMember(IsRequired:=true, Name:="RelationshipToAssignee")>
            Public Overridable Property RelationshipToAssignee As Nullable(Of DependentAssigneeRelationship)
        End Class

        Public Enum DependentAssigneeRelationship
            Child
            Other
        End Enum

        Public Enum HomeOwnerStatus
            Homeowner
            Renter
        End Enum

        Public Partial Class Location
            Public Overridable Property Title As String
            Public Overridable Property City As String
            Public Overridable Property StateCode As String
            Public Overridable Property CountryCode As String
        End Class

        Public Enum MaritalStatus
            Single
            Married
            DomesticPartner
            Divorcee
            Defacto
            Other
            Separated
            Interdependent
            Widowed
            Divorced
        End Enum

        Public Partial Class Service
            Public Sub New()
                Data = New List(Of ServiceData)
            End Sub

            '''<Summary>
            '''Service name
            '''</Summary>
            <ApiMember(Description:="Service name", IsRequired:=true)>
            Public Overridable Property Name As String

            '''<Summary>
            '''Service data
            '''</Summary>
            <ApiMember(Description:="Service data")>
            Public Overridable Property Data As List(Of ServiceData)

            '''<Summary>
            '''Cancel
            '''</Summary>
            <ApiMember(Description:="Cancel")>
            Public Overridable Property Cancel As String
        End Class

        Public Partial Class ServiceData
            '''<Summary>
            '''Service data field name
            '''</Summary>
            <ApiMember(Description:="Service data field name", IsRequired:=true)>
            Public Overridable Property FieldName As String

            '''<Summary>
            '''Service data field value
            '''</Summary>
            <ApiMember(Description:="Service data field value", IsRequired:=true)>
            Public Overridable Property FieldValue As String
        End Class

        Public Partial Class SpousePartner
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property BirthDate As Nullable(Of Date)
        End Class

        Public Partial Class TransfereeInitiation
            Public Sub New()
                CustomFields = New List(Of CustomField)
                Dependents = New List(Of Dependent)
                Services = New List(Of Service)
            End Sub

            '''<Summary>
            '''Client ID
            '''</Summary>
            <ApiMember(Description:="Client ID")>
            Public Overridable Property ClientId As String

            '''<Summary>
            '''External ID. This must be unique to the intiation's parent client
            '''</Summary>
            <ApiMember(Description:="External ID. This must be unique to the intiation's parent client", IsRequired:=true)>
            Public Overridable Property ExternalId As String

            '''<Summary>
            '''Transferee first name
            '''</Summary>
            <ApiMember(Description:="Transferee first name", IsRequired:=true)>
            Public Overridable Property FirstName As String

            '''<Summary>
            '''Transferee last name
            '''</Summary>
            <ApiMember(Description:="Transferee last name", IsRequired:=true)>
            Public Overridable Property LastName As String

            '''<Summary>
            '''Assignment type
            '''</Summary>
            <ApiMember(Description:="Assignment type")>
            Public Overridable Property AssignmentType As String

            '''<Summary>
            '''Is this transferee pre-decision
            '''</Summary>
            <ApiMember(Description:="Is this transferee pre-decision")>
            Public Overridable Property PreDecision As Nullable(Of Boolean)

            '''<Summary>
            '''Is this transferee a VIP
            '''</Summary>
            <ApiMember(Description:="Is this transferee a VIP")>
            Public Overridable Property VIP As Nullable(Of Boolean)

            '''<Summary>
            '''Custom fields
            '''</Summary>
            <ApiMember(Description:="Custom fields")>
            Public Overridable Property CustomFields As List(Of CustomField)

            '''<Summary>
            '''Employee ID
            '''</Summary>
            <ApiMember(Description:="Employee ID")>
            Public Overridable Property EmployeeId As String

            '''<Summary>
            '''Start date
            '''</Summary>
            <ApiMember(Description:="Start date")>
            Public Overridable Property StartDate As Nullable(Of Date)

            '''<Summary>
            '''End date
            '''</Summary>
            <ApiMember(Description:="End date")>
            Public Overridable Property EndDate As Nullable(Of Date)

            '''<Summary>
            '''Origin work location
            '''</Summary>
            <ApiMember(Description:="Origin work location", IsRequired:=true)>
            Public Overridable Property OriginWorkLocation As Location

            '''<Summary>
            '''Origin home address
            '''</Summary>
            <ApiMember(Description:="Origin home address", IsRequired:=true)>
            Public Overridable Property OriginHomeAddress As Address

            '''<Summary>
            '''Destination work location
            '''</Summary>
            <ApiMember(Description:="Destination work location", IsRequired:=true)>
            Public Overridable Property DestinationWorkLocation As Location

            '''<Summary>
            '''Repat
            '''</Summary>
            <ApiMember(Description:="Repat")>
            Public Overridable Property Repat As String

            '''<Summary>
            '''Repat From City
            '''</Summary>
            <ApiMember(Description:="Repat From City")>
            Public Overridable Property RepatFromCity As String

            '''<Summary>
            '''Repat From State code
            '''</Summary>
            <ApiMember(Description:="Repat From State code")>
            Public Overridable Property RepatFromStateCode As String

            '''<Summary>
            '''Repat From Country Code
            '''</Summary>
            <ApiMember(Description:="Repat From Country Code")>
            Public Overridable Property RepatFromCountryCode As String

            '''<Summary>
            '''Repat To City
            '''</Summary>
            <ApiMember(Description:="Repat To City")>
            Public Overridable Property RepatToCity As String

            '''<Summary>
            '''Repat To State Code
            '''</Summary>
            <ApiMember(Description:="Repat To State Code")>
            Public Overridable Property RepatToStateCode As String

            '''<Summary>
            '''Repat To Country Code
            '''</Summary>
            <ApiMember(Description:="Repat To Country Code")>
            Public Overridable Property RepatToCountryCode As String

            '''<Summary>
            '''Transferee citizenship country
            '''</Summary>
            <ApiMember(Description:="Transferee citizenship country")>
            Public Overridable Property CitizenshipCountry As String

            '''<Summary>
            '''Transferee dual citizenship country
            '''</Summary>
            <ApiMember(Description:="Transferee dual citizenship country")>
            Public Overridable Property DualCitizenshipCountry As String

            '''<Summary>
            '''Policy
            '''</Summary>
            <ApiMember(Description:="Policy", IsRequired:=true)>
            Public Overridable Property Policy As String

            '''<Summary>
            '''Job title
            '''</Summary>
            <ApiMember(Description:="Job title")>
            Public Overridable Property JobTitle As String

            '''<Summary>
            '''Marital status
            '''</Summary>
            <ApiMember(Description:="Marital status", Name:="MaritalStatus")>
            Public Overridable Property MaritalStatus As Nullable(Of MaritalStatus)

            '''<Summary>
            '''Pay grade
            '''</Summary>
            <ApiMember(Description:="Pay grade")>
            Public Overridable Property PayGrade As String

            '''<Summary>
            '''Assignment family size
            '''</Summary>
            <ApiMember(Description:="Assignment family size")>
            Public Overridable Property AssignmentFamilySize As Nullable(Of Integer)

            '''<Summary>
            '''Home owner status
            '''</Summary>
            <ApiMember(Description:="Home owner status", Name:="HomeOwnerStatus")>
            Public Overridable Property HomeOwnerStatus As Nullable(Of HomeOwnerStatus)

            '''<Summary>
            '''Line of business
            '''</Summary>
            <ApiMember(Description:="Line of business", IsRequired:=true)>
            Public Overridable Property LineOfBusiness As String

            '''<Summary>
            '''HostCurrency
            '''</Summary>
            <ApiMember(Description:="HostCurrency")>
            Public Overridable Property HostCurrency As String

            '''<Summary>
            '''ServiceLevel
            '''</Summary>
            <ApiMember(Description:="ServiceLevel")>
            Public Overridable Property ServiceLevel As String

            '''<Summary>
            '''CompanyCodePrimary
            '''</Summary>
            <ApiMember(Description:="CompanyCodePrimary")>
            Public Overridable Property CompanyCodePrimary As String

            '''<Summary>
            '''CompanyCodeSecondary
            '''</Summary>
            <ApiMember(Description:="CompanyCodeSecondary")>
            Public Overridable Property CompanyCodeSecondary As String

            '''<Summary>
            '''CostCenterPrimary
            '''</Summary>
            <ApiMember(Description:="CostCenterPrimary")>
            Public Overridable Property CostCenterPrimary As String

            '''<Summary>
            '''CostCenterSecondary
            '''</Summary>
            <ApiMember(Description:="CostCenterSecondary")>
            Public Overridable Property CostCenterSecondary As String

            '''<Summary>
            '''CostCenterTertiary
            '''</Summary>
            <ApiMember(Description:="CostCenterTertiary")>
            Public Overridable Property CostCenterTertiary As String

            '''<Summary>
            '''Is the assignment confidential
            '''</Summary>
            <ApiMember(Description:="Is the assignment confidential")>
            Public Overridable Property Confidential As Nullable(Of Boolean)

            '''<Summary>
            '''Special Instructions
            '''</Summary>
            <ApiMember(Description:="Special Instructions")>
            Public Overridable Property SpecialInstructions As String

            '''<Summary>
            '''Destination entity legal name
            '''</Summary>
            <ApiMember(Description:="Destination entity legal name")>
            Public Overridable Property DestinationEntityLegalName As String

            '''<Summary>
            '''Transferee mobile phone number
            '''</Summary>
            <ApiMember(Description:="Transferee mobile phone number", IsRequired:=true)>
            Public Overridable Property MobilePhoneNumber As String

            '''<Summary>
            '''Transferee work phone number
            '''</Summary>
            <ApiMember(Description:="Transferee work phone number")>
            Public Overridable Property WorkPhoneNumber As String

            '''<Summary>
            '''Transferee home phone number
            '''</Summary>
            <ApiMember(Description:="Transferee home phone number")>
            Public Overridable Property HomePhoneNumber As String

            '''<Summary>
            '''Transferee primary email
            '''</Summary>
            <ApiMember(Description:="Transferee primary email", IsRequired:=true)>
            Public Overridable Property PrimaryEmail As String

            '''<Summary>
            '''Transferee secondary email
            '''</Summary>
            <ApiMember(Description:="Transferee secondary email")>
            Public Overridable Property SecondaryEmail As String

            '''<Summary>
            '''HR Contact First Name
            '''</Summary>
            <ApiMember(Description:="HR Contact First Name")>
            Public Overridable Property HRContactFirstName As String

            '''<Summary>
            '''HR Contact Last Name
            '''</Summary>
            <ApiMember(Description:="HR Contact Last Name")>
            Public Overridable Property HRContactLastName As String

            '''<Summary>
            '''HR contact full name
            '''</Summary>
            <ApiMember(Description:="HR contact full name")>
            Public Overridable Property HRContactFullName As String

            '''<Summary>
            '''Transferee annual salary
            '''</Summary>
            <ApiMember(Description:="Transferee annual salary")>
            Public Overridable Property AnnualSalary As String

            '''<Summary>
            '''Transferee spouse/partner
            '''</Summary>
            <ApiMember(Description:="Transferee spouse/partner")>
            Public Overridable Property SpousePartner As SpousePartner

            '''<Summary>
            '''Transferee dependents
            '''</Summary>
            <ApiMember(Description:="Transferee dependents")>
            Public Overridable Property Dependents As List(Of Dependent)

            '''<Summary>
            '''Assignment Services
            '''</Summary>
            <ApiMember(Description:="Assignment Services")>
            Public Overridable Property Services As List(Of Service)

            '''<Summary>
            '''Relocation Status
            '''</Summary>
            <ApiMember(Description:="Relocation Status")>
            Public Overridable Property RelocationStatus As String

            '''<Summary>
            '''Cancel
            '''</Summary>
            <ApiMember(Description:="Cancel")>
            Public Overridable Property Cancel As String
        End Class
    End Namespace
End Namespace

VB.NET TransfereeInitiationRequest DTOs

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-pen.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"}}}