Locking and Updating Calls

ASM API Quick Reference Guide

Start a new Request

1. In Postman, select 'New' in the top left-hand corner.

2. Select HTTP from the dialogue window and give the request the name of {Request name}

Request Name - Lock Call

• Method: PUT

• URL: {{SystemURLTest}}/alemba.api/api/v2/call/{{CallRef}}/lock

  • Full URL, if desired: https://<yourservername>/<yourASMsystemname>/alemba.api/api/v2/call/<yourcallno>/lock

• Authorization: Bearer {{Login_Token}}

Successful Response

Request Name - Update Call Fields

• Method: PUT

• URL: {{SystemURLTest}}/alemba.api/api/v2/call/{{CallRef}}

  • Full URL, if desired: https://<yourservername>/<yourASMsystemname>/alemba.api/api/v2/call/<yourcallRef>

• Headers: Content-Type: application/json

• Body: Raw

• Authorization: Bearer {{Login_Token}}

The Body of the HTTP request is where you enter the data/changes that you want to enact on the call. The Body is written in JSON. Please go to Jargon Buster to read more about JSON.

1. To update the Description of the call and the Call Status, the JSON body should look like as follows:

{

"Description":"the new description",

"DescriptionHtml": "the new description",

"CallStatus": 3

}

Please note, where you have rich text fields (HTML), you always need to provide the FieldName value and the FieldNameHtml value.

A Successful Response

Request Name - Unlock Call

This is Mandatory after doing an Update, unless an Update is followed by a Forward, Defer or Close action, which will automatically unlock the call.

• Method: PUT

• URL: {{SystemURLTest}}/alemba.api/api/v2/call/{{CallRef}}/unlock

  • Full URL, if desired: https://<yourservername>/<yourASMsystemname>/alemba.api/api/v2/call/<yourcallno>/unlock

• Authorization: Bearer {{Login_Token}}

A Successful Request