Get Post Data and Metadata

Operation Summary:

Retrieves a blog post and its metadata.

Resource URL:

https://api.compendiumblog.com/app/post/{PostId}

HTTP method:

GET

HTTP Status Codes:

200 OK

400 Bad Request

403 Forbidden

405 Method Not Allowed

HTTP Status Code Details:

200 OK: Upon successful retrieval of the post listing, you will get back a 200 response.
400 Bad Request: If the request includes invalid or lacks required parameters, you will get back a 400 response.
403 Forbidden: If your level of authentication is not authorized to make the request, you will get back a 403 response.
405 Method Not Allowed: If you attempt to access this resource via an HTTP method other than GET, you will get a 405 response.

Response Representations:

JSON (application/json)

Permitted Roles:

Any Authenticated User

Required Parameters:

PostId: The system-assigned unique identifier of the post.

Optional Parameters:

There are no optional parameters associated with this operation.

Response Values:

Success: The post listing was retrieved successfully.
Error: The post listing was not retrievable.

Response Structure:

A successful call will result in a JSON object with the following structure:

{
    "Success" : {
        "PostId"                     : string,  // unique identifier of the post
        "CreatorFirstName"           : string,  // user's first name
        "CreatorLastName"            : string,  // user's last name
        "CreationTimestamp"          : string,  // date and time of first post save operation
        "UserId"                     : string,  // unique identifier of the user
        "Title"                      : string,  // title of post
        "Sticky"                      : boolean, // flag indicating whether post should be displayed at top of first index page
        "Body"                       : string,  // text of the comment
        "PublicationTimestamp"       : string,  // date and time of post publication
        "Feedback"                   : string,  // administrative feedback
        // "Edited*" fields are returned only for authenticated roles where a post has been previously approved and then subsequently modified.
        "EditedTitle"                : string,  // title of post
        "EditedSticky"               : boolean, // flag indicating whether post should be displayed at top of first index page
        'EditedBody'                 : string,  // text of the comment
        "EditedPublicationTimestamp" : string,  // date and time of post publication
        "Url"                        : string,  // canonical URL for post
        "Status"                     : string   // approval status of post
     }
}

The Error result will be a flat array of objects, which have keys for the message name and explanatory text.

{
     "Error" : [
       { "Name" : string, "Message" : string },
       { "Name" : string, "Message" : string },
       ...   
    ]
}

Error Types:

PostId: An invalid unique identifier for a post was specified or was omitted from the request parameters.
Read: An unexpected error occurred while retrieving post data.

Additional Notes:

Without authentication, only those posts which have been approved may be retrieved.
Default Permissions users may fetch only posts for their own blog.
Network Administrator users may fetch posts for all blogs on their network.
Super Administrator users may fetch any post.
The format of the CreationTimestamp and PublicationTimestamp members of a success sub-object is ISO 8601 format.
Possible values of the Status member of a success sub-object are new_pending, approved, edit_pending, declined, deleted, draft.
To distinguish this endpoint from the version 1 endpoint, the client must submit an HTTP Accept header with value application/vnd.compendium.blog;version=2 as part of the request

The following example retrieves a post with the unique identifier of cde490de-0a63-4431-b5b5-c47045ef3f3a.

curl --insecure -H "Accept: application/json,application/vnd.compendium.blog;version=2" \
  --user someuser:ixJiErykh7OhAjHwFTQ5ruNPILqVqTiyqR9ShVdr \
  https://api.test.compendiumblog.com/app/post/cde490de-0a63-4431-b5b5-c47...

Compendium Documentation

Help