API Designs Get By ID

    Purpose

    Retrieve a single design based on the design ID.

    Arguments

    Type Name Description
    int design_id ID of the required design

    Sample Usage

    $client = new SoapClient('http://l001.pageprodigy.com/api/soap/?wsdl');
    
    $session = $client->login('apiUser', 'apiKey');
    $api_result = $client->call($session, 'designs.getByID', array($design_id));
    
    echo $api_result ['id']
    
    

    Returns

    Type Name Description
    array design_array A single designEntity

    The designEntity content is as follows:

    Type Name Description
    integer id The ID of the Design
    integer customer_id The ID of the Customer (Same as sent argument)
    string customer_code Unique code of the customer
    string share_hash Hash the customer uses to share this project with others.
    string filename Filename of the design.
    integer pdf_status Code for the status of the PDF. 0 = Not rendered, 1 = Set to render, 2 = Rendered, 3 = Rendering error.
    string pdf_status_message Provides a human readable status of the PDF rendering.
    string pdf_url URL of the PDF. **Available only if the PDF has rendered.
    integer epub_status Code for the status of the ePublication. 0 = Not created, 1 = Set to create, 2 = Created, 3 = Creation error.
    string epub_status_message Provides a human readable status of the ePublication creation.
    string epub_name The name is used in the ePublication URL to display the ePublication. **Available only if an ePublication has been created.
    string epub_title The title will display to the left of page 1 of the ePublication. **Available only if an ePublication has been created.
    string epub_description The description will display to the left of page 1 below the title of the ePublication. **Available only if an ePublication has been created.
    string epub_tags Tags will be put as keywords in the head of the ePublication. **Available only if an ePublication has been created.
    integer epub_explicit Define whether or not the ePublication is child-safe. 0 = Not explicit, 1 = Explicit. **Available only if an ePublication has been created.
    integer epub_access The desired availability of the ePublication. 0 = Public, 1 = Private. **Available only if an ePublication has been created.
    string created_time Time stamp of the creation date of the design.
    string update_time Time stamp of the most recent update of this design.