GetBuildingViaId

Class Description

Downloads all cachable relational data of a guide in a single set.

RPC Configuration

Rpc Name:

Plain: GetBuildingViaId
Sha1: 5efe9474aff74a9f0ccfae2eaf47af9b09b6003a

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:

"building_id" : int,
"gzip" : string|bool = 1,
"structure" : string|bool = ,
"expires" : ?int = null,
"exportparent" : bool = 1,
"base64" : bool = 1,
"structureVersion" : ?int = null 

Parameter Description

@param bool|string gzip Configure if the response value of the building field should be gzipped or not.

@param bool|string structure Configure if the response value of the building should contain the SQL Structure or not

@param null|int expires The expiration date limit. Only datasets (and structural dependend data) that is new than this unix timestamp will be exported. Can be null to export everything.

@param bool exportparent If the parent building (if one is available) should be connected and exported.

@param ?int structureVersion The currently used structure version of the client. if the local structure is newer than the remote, expired will be ignored and a structure dump will always be exported.

If not transmitted, the process is not used and it will behave exactly as configured.

Requires Login:

true

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

true

Requires contextParamName:

building_id

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

false

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

STANDARD_USER

Requires Subbuilding Merge Strategy:

REPLACE

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

true

Cache Time to Live:

900

Sample Request

->

{
    "building_id": 131
}

<-

{
    "success": 0,
    "errorCode": 404,
    "errorMessage": "BuildingNotFoundException in Contagt API Version: 1.79.0<br \/>The Building [131] does not exist in the Database."
}