Foundry API

<back to all web services

GetActivePrintLayerRequest

Requires Authentication
The following routes are available for this service:
All Verbs/job/{JobId}/active-print-layer
GetActivePrintLayerRequest Parameters:
NameParameterData TypeRequiredDescription
JobIdpathstringNo
GetOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetActivePrintLayerResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PrintLayerformPrintLayerNo
PrintLayer Parameters:
NameParameterData TypeRequiredDescription
JobIdformstringNo
LayerNumberformintNo
StartAtformDateTimeNo
IdformstringNo
GetActivePrintLayerResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PrintLayerformPrintLayerNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /job/{JobId}/active-print-layer HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"jobId":"String","organisationId":"String","embed":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"printLayer":{"jobId":"String","layerNumber":0,"id":"String"}}