Postman - Get a Single Aud Action - Formats 500 and 502

Purpose: To Get a single action Aud action in format 500 and format 502.

I first want to mention there is more than one audiometric data format. There are some that are legacy, pre xml. Below is a link for the different aud data formats.

Audiogram Format

Secondly, if you look in on the swagger page, under patient actions, at the “Get -/{tenantid}/api/Patients/{patientId}/{sessionId}/action/{actionId}” route you will see dataFmt. With this Query Param you can say what data format you want the aud data in when you get it. So, if you want the aud data returned to you as 500, you would do this “ "dataFmt": 500.” It is up to you what format you want the data in. The link above will show you the different formats. *Note: The Noah ES API will only return xml formats. So you can get the data as format 500 or format 502.

Precondition: Remember to create your new access token.

https://himsanoah.atlassian.net/wiki/spaces/~977867606/pages/3460169759

1.) Creating the Get Action Route

The API has multiple requirements for this get route.

• Collection Variable.

• Path Variables

• Query Params

• Headers

The path for Get PatientAction:

1.) Format 500

{{baseUrlNoahESQA}}/:tenantId/api/Patients/:patientId/:sessionId/action/:actionId?skip=0&take=200&dataFmt=500

Open

2.) Format 502

{{baseUrlNoahESQA}}/:tenantId/api/Patients/:patientId/:sessionId/action/:actionId?skip=0&take=200&dataFmt=502

Open

*Note: The collection variable I created {{baseUrlNoahESQA} = https://api.qa.eu.noah-es.com

A.) Path Variables: See Picture Below

1.) :tennantid = {{tennantid}} - I created a collection variable for my fork of the Noah ES Test Collection.

2.) :patientId = {{patientId}} - I created a collection variable for my fork of the Noah ES Test Collection.

3.) sessionId = {{sessionId}} - I created a collection variable for my fork of the Noah ES Test Collection.

4.) actionId = {{actionId}} - I created a collection variable for my fork of the Noah ES Test Collection.

B.) Query Params: See Pictures Below

1.) Format 500

i.) skip = 0

ii.) take - 200

iii.) dataFmt - 500

2.) Format 502

i.) skip = 0

ii.) take - 200

iii.) dataFmt - 502

C.) Headers: See Picture Below

The X-Api-Version needs to be set. At this time 1.0 is the only version, so this is what I have set.

2.) Sending the Get Action Route

a.) Go to the Authorization tab and select the token you created as a precondition above.

b.) Once the access token has been selected, the Path Variables set, Query Params set and the Header set. Select “Send”

3.) Results

a.) You should see a Status: 200 OK.

If you don’t see Status 200 OK

• If you do not, Check the error code in Swagger by expanding the patientactions and scrolling down to the return values. https://api.qa.eu.noah-es.com/swagger/index.html

• Note: It might be helpful to check the Console too. It is located at the bottom, of Postman on the lower left corner. The picture below shows where to find the option to select and open the console.

b.) Successful results for the returned aud action for the session in the Test4 Test4 patient record.

The picture below is what you will see for a successful return of the Get Action in format 502. Below that is the full returned format 502data in the code snippet.

*Note: In the returned data below you can see the data base 64 encoded.