API routes (Click a route to expand it, click here to expand/collapse all)
Default APIs
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
    Request Report
    GET/getBuildingInfo ⎘Authentication required
    NOTE provide vboId if possible as it increases the likelihood of success
    (example of where it does not work but without but with it does: number=3, addition=3, postcode=6828CA (Steenstraat, Arnhem)
    Get information from CFP greenbuildings, the result will be sent to the Inbound Port with the reference prefixed with that reference.
    Parameter Location Type Requirements Optional Default value Description
    reference URI-Query string
    minLength: 5
    maxLength: 64
    pattern: ^[0-9A-Za-z-]*$
    		 No Reference for which you are requesting this information for.
    vboId URI-Query string
    minLength: 10
    maxLength: 36
    pattern: ^[0-9]*$
    		 Yes "" vboId, will be used to find the address.
    postalCode URI-Query string
    pattern: ^[1-9][0-9]{3}?[ ]{0,1}(?!SA|SD|SS)[A-Z]{2}$
    		 No Postal code
    number URI-Query string
    minLength: 1
    maxLength: 128
    		 No Address number.
    addition URI-Query string
    minLength: 1
    maxLength: 16
    		 Yes "" Address addition.
    additionLetter URI-Query string
    minLength: 1
    maxLength: 16
    		 Yes "" Address additional letter.
    Response HTTP Type Description
    Success 200 true Acknowledgement of receiving the request, request will be processed in the background.
    CFPException 502 CFP-integration related error, check details for details.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: 'cfp:*' ⎘
    GET/getBuildingInfo/withAddressDetails ⎘Authentication required
    NOTE: Only use as fallback, use /withVBO instead, does NOT guarantee results!
    (example of where it does not work but /withVBO does: number=3, addition=3, postcode=6828CA (Steenstraat, Arnhem)
    Get information from CFP greenbuildings, the result will be sent to the Inbound Port with the reference prefixed with that reference.
    Parameter Location Type Requirements Optional Default value Description
    reference URI-Query string
    minLength: 5
    maxLength: 64
    pattern: ^[0-9A-Za-z-]*$
    		 No Reference for which you are requesting this information for.
    postalCode URI-Query string
    pattern: ^[1-9][0-9]{3}?[ ]{0,1}(?!SA|SD|SS)[A-Z]{2}$
    		 No Postal code
    number URI-Query string
    minLength: 1
    maxLength: 128
    		 No Address number.
    addition URI-Query string
    minLength: 1
    maxLength: 16
    		 Yes "" Address addition.
    additionLetter URI-Query string
    minLength: 1
    maxLength: 16
    		 Yes "" Address additional letter.
    Response HTTP Type Description
    Success 200 true Acknowledgement of receiving the request, request will be processed in the background.
    CFPException 502 CFP-integration related error, check details for details.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: 'cfp:*' ⎘
    GET/getBuildingInfo/withVBO ⎘Authentication required
    Get information from CFP greenbuildings, the result will be sent to the Inbound Port with that reference.
    Parameter Location Type Requirements Optional Default value Description
    reference URI-Query string
    minLength: 5
    maxLength: 64
    pattern: ^[0-9A-Za-z-]*$
    		 No Reference for which you are requesting this information for.
    vboId URI-Query string
    minLength: 10
    maxLength: 36
    pattern: ^[0-9]*$
    		 No vboId, will be used to find the address.
    Response HTTP Type Description
    Success 200 true Acknowledgement of receiving the request, request will be processed in the background.
    CFPException 502 CFP-integration related error, check details for details.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: 'cfp:*' ⎘
    Uncategorized APIs
    GET/status/{reference} ⎘Authentication required
    Show the status of the request with given reference.
    Parameter Location Type Requirements Optional Default value Description
    reference URI-Path string
    minLength: 5
    maxLength: 64
    pattern: ^[0-9A-Za-z-]*$
    		 No Reference of what you requested information for.
    Response HTTP Type Description
    Success 200 string The latest status
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: 'cfp:*' ⎘
    Authentication schemes (Click an authentication scheme to expand it)
    JWTAuth
    Result wrappers (Click a result-wrapper to expand it)
    Success
    Error