Added Get-WorkdayWorkerPhoto.

Author: treestryder

source/WorkdayApi.psd1

@@ -3,7 +3,7 @@
     ModuleVersion = '2.3.0'
     HelpInfoURI = 'https://github.com/treestryder/powershell_module_workdayapi/wiki'
     Author = 'Nathan Hartley'
-    Copyright = '(c) 2019 Nathan Hartley. All rights reserved.'
+    Copyright = '(c) 2020 Nathan Hartley. All rights reserved.'
     RootModule = 'WorkdayApi.psm1'
     PowerShellVersion = '5.1'
     CompatiblePSEditions = @('Desktop', 'Core')
@@ -12,7 +12,11 @@
             Tags = @('Workday')
             LicenseUri = 'https://github.com/treestryder/powershell_module_workdayapi/blob/master/source/License.txt'
             ProjectUri = 'https://github.com/treestryder/powershell_module_workdayapi/'
-            ReleaseNotes = 'Inital release to the Powershell Gallery.'
+            ReleaseNotes = @'
+ * Added Get-WorkdayWorkerPhoto for getting worker's photo.
+
+Change log available at: https://github.com/treestryder/powershell_module_workdayapi/blob/master/CHANGELOG.md 
+'@
         }
     }
     FunctionsToExport = @(

source/public/Get-WorkdayWorkerPhoto.ps1

@@ -13,8 +13,13 @@ function Get-WorkdayWorkerPhoto {
     The type of ID that the WorkerId represents. Valid values
     are 'WID', 'Contingent_Worker_ID' and 'Employee_ID'.
 
+.PARAMETER Path
+    Path to save the photo. If Path is to a directory, the file name from Workday will be appened.
+    If no Path is specified, a PsCustomObject is returned containing the file name and byte array.
+
 .PARAMETER Passthru
     Outputs Invoke-WorkdayRequest object, rather than a custom Worker object.
+    If desired, the Base 64 encoded image and file name can be aquired from the XML.
 
 .PARAMETER Human_ResourcesUri
     Human_Resources Endpoint Uri for the request. If not provided, the value
@@ -30,7 +35,12 @@ function Get-WorkdayWorkerPhoto {
 
 .EXAMPLE
 
-Get-WorkdayWorkerPhoto -WorkerId 123
+# Get the Binary Array of a
+$BinaryArray = Get-WorkdayWorkerPhoto -WorkerId 123
+
+.EXAMPLE
+#
+
 
 #>
 
@@ -49,9 +59,11 @@ Get-WorkdayWorkerPhoto -WorkerId 123
                    ParameterSetName='IndividualWorker')]
 		[ValidateSet('WID', 'Contingent_Worker_ID', 'Employee_ID')]
         [string]$WorkerType = 'Employee_ID',
+        [string]$Path,
+        [switch]$Passthru,
 		[string]$Human_ResourcesUri,
 		[string]$Username,
-		[string]$Password,
+        [string]$Password,
         [DateTime]$AsOfEntryDateTime = (Get-Date)
 	)
 
@@ -83,12 +95,30 @@ Get-WorkdayWorkerPhoto -WorkerId 123
         }
         $response = Invoke-WorkdayRequest -Request $request -Uri $Human_ResourcesUri -Username:$Username -Password:$Password
 
-        $o = [PSCustomObject][ordered]@{
-            ID      = $response.Xml.Get_Worker_Photos_Response.Response_Data.Worker_Photo.Worker_Photo_Data.ID
-            Photo   = $response.Xml.Get_Worker_Photos_Response.Response_Data.Worker_Photo.Worker_Photo_Data.File
+        if ($Passthru) {
+            Write-Output $response
+        }
+        elseif ($response.Success) {
+            $filename = $response.Xml.Get_Worker_Photos_Response.Response_Data.Worker_Photo.Worker_Photo_Data.Filename
+            $base64 = $response.Xml.Get_Worker_Photos_Response.Response_Data.Worker_Photo.Worker_Photo_Data.File
+            $bytes = [System.Convert]::FromBase64String($base64)
+
+            if ([string]::IsNullOrEmpty($Path)) {
+                $output = [PsCustomObject][Ordered]@{
+                    Filename = $filename
+                    Bytes    = $bytes
+                }
+                Write-Output $output
+            }
+            else {
+                if (Test-Path -Path $Path -PathType Container) {
+                    $Path = Join-Path $Path $filename
+                }
+                $bytes | Set-Content -Path $Path -Encoding Byte
+            }
+        }
+        else {
+            throw "Error calling Get_Worker_Photos_Request: $($response.Message)"
         }
-        
-        
-        Write-Output $o
     }
-}
+}

source/tests/Get-WorkdayWorkerPhoto.Tests.ps1

@@ -0,0 +1,22 @@
+Get-Module WorkdayApi | Remove-Module -Force
+Import-Module "$PsScriptRoot\..\WorkdayApi.psd1" -Force
+Import-Module "$PsScriptRoot\Invoke-WorkdayRequestHelper.psm1" -Force -DisableNameChecking
+
+Describe Get-WorkdayWorkerPhoto {
+    InModuleScope WorkdayApi {
+
+        # Echo Request
+        Mock Invoke-WorkdayRequest {
+            Mock_Invoke-WorkdayRequest_Echo @args
+        }
+
+        It 'Creates the correct XML for the request.' {
+            $expectedResponse = @'
+<bsvc:Get_Worker_Photos_Request bsvc:version="v30.0" xmlns:bsvc="urn:com.workday/bsvc"><bsvc:Request_References bsvc:Skip_Non_Existing_Instances="false"><bsvc:Worker_Reference><bsvc:ID bsvc:type="Employee_ID">1</bsvc:ID></bsvc:Worker_Reference></bsvc:Request_References><bsvc:Response_Filter><bsvc:As_Of_Entry_DateTime>2020-05-05T00:00:00.0000000</bsvc:As_Of_Entry_DateTime></bsvc:Response_Filter></bsvc:Get_Worker_Photos_Request>
+'@ -f (Get-Date)
+            $response = Get-WorkdayWorkerPhoto -WorkerId 1 -AsOfEntryDateTime '2020-05-05' -Passthru
+            $response.Xml.OuterXml | Should BeExactly $expectedResponse
+        }
+
+    }
+}