View App Store Legal Document

GET https://api.ocamba.com/v2/ocamba/app-store/{app_id}/legal-doc/app-store/{app_id}/legal-doc

Retrieves the Legal Document for a specific app in the App Store.

path Parameters

Name

Description

idstringrequired

Unique identifier for the object defined as a path parameter.

Example: 12345

query Parameters

Name

Description

fieldsstring

The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.

Example: fields=field1,field2,field3

viewstring

Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.

Example: view=full/default

Response examples

200 - OK

200 - OK response

application/json

Name

Description

items[ app-legal-doc ]

Array containing a single Legal Document.

Application Legal Document

Name

Description

app_idstring

Unique identifier of the Application.

Example: 1001

create_timedateTime

The UTC timestamp when the legal document was first created in the system.

Example: 2021-07-30 12:50:13

idstring

Unique identifier of the Application Legal Document.

Example: 10014

namestring

The display name of the legal document, typically shown to users..

Example: Terms of Service

pdfstring (uri)

The URL to download the PDF version of the legal document.

Example: https://ocamba.com/apps/hood/terms/terms-of-service-v2.1.pdf

statusstring

The current status of the legal document. 'active' documents are currently in effect, 'superseded' documents have been replaced by newer versions, and 'draft' documents are not yet published.

Example: superseded

Possible values: active | superseded | draft

supersede_timedateTime

The UTC timestamp when this document was superseded by a newer version. Only set when status is 'superseded'.

Example: 2021-07-30 12:50:13

superseded_by_ids[ string ]

Array of legal document IDs that supersede this document. Only populated when status is 'superseded'.

Example: 10015,10016

textstring

The full text content of the legal document. May be null if only URL or PDF is available.

Example: By using this application, you agree to be bound by these Terms of Service...

update_timedateTime

The UTC timestamp when the legal document was last modified.

Example: 2021-07-30 12:50:13

urlstring (uri)

The public URL where the legal document can be accessed online.

Example: https://ocamba.com/apps/hood/terms

totalinteger

Total number of Legal Documents found.

Example: 1

400 - Bad Request

400 - Bad Request response

application/json

Name

Description

codeinteger

Http response status code.

Example: 400

messagestring

The human readable message that describes how to deal with error.

Example: The request body is not valid.

titlestring

The error title.

Example: Bad request.

trace_idstring

Error trace id.

Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62

500 - Internal Server Error

500 - Internal Server Error response

application/json

Name

Description

codeinteger

Http response status code.

Example: 500

messagestring

The human readable message that describes how to deal with error.

Example: Internal server error.

titlestring

The error title.

Example: Internal server error.

Response examples

Copied

200

{
  "total": 1,
  "items": [
    {
      "id": "10014",
      "app_id": "1001",
      "name": "Terms of Service",
      "text": "By using this application, you agree to be bound by these Terms of Service...",
      "url": "https://ocamba.com/apps/hood/terms",
      "pdf": "https://ocamba.com/apps/hood/terms/terms-of-service-v2.1.pdf",
      "status": "superseded",
      "superseded_by_ids": [
        null
      ],
      "supersede_time": "2021-07-30 12:50:13",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}

Get Started

View App Store Legal Document