GET api/DSM/Client/{clientCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

WFSClient

Name	Type	Additional information
ClientId	integer	None.
ParentClientId	integer	None.
DSMClientCode	string	None.
ExternalCode	string	None.
ExternalParentCode	string	None.
Name	string	None.
DisplayName	string	None.
Description	string	None.
SearchProfileId	integer	None.
SystemModeId	integer	None.
IsActive	boolean	None.
IsDisabled	boolean	None.
ClientWorkSiteId	integer	None.
ClientWorkSiteExternalCode	string	None.
CreatedOn	date	None.
LastUpdatedOn	date	None.
CreatedBy	string	None.
LastUpdatedBy	string	None.
ClientShiftSetting	ClientShiftSetting	None.
ClientNotificationSetting	ClientNotificationSetting	None.
ClientTimesheetSetting	ClientTimesheetSetting	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "ParentClientId": 2,
  "DSMClientCode": "sample string 3",
  "ExternalCode": "sample string 4",
  "ExternalParentCode": "sample string 5",
  "Name": "sample string 6",
  "DisplayName": "sample string 7",
  "Description": "sample string 8",
  "SearchProfileId": 9,
  "SystemModeId": 10,
  "IsActive": true,
  "IsDisabled": true,
  "ClientWorkSiteId": 13,
  "ClientWorkSiteExternalCode": "sample string 14",
  "CreatedOn": "2024-06-29T07:36:13.4143316+10:00",
  "LastUpdatedOn": "2024-06-29T07:36:13.4143316+10:00",
  "CreatedBy": "sample string 17",
  "LastUpdatedBy": "sample string 18",
  "ClientShiftSetting": {
    "ClientShiftSettingId": 1,
    "ClientId": 2,
    "ShiftStartTime": "sample string 3",
    "ShiftEndTime": "sample string 4",
    "BreakDuration": 5,
    "WeekStartingDay": 6,
    "IsMaxHourPerWeek": true,
    "IsMaxHourPerShift": true,
    "MaxHourPerShift": 9,
    "MaxHourPerWeek": 10,
    "IsMaxHourPerDay": true,
    "MaxHourPerDay": 12,
    "IsMaxDayPerWeek": true,
    "MaxDayPerWeek": 14,
    "IsMaxHourPerFortnight": true,
    "MaxHourPerFortnight": 16,
    "IsMinHourPerShift": true,
    "MinHourPerShift": 18,
    "IsMaxWorkingDay": true,
    "MaxWorkingDay": 20,
    "IsOpenToAll": true,
    "OpenToAllInMins": 22,
    "ShiftNotificationsRecipient": "sample string 23"
  },
  "ClientNotificationSetting": {
    "ClientNotificationSettingId": 1,
    "ClientId": 2,
    "OnShiftAcceptedEmails": "sample string 3",
    "OnShiftRejectedEmails": "sample string 4",
    "OnShiftPublishedEmails": "sample string 5",
    "OnOpenShiftConversionEmails": "sample string 6",
    "OnShiftChangesEmails": "sample string 7",
    "OnShiftCancellationEmails": "sample string 8",
    "IsOpenAssignedShiftSMSRequired": true,
    "IsOnBookingConfirmationEmails": true
  },
  "ClientTimesheetSetting": {
    "ClientTimesheetSettingId": 1,
    "ClientId": 2,
    "IsTimeSheetEnabled": true,
    "IsAutoRound": true,
    "IsAutoRoundToStartTimeIfEarlier": true,
    "AutoRoundToStartTimeType": "sample string 6",
    "AutoRoundToStartTimeMins": 7,
    "MaxVarianceEndTimeMins": 8,
    "IsAutoRoundToEndTimeIfLater": true,
    "AutoRoundToEndTimeType": "sample string 10",
    "AutoRoundToEndTimeMins": 11,
    "StartShiftsEarlyMins": 12,
    "EndShiftEarlyMins": 13,
    "IsAutoApproveTimesheet": true,
    "AutoApproveVarianceMins": 15,
    "IsAutoRoundToBreakTimeIfShorter": true
  }
}

text/xml

Sample:

<WFSClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DSM">
  <ClientId>1</ClientId>
  <ClientNotificationSetting>
    <ClientId>2</ClientId>
    <ClientNotificationSettingId>1</ClientNotificationSettingId>
    <IsOnBookingConfirmationEmails>true</IsOnBookingConfirmationEmails>
    <IsOpenAssignedShiftSMSRequired>true</IsOpenAssignedShiftSMSRequired>
    <OnOpenShiftConversionEmails>sample string 6</OnOpenShiftConversionEmails>
    <OnShiftAcceptedEmails>sample string 3</OnShiftAcceptedEmails>
    <OnShiftCancellationEmails>sample string 8</OnShiftCancellationEmails>
    <OnShiftChangesEmails>sample string 7</OnShiftChangesEmails>
    <OnShiftPublishedEmails>sample string 5</OnShiftPublishedEmails>
    <OnShiftRejectedEmails>sample string 4</OnShiftRejectedEmails>
  </ClientNotificationSetting>
  <ClientShiftSetting>
    <BreakDuration>5</BreakDuration>
    <ClientId>2</ClientId>
    <ClientShiftSettingId>1</ClientShiftSettingId>
    <IsMaxDayPerWeek>true</IsMaxDayPerWeek>
    <IsMaxHourPerDay>true</IsMaxHourPerDay>
    <IsMaxHourPerFortnight>true</IsMaxHourPerFortnight>
    <IsMaxHourPerShift>true</IsMaxHourPerShift>
    <IsMaxHourPerWeek>true</IsMaxHourPerWeek>
    <IsMaxWorkingDay>true</IsMaxWorkingDay>
    <IsMinHourPerShift>true</IsMinHourPerShift>
    <IsOpenToAll>true</IsOpenToAll>
    <MaxDayPerWeek>14</MaxDayPerWeek>
    <MaxHourPerDay>12</MaxHourPerDay>
    <MaxHourPerFortnight>16</MaxHourPerFortnight>
    <MaxHourPerShift>9</MaxHourPerShift>
    <MaxHourPerWeek>10</MaxHourPerWeek>
    <MaxWorkingDay>20</MaxWorkingDay>
    <MinHourPerShift>18</MinHourPerShift>
    <OpenToAllInMins>22</OpenToAllInMins>
    <ShiftEndTime>sample string 4</ShiftEndTime>
    <ShiftNotificationsRecipient>sample string 23</ShiftNotificationsRecipient>
    <ShiftStartTime>sample string 3</ShiftStartTime>
    <WeekStartingDay>6</WeekStartingDay>
  </ClientShiftSetting>
  <ClientTimesheetSetting>
    <AutoApproveVarianceMins>15</AutoApproveVarianceMins>
    <AutoRoundToEndTimeMins>11</AutoRoundToEndTimeMins>
    <AutoRoundToEndTimeType>sample string 10</AutoRoundToEndTimeType>
    <AutoRoundToStartTimeMins>7</AutoRoundToStartTimeMins>
    <AutoRoundToStartTimeType>sample string 6</AutoRoundToStartTimeType>
    <ClientId>2</ClientId>
    <ClientTimesheetSettingId>1</ClientTimesheetSettingId>
    <EndShiftEarlyMins>13</EndShiftEarlyMins>
    <IsAutoApproveTimesheet>true</IsAutoApproveTimesheet>
    <IsAutoRound>true</IsAutoRound>
    <IsAutoRoundToBreakTimeIfShorter>true</IsAutoRoundToBreakTimeIfShorter>
    <IsAutoRoundToEndTimeIfLater>true</IsAutoRoundToEndTimeIfLater>
    <IsAutoRoundToStartTimeIfEarlier>true</IsAutoRoundToStartTimeIfEarlier>
    <IsTimeSheetEnabled>true</IsTimeSheetEnabled>
    <MaxVarianceEndTimeMins>8</MaxVarianceEndTimeMins>
    <StartShiftsEarlyMins>12</StartShiftsEarlyMins>
  </ClientTimesheetSetting>
  <ClientWorkSiteExternalCode>sample string 14</ClientWorkSiteExternalCode>
  <ClientWorkSiteId>13</ClientWorkSiteId>
  <CreatedBy>sample string 17</CreatedBy>
  <CreatedOn>2024-06-29T07:36:13.4143316+10:00</CreatedOn>
  <DSMClientCode>sample string 3</DSMClientCode>
  <Description>sample string 8</Description>
  <DisplayName>sample string 7</DisplayName>
  <ExternalCode>sample string 4</ExternalCode>
  <ExternalParentCode>sample string 5</ExternalParentCode>
  <IsActive>true</IsActive>
  <IsDisabled>true</IsDisabled>
  <LastUpdatedBy>sample string 18</LastUpdatedBy>
  <LastUpdatedOn>2024-06-29T07:36:13.4143316+10:00</LastUpdatedOn>
  <Name>sample string 6</Name>
  <ParentClientId>2</ParentClientId>
  <SearchProfileId>9</SearchProfileId>
  <SystemModeId>10</SystemModeId>
