Client_Initiations

ConsumerInitiation

Consumer Initiation Service

The following routes are available for this service:
POST	/consumerinitiation

**ConsumerInitiation** Parameters:
Name	Parameter	Data Type	Required	Description
ClientID	body	string	Yes	Client identifier
File	body	RelocationsRequestFile	Yes	Consumer relocation request file details

**RelocationsRequestFile** Parameters:
Name	Parameter	Data Type	Required	Description
Command	form	string	Yes	Command type for the request (INITIATE)
ExternalID	form	string	Yes	External identifier for the transferee
TransfereeDetails	form	RelocationsRequestFileTransfereeDetails	Yes	Details about the transferee
Addresses	form	RelocationsRequestFileAddress[]	Yes	List of addresses associated with the transferee
Phones	form	RelocationsRequestFilePhone[]	Yes	List of phone numbers associated with the transferee
AssignmentDetails	form	RelocationsRequestFileAssignmentDetails	Yes	Assignment details for the relocation

**RelocationsRequestFileTransfereeDetails** Parameters:
Name	Parameter	Data Type	Required	Description
FirstName	form	string	Yes	First name of the transferee
LastName	form	string	Yes	Last name of the transferee
PreferredEmail	form	string	Yes	Preferred email address

**RelocationsRequestFileAddress** Parameters:
Name	Parameter	Data Type	Required	Description
AddressType	form	AddressType	Yes	Type of address (CurrentHome, DestinationHome, CurrentWork, DestinationWork)
Primary	form	YesNo	Yes	Indicates if this is the primary address
AddressLine1	form	string	Yes	Address line 1
City	form	string	Yes	City
Country	form	string	Yes	Country

**AddressType** Enum:
CurrentHome
DestinationHome
CurrentWork
DestinationWork

**YesNo** Enum:
Y
N
Item

**RelocationsRequestFilePhone** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	Yes	Phone type (e.g., Mobile, OriginHome)
Primary	form	YesNo	Yes	Indicates if this is the primary phone number
Number	form	string	Yes	Phone number

**RelocationsRequestFileAssignmentDetails** Parameters:
Name	Parameter	Data Type	Required	Description
Program	form	string	Yes	Program name or code
AssignmentType	form	string	Yes	Type of assignment
StartDate	form	DateTime?	Yes	Assignment start date
CompanyName	form	string	Yes	Company name
Contact	form	string	Yes	Contact
Current	form	AssignmentLocationDetails	Yes	Current assignment location details
Destination	form	AssignmentLocationDetails	Yes	Destination assignment location details

**AssignmentLocationDetails** Parameters:
Name	Parameter	Data Type	Required	Description
WorkCity	form	string	Yes	Work city
CurrentWorkState	form	string	No	Current work location state
WorkState	form	string	No	Work state or province
DestinationWorkState	form	string	No	Destination work location state
WorkCountry	form	string	Yes	Work country
PreferredWorkState	form	string	No	Preferred work location state
PreferredWorkCountry	form	string	No	Preferred work location country

**ConsumerInitiationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Message	form	string	No	Response message
FileId	form	string	No	File identifier for the created initiation
Errors	form	List<ValidateError>	No	List of validation errors, if any

**ValidateError** Parameters:
Name	Parameter	Data Type	Required	Description
ErrorNumber	form	string	No
ErrorDescription	form	string	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 /consumerinitiation HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientID: String,
	File: 
	{
		Command: String,
		ExternalID: String,
		TransfereeDetails: 
		{
			FirstName: String,
			LastName: String,
			PreferredEmail: String
		},
		Addresses: 
		[
			{
				AddressType: CurrentHome,
				Primary: Y,
				AddressLine1: String,
				City: String,
				Country: String
			}
		],
		Phones: 
		[
			{
				Type: String,
				Primary: Y,
				Number: String
			}
		],
		AssignmentDetails: 
		{
			Program: String,
			AssignmentType: String,
			StartDate: 0001-01-01,
			CompanyName: String,
			Contact: String,
			Current: 
			{
				WorkCity: String,
				CurrentWorkState: String,
				WorkState: String,
				DestinationWorkState: String,
				WorkCountry: String,
				PreferredWorkState: String,
				PreferredWorkCountry: String
			},
			Destination: 
			{
				WorkCity: String,
				CurrentWorkState: String,
				WorkState: String,
				DestinationWorkState: String,
				WorkCountry: String,
				PreferredWorkState: String,
				PreferredWorkCountry: String
			}
		}
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Message: String,
	FileId: String,
	Errors: 
	[
		{
			ErrorNumber: String,
			ErrorDescription: String
		}
	]
}