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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetActivePrintLayerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.PrintLayers">
  <Embed xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</Embed>
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <JobId>String</JobId>
</GetActivePrintLayerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetActivePrintLayerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.PrintLayers">
  <PrintLayer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Id>String</d2p1:Id>
    <d2p1:JobId>String</d2p1:JobId>
    <d2p1:LayerNumber>0</d2p1:LayerNumber>
    <d2p1:StartAt>0001-01-01T00:00:00</d2p1:StartAt>
  </PrintLayer>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetActivePrintLayerResponse>