Show Document

Pending

GET

https://api.mpc.dev.placewise.com/v1/users/me/operations/documents/{id}

API Permit:Operations:Api:Users:Documents:Show

API Context:Loyalty Club

Authorizations:User

Returns given Document shared with current user.

URL Parameters

Parameter	Type	Description
id	integer	Document ID

Error Responses

Status	Description
`404`	Document not found

Example

When successful, returns object containing document

{
  "document": {} // see 'Document model'
}

Request

Path Params

integer

required

Example:

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Store-Id

integer

required

Store id associated with given user role (e.g. Store Owner).

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/users/me/operations/documents/1' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Store-Id;'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-07-22 07:44:02

List Documents

Confirm Document

Show Document

URL Parameters#

Error Responses#

Example#

Request

Request samples

Responses

URL Parameters

Error Responses

Example