POST api/Account

Used to login and get a token which can be used for all requests in the API

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Username	This is the Username Given to you by Randstad	string	Required
Password	This is the your Password	string	Required
Service	This is the Service you would like access to eg MobileTimesheets	string	Required

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "Service": "sample string 3"
}

text/xml

Sample:

<LoginDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <Password>sample string 2</Password>
  <Service>sample string 3</Service>
  <Username>sample string 1</Username>
</LoginDTO>

multipart/form-data

Sample:

<LoginDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><Password>sample string 2</Password><Service>sample string 3</Service><Username>sample string 1</Username></LoginDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

COMPLETE

UserDTO

Name	Description	Type	Additional information
Token	This is the Token given to you by the API	string	None.
FirstName	This is the First Name of the logged in user	string	None.
LastName	This is the Surname Name of the logged in user	string	None.
Version	This is the Version of application you should be using	string	None.
DownloadUrl	This is where you can download the latest application	string	None.
Expires	This is when your token will expire	date	None.
Modules	This is the list of Modules applicable to this user	Collection of UserModuleDTO	None.
Roles	This is the list of roles allowed for this user	Collection of UserRoleDTO	None.
Role	Current user role used in this session	string	None.
RoleId	Current user role id used in this session	integer	None.
Email	User email ID	string	None.
Country	User country	string	None.
IsImpersonatedSession	If this is impersonation session taking place between consultant and client/candidate	boolean	None.
Impersonation	Impersonation session related data	UserImpersonation	None.
ShowAvailability	Whether Availability is displayed to user	boolean	None.
ServiceProviderToken		ServiceProviderToken	None.

Response Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Version": "sample string 4",
  "DownloadUrl": "sample string 5",
  "Expires": "2024-06-26T11:17:20.8562829+10:00",
  "Modules": [
    {
      "Version": "sample string 1",
      "Name": "sample string 2",
      "ActionCode": "sample string 3"
    },
    {
      "Version": "sample string 1",
      "Name": "sample string 2",
      "ActionCode": "sample string 3"
    }
  ],
  "Roles": [
    {
      "RoleId": 1,
      "RoleName": "sample string 2"
    },
    {
      "RoleId": 1,
      "RoleName": "sample string 2"
    }
  ],
  "Role": "sample string 6",
  "RoleId": 7,
  "Email": "sample string 8",
  "Country": "sample string 9",
  "IsImpersonatedSession": true,
  "Impersonation": {
    "ImpersonatedEmail": "sample string 1",
    "ImpersonatedFirstName": "sample string 2",
    "ImpersonatedLastName": "sample string 3",
    "ImpersonatedRoles": [
      {
        "RoleId": 1,
        "RoleName": "sample string 2"
      },
      {
        "RoleId": 1,
        "RoleName": "sample string 2"
      }
    ],
    "ImpersonatedRole": "sample string 4",
    "ImpersonatedRoleId": 5,
    "ImpersonatedModules": [
      {
        "Version": "sample string 1",
        "Name": "sample string 2",
        "ActionCode": "sample string 3"
      },
      {
        "Version": "sample string 1",
        "Name": "sample string 2",
        "ActionCode": "sample string 3"
      }
    ],
    "ImpersonatedCountry": "sample string 6"
  },
  "ShowAvailability": true,
  "ServiceProviderToken": {
    "AuthenticationResult": {
      "AccessToken": "sample string 1",
      "IdToken": "sample string 2",
      "RefreshToken": "sample string 3",
      "TokenType": "sample string 4",
      "ExpiresIn": 5
    }
  }
}

text/xml

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <Country>sample string 9</Country>
  <DownloadUrl>sample string 5</DownloadUrl>
  <Email>sample string 8</Email>
  <Expires>2024-06-26T11:17:20.8562829+10:00</Expires>
  <FirstName>sample string 2</FirstName>
  <Impersonation>
    <ImpersonatedCountry>sample string 6</ImpersonatedCountry>
    <ImpersonatedEmail>sample string 1</ImpersonatedEmail>
    <ImpersonatedFirstName>sample string 2</ImpersonatedFirstName>
    <ImpersonatedLastName>sample string 3</ImpersonatedLastName>
    <ImpersonatedModules>
      <UserModuleDTO>
        <ActionCode>sample string 3</ActionCode>
        <Name>sample string 2</Name>
        <Version>sample string 1</Version>
      </UserModuleDTO>
      <UserModuleDTO>
        <ActionCode>sample string 3</ActionCode>
        <Name>sample string 2</Name>
        <Version>sample string 1</Version>
      </UserModuleDTO>
    </ImpersonatedModules>
    <ImpersonatedRole>sample string 4</ImpersonatedRole>
    <ImpersonatedRoleId>5</ImpersonatedRoleId>
    <ImpersonatedRoles>
      <UserRoleDTO>
        <RoleId>1</RoleId>
        <RoleName>sample string 2</RoleName>
      </UserRoleDTO>
      <UserRoleDTO>
        <RoleId>1</RoleId>
        <RoleName>sample string 2</RoleName>
      </UserRoleDTO>
    </ImpersonatedRoles>
  </Impersonation>
  <IsImpersonatedSession>true</IsImpersonatedSession>
  <LastName>sample string 3</LastName>
  <Modules>
    <UserModuleDTO>
      <ActionCode>sample string 3</ActionCode>
      <Name>sample string 2</Name>
      <Version>sample string 1</Version>
    </UserModuleDTO>
    <UserModuleDTO>
      <ActionCode>sample string 3</ActionCode>
      <Name>sample string 2</Name>
      <Version>sample string 1</Version>
    </UserModuleDTO>
  </Modules>
  <Role>sample string 6</Role>
  <RoleId>7</RoleId>
  <Roles>
    <UserRoleDTO>
      <RoleId>1</RoleId>
      <RoleName>sample string 2</RoleName>
    </UserRoleDTO>
    <UserRoleDTO>
      <RoleId>1</RoleId>
      <RoleName>sample string 2</RoleName>
    </UserRoleDTO>
  </Roles>
  <ServiceProviderToken>
    <AuthenticationResult>
      <AccessToken>sample string 1</AccessToken>
      <ExpiresIn>5</ExpiresIn>
      <IdToken>sample string 2</IdToken>
      <RefreshToken>sample string 3</RefreshToken>
      <TokenType>sample string 4</TokenType>
    </AuthenticationResult>
  </ServiceProviderToken>
  <ShowAvailability>true</ShowAvailability>
  <Token>sample string 1</Token>
  <Version>sample string 4</Version>
</UserDTO>

multipart/form-data

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><Country>sample string 9</Country><DownloadUrl>sample string 5</DownloadUrl><Email>sample string 8</Email><Expires>2024-06-26T11:17:20.8562829+10:00</Expires><FirstName>sample string 2</FirstName><Impersonation><ImpersonatedCountry>sample string 6</ImpersonatedCountry><ImpersonatedEmail>sample string 1</ImpersonatedEmail><ImpersonatedFirstName>sample string 2</ImpersonatedFirstName><ImpersonatedLastName>sample string 3</ImpersonatedLastName><ImpersonatedModules><UserModuleDTO><ActionCode>sample string 3</ActionCode><Name>sample string 2</Name><Version>sample string 1</Version></UserModuleDTO><UserModuleDTO><ActionCode>sample string 3</ActionCode><Name>sample string 2</Name><Version>sample string 1</Version></UserModuleDTO></ImpersonatedModules><ImpersonatedRole>sample string 4</ImpersonatedRole><ImpersonatedRoleId>5</ImpersonatedRoleId><ImpersonatedRoles><UserRoleDTO><RoleId>1</RoleId><RoleName>sample string 2</RoleName></UserRoleDTO><UserRoleDTO><RoleId>1</RoleId><RoleName>sample string 2</RoleName></UserRoleDTO></ImpersonatedRoles></Impersonation><IsImpersonatedSession>true</IsImpersonatedSession><LastName>sample string 3</LastName><Modules><UserModuleDTO><ActionCode>sample string 3</ActionCode><Name>sample string 2</Name><Version>sample string 1</Version></UserModuleDTO><UserModuleDTO><ActionCode>sample string 3</ActionCode><Name>sample string 2</Name><Version>sample string 1</Version></UserModuleDTO></Modules><Role>sample string 6</Role><RoleId>7</RoleId><Roles><UserRoleDTO><RoleId>1</RoleId><RoleName>sample string 2</RoleName></UserRoleDTO><UserRoleDTO><RoleId>1</RoleId><RoleName>sample string 2</RoleName></UserRoleDTO></Roles><ServiceProviderToken><AuthenticationResult><AccessToken>sample string 1</AccessToken><ExpiresIn>5</ExpiresIn><IdToken>sample string 2</IdToken><RefreshToken>sample string 3</RefreshToken><TokenType>sample string 4</TokenType></AuthenticationResult></ServiceProviderToken><ShowAvailability>true</ShowAvailability><Token>sample string 1</Token><Version>sample string 4</Version></UserDTO>