</WFSClient>

multipart/form-data

Sample:

<WFSClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DSM"><ClientId>1</ClientId><ClientNotificationSetting><ClientId>2</ClientId><ClientNotificationSettingId>1</ClientNotificationSettingId><IsOnBookingConfirmationEmails>true</IsOnBookingConfirmationEmails><IsOpenAssignedShiftSMSRequired>true</IsOpenAssignedShiftSMSRequired><OnOpenShiftConversionEmails>sample string 6</OnOpenShiftConversionEmails><OnShiftAcceptedEmails>sample string 3</OnShiftAcceptedEmails><OnShiftCancellationEmails>sample string 8</OnShiftCancellationEmails><OnShiftChangesEmails>sample string 7</OnShiftChangesEmails><OnShiftPublishedEmails>sample string 5</OnShiftPublishedEmails><OnShiftRejectedEmails>sample string 4</OnShiftRejectedEmails></ClientNotificationSetting><ClientShiftSetting><BreakDuration>5</BreakDuration><ClientId>2</ClientId><ClientShiftSettingId>1</ClientShiftSettingId><IsMaxDayPerWeek>true</IsMaxDayPerWeek><IsMaxHourPerDay>true</IsMaxHourPerDay><IsMaxHourPerFortnight>true</IsMaxHourPerFortnight><IsMaxHourPerShift>true</IsMaxHourPerShift><IsMaxHourPerWeek>true</IsMaxHourPerWeek><IsMaxWorkingDay>true</IsMaxWorkingDay><IsMinHourPerShift>true</IsMinHourPerShift><IsOpenToAll>true</IsOpenToAll><MaxDayPerWeek>14</MaxDayPerWeek><MaxHourPerDay>12</MaxHourPerDay><MaxHourPerFortnight>16</MaxHourPerFortnight><MaxHourPerShift>9</MaxHourPerShift><MaxHourPerWeek>10</MaxHourPerWeek><MaxWorkingDay>20</MaxWorkingDay><MinHourPerShift>18</MinHourPerShift><OpenToAllInMins>22</OpenToAllInMins><ShiftEndTime>sample string 4</ShiftEndTime><ShiftNotificationsRecipient>sample string 23</ShiftNotificationsRecipient><ShiftStartTime>sample string 3</ShiftStartTime><WeekStartingDay>6</WeekStartingDay></ClientShiftSetting><ClientTimesheetSetting><AutoApproveVarianceMins>15</AutoApproveVarianceMins><AutoRoundToEndTimeMins>11</AutoRoundToEndTimeMins><AutoRoundToEndTimeType>sample string 10</AutoRoundToEndTimeType><AutoRoundToStartTimeMins>7</AutoRoundToStartTimeMins><AutoRoundToStartTimeType>sample string 6</AutoRoundToStartTimeType><ClientId>2</ClientId><ClientTimesheetSettingId>1</ClientTimesheetSettingId><EndShiftEarlyMins>13</EndShiftEarlyMins><IsAutoApproveTimesheet>true</IsAutoApproveTimesheet><IsAutoRound>true</IsAutoRound><IsAutoRoundToBreakTimeIfShorter>true</IsAutoRoundToBreakTimeIfShorter><IsAutoRoundToEndTimeIfLater>true</IsAutoRoundToEndTimeIfLater><IsAutoRoundToStartTimeIfEarlier>true</IsAutoRoundToStartTimeIfEarlier><IsTimeSheetEnabled>true</IsTimeSheetEnabled><MaxVarianceEndTimeMins>8</MaxVarianceEndTimeMins><StartShiftsEarlyMins>12</StartShiftsEarlyMins></ClientTimesheetSetting><ClientWorkSiteExternalCode>sample string 14</ClientWorkSiteExternalCode><ClientWorkSiteId>13</ClientWorkSiteId><CreatedBy>sample string 17</CreatedBy><CreatedOn>2024-06-29T07:36:13.4143316+10:00</CreatedOn><DSMClientCode>sample string 3</DSMClientCode><Description>sample string 8</Description><DisplayName>sample string 7</DisplayName><ExternalCode>sample string 4</ExternalCode><ExternalParentCode>sample string 5</ExternalParentCode><IsActive>true</IsActive><IsDisabled>true</IsDisabled><LastUpdatedBy>sample string 18</LastUpdatedBy><LastUpdatedOn>2024-06-29T07:36:13.4143316+10:00</LastUpdatedOn><Name>sample string 6</Name><ParentClientId>2</ParentClientId><SearchProfileId>9</SearchProfileId><SystemModeId>10</SystemModeId></WFSClient>