Location Transactions
Location transactions include transactions for creating, updating, deleting and retrieving a location’s details.
Limited Support/End of Life Capabilities
The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.
If you need to request a hotfix or support for these features, please contact Alemba Support
LocationCreate Transaction
The LocationCreate transaction can be used to create a new location and save its details.
Input Parameters: LocationCreateRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Ignored | - | Ignored on Create |
sName | String | Yes | - | Location Name |
sAddressLine1 | String | No | “” | Location Address Line 1 |
sAddressLine2 | String | No | “” | Location Address Line 2 |
sState | String | No | “” | Location State |
sSuburb | String | No | “” | Location Suburb |
sPostCode | String | No | “” | Location Postcode |
sCountry | String | No | “” | Location Country |
sTelephone | String | No | “” | Location Telephone number |
sFacsimile | String | No | “” | Location Facsimile number |
lOrganization | Lookup Field | No | 0 | Organization to link to this location. If locations are not linked to organizations, this parameter will be ignored. |
lPartition | Lookup Field | No | Analyst’s default partition | Partition in which to create the location |
sReason | String | No | “” | Audit reason |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Values:LocationResponse
Argument | Type | Description |
nEntityRef | Integer | Newly created location |
sMessage | String | Error/Warning Message returned from the API |
Ret | APIReturn | Error/Warning number returned from the API |
LocationUpdate Transaction
The LocationUpdate transaction can be used to open and edit the details of a location record. This transaction updates the location record and saves the changes.
Input Parameters: LocationUpdateRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Yes | - | Reference number of the Location to update |
sName | String | No | (As is) | Location Name |
sAddressLine1 | String | No | (As is) | Location Address Line 1 |
sAddressLine2 | String | No | (As is) | Location Address Line 2 |
sState | String | No | (As is) | Location State |
sSuburb | String | No | (As is) | Location Suburb |
sPostCode | String | No | (As is) | Location Postcode |
sCountry | String | No | (As is) | Location Country |
sTelephone | String | No | (As is) | Location Telephone number |
sFacsimile | String | No | (As is) | Location Facsimile number |
lOrganization | Lookup Field | No | (As is) | Organization to link to this location. If locations are not linked to organizations, this parameter will be ignored. |
lPartition | Lookup Field | No | (As is) | Partition in which to create the location |
sReason | String | No | “” | Audit reason |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Values: LocationResponse
See LocationResponse for more information.
LocationRetrieve Transaction
The LocationRetrieve transaction can be used to view the details of a location record. This transaction does not update any of the record’s details.
Input Parameters: LocationEntityRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Yes | - | Reference number of the Location to update |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Values: LocationRetrieveResponse
Argument | Type | Description |
Ret | APIReturn | Error/Warning number returned from the API |
sMessage | String | Error/Warning message |
ResultSet | DataSet | ResultSet containing attribute details |
LocationDelete Transaction
The LocationDelete transaction can be used to find and delete a location record. Only status and audit trail fields are updated when a LocationDelete transaction is executed.
Input Parameters: LocationDeleteRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Yes | - | Reference number of the Location to update |
sReason | String | No | “” | Audit reason |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Values: LocationResponse
See LocationResponse for more information.