als_insert_block_adjustment.cgi

 Top  Previous  Next

Description

The als_get_insert_block_adjustment.cgi.web service inserts an adjustment entry that affects block calculations.Blocks can be manually adjusted via AL-Desk or this API call. Adjustment entries can be retrieved using als_get_block_adjustments.cgi

 

As is normal for all Put calls a valid webusercode is required along with the following fields:

 

•block
•date
•time
•qty

 

Example Usage           

http://www.alstracker.dnsalias.com/aldesk/als_insert_block_adjustment.cgi?webusercode=1&block=41&date=2006-02-01&qty=1&notes=use%20with%20care&time=10:00

 

Inputs

Parameter

Description

Required

Example

Data Type

block

Identifies the block definition

 

See als_get_block_defs.cgi

 

Requiredl

block=5

Integer

date

date that will be affected

Required

date=2006-02-02

Date

time

time of the activity

Required

time=10:00

Time

qty

adjustment qty.

 

Note: This value will be added to the available number as retrieved in the als_get_block_availability.cgi call.

 

When adjusting blocks in AL-Desk a calculation is made to calculate the value needed for the block adjustment entry. The Web Portal API allows you to enter in a value that will be added to the current availability value. This can be a positive or a negative number.

 

 

Required

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

qty=1

 

or

 

qty=-5

 

 

 

 

 

 

 

 

 

 

 

 

Integer

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

notes

This paramater is provided as an option to allow for the notes field of the block definition to be updated.

Optional

notes=adjusted by sally

String

 

 

Returned Fields

#

Field Name

Description

Data Type

1

 

2


 

 

 

 

 

XML Example

 

<?xml version="1.0" encoding="utf-8" ?>

- <root>

- <blockadjustments>

<row seq="20" block="41" datevalue="2/1/2006" quantity="1" enteredby="1" entereddesk="4" entereddate="12/3/2005" enteredtime="7:30:47 AM" affiliate="" notes="adjusted per the master gater use with care" />

</blockadjustments>

</root>