Options

Options Documentation

Option [LIST]

Option [LIST]

Request

Endpoint

GET /api/v2/user/options
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "41063f8a-e0a5-496b-9f89-5e04e12f84a5",
      "type": "user_options",
      "attributes": {
        "created_at": "2021-11-23T14:37:36Z",
        "key": "key_1",
        "updated_at": "2021-11-23T14:37:36Z",
        "updated_in_db_at": "2021-11-23T14:37:36Z",
        "value": "gluten-free"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Option]

Description An array of Options

Option [POST]

Option [POST]

Request

Endpoint

POST /api/v2/user/options
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "user_options",
    "attributes": {
      "key": "key_7",
      "updated_in_db_at": "2021-11-23 14:37:36 UTC",
      "value": "brunch"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

key

Type string

Description Key to reference option (only contain alphanumeric and underscore chars)

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

value

Type string

Description Value of option

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "ddd1d326-ce94-4759-ae2c-ebc2de83793b",
    "type": "user_options",
    "attributes": {
      "created_at": "2021-11-23T14:37:36Z",
      "key": "key_7",
      "updated_at": "2021-11-23T14:37:36Z",
      "updated_in_db_at": "2021-11-23T14:37:36Z",
      "value": "brunch"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

key

Type string

Description Key to reference option (only contain alphanumeric and underscore chars)

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

value

Type string

Description Value of option

Option [GET]

Option [GET]

Request

Endpoint

GET /api/v2/user/options/key_4
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "e3931dd0-a973-4b60-a83b-271257dd0cca",
    "type": "user_options",
    "attributes": {
      "created_at": "2021-11-23T14:37:36Z",
      "key": "key_4",
      "updated_at": "2021-11-23T14:37:36Z",
      "updated_in_db_at": "2021-11-23T14:37:36Z",
      "value": "health"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

key

Type string

Description Key to reference option (only contain alphanumeric and underscore chars)

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

value

Type string

Description Value of option

Option [PUT]

Option [PUT]

Request

Endpoint

PUT /api/v2/user/options/key_2
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "user_options",
    "attributes": {
      "key": "key_3",
      "updated_in_db_at": "2021-11-23 14:37:36 UTC",
      "value": "XOXO"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

key

Type string

Description Key to reference option (only contain alphanumeric and underscore chars)

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

value

Type string

Description Value of option

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "39ddfd4d-db4b-48f9-a616-46167cf7faed",
    "type": "user_options",
    "attributes": {
      "created_at": "2021-11-23T14:37:36Z",
      "key": "key_3",
      "updated_at": "2021-11-23T14:37:36Z",
      "updated_in_db_at": "2021-11-23T14:37:36Z",
      "value": "XOXO"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

key

Type string

Description Key to reference option (only contain alphanumeric and underscore chars)

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

value

Type string

Description Value of option

Option [DELETE]

Option [DELETE]

Request

Endpoint

DELETE /api/v2/user/options/key_8
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body