Client_Initiations

<back to all web services

ConsumerInitiation

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

export class ConsumerInitiation implements IPost
{
    /** @description First name of the consumer */
    // @ApiMember(Description="First name of the consumer", IsRequired=true)
    public FirstName: string;

    /** @description Last name of the consumer */
    // @ApiMember(Description="Last name of the consumer", IsRequired=true)
    public LastName: string;

    /** @description Program name */
    // @ApiMember(Description="Program name", IsRequired=true)
    public Program: string;

    /** @description Company name */
    // @ApiMember(Description="Company name", IsRequired=true)
    public CompanyName: string;

    /** @description Mobile phone number */
    // @ApiMember(Description="Mobile phone number")
    public MobileNumber: string;

    /** @description Preferred email address */
    // @ApiMember(Description="Preferred email address", IsRequired=true)
    public PreferredEmail: string;

    /** @description Current work location state */
    // @ApiMember(Description="Current work location state")
    public CurrentWorkState: string;

    /** @description Current work location country */
    // @ApiMember(Description="Current work location country")
    public CurrentWorkCountry: string;

    /** @description Destination work location state */
    // @ApiMember(Description="Destination work location state")
    public DestinationWorkState: string;

    /** @description Destination work location country */
    // @ApiMember(Description="Destination work location country")
    public DestinationWorkCountry: string;

    /** @description Preferred work location state */
    // @ApiMember(Description="Preferred work location state")
    public PreferredWorkState: string;

    /** @description Preferred work location country */
    // @ApiMember(Description="Preferred work location country")
    public PreferredWorkCountry: string;

    public constructor(init?: Partial<ConsumerInitiation>) { (Object as any).assign(this, init); }
}

TypeScript ConsumerInitiation 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 /consumerinitiation HTTP/1.1 
Host: initiation-test.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ConsumerInitiation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel">
  <CompanyName>String</CompanyName>
  <CurrentWorkCountry>String</CurrentWorkCountry>
  <CurrentWorkState>String</CurrentWorkState>
  <DestinationWorkCountry>String</DestinationWorkCountry>
  <DestinationWorkState>String</DestinationWorkState>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <MobileNumber>String</MobileNumber>
  <PreferredEmail>String</PreferredEmail>
  <PreferredWorkCountry>String</PreferredWorkCountry>
  <PreferredWorkState>String</PreferredWorkState>
  <Program>String</Program>
</ConsumerInitiation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />