Production
HomeHelp

Organization Accounts

Organization Accounts Documentation

Organization Account [LIST]

Organization Account [LIST]

Request

Endpoint

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

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "a4ebf99b-5e93-4dd1-bc8b-639b44025c92",
      "type": "organization_accounts",
      "attributes": {
        "created_at": "2022-01-12T17:17:58Z",
        "disable_downloads": false,
        "last_download": "2022-01-12T17:17:58Z",
        "latest_donation_date": null,
        "locked_at": null,
        "remote_id": "185e9b87-a25d-4093-ade9-629a3267bc01",
        "updated_at": "2022-01-12T17:17:58Z",
        "updated_in_db_at": "2022-01-12T17:17:58Z",
        "username": "foo"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "7c0e57ee-2ea3-4d91-b4db-6247325c999c",
            "type": "organizations"
          }
        },
        "person": {
          "data": {
            "id": "35e3efb4-3a3f-4d6a-aace-92ec0ff287cc",
            "type": "people"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Organization Account]

Description An array of Organization Accounts

Organization Account [POST]

Organization Account [POST]

Request

Endpoint

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

Body

{
  "data": {
    "type": "organization_accounts",
    "attributes": {
      "password": "bar",
      "updated_in_db_at": "2022-01-12 17:17:58 UTC",
      "username": "foo"
    },
    "relationships": {
      "person": {
        "data": {
          "type": "people",
          "id": "61f674cf-4dd2-42f0-ad64-4a70638b671e"
        }
      },
      "organization": {
        "data": {
          "type": "organizations",
          "id": "32b2d7d0-3916-41dc-a756-8ba4398f43bd"
        }
      }
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

disable_downloads

Type string

Description Disable Downloads

Required No

last_download

Type string

Description Last Download

Required No

latest_donation_date

Type string

Description Latest Donation Date

Required No

locked_at

Type string

Description Locked At

Required No

password

Type string

Description Password for organization account

Required No

remote_id

Type string

Description Remote Id

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

username

Type string

Description Username

Required No

Relationships

organization.data

Type Organization

Description Organization this account belongs to

Required No

person.data

Type Person

Description Person this account belongs to

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "b673768e-dc43-40ed-9aa0-3134288586d9",
    "type": "organization_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:17:58Z",
      "disable_downloads": false,
      "last_download": null,
      "latest_donation_date": null,
      "locked_at": null,
      "remote_id": null,
      "updated_at": "2022-01-12T17:17:58Z",
      "updated_in_db_at": "2022-01-12T17:17:58Z",
      "username": "foo"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "32b2d7d0-3916-41dc-a756-8ba4398f43bd",
          "type": "organizations"
        }
      },
      "person": {
        "data": {
          "id": "61f674cf-4dd2-42f0-ad64-4a70638b671e",
          "type": "people"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

disable_downloads

Type string

Description Disable Downloads

last_download

Type string

Description Last Download

latest_donation_date

Type string

Description Latest Donation Date

locked_at

Type string

Description Locked At

remote_id

Type string

Description Remote Id

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.

username

Type string

Description Username

Relationships

organization.data

Type Organization

Description Organization this account belongs to

person.data

Type Person

Description Person this account belongs to

Organization Account [GET]

Organization Account [GET]

Request

Endpoint

GET /api/v2/user/organization_accounts/372a4832-2114-4642-a11c-3b99c224cb60
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "372a4832-2114-4642-a11c-3b99c224cb60",
    "type": "organization_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:17:58Z",
      "disable_downloads": false,
      "last_download": "2022-01-12T17:17:58Z",
      "latest_donation_date": null,
      "locked_at": null,
      "remote_id": "59e39884-786b-4e8b-aa37-71d3a9d849bd",
      "updated_at": "2022-01-12T17:17:58Z",
      "updated_in_db_at": "2022-01-12T17:17:58Z",
      "username": "foo"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "5d99867c-c6f9-4871-b6af-e36c7d11b15e",
          "type": "organizations"
        }
      },
      "person": {
        "data": {
          "id": "17e1307a-6305-4d47-a6de-0fe7c0cd245f",
          "type": "people"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

disable_downloads

Type string

Description Disable Downloads

last_download

Type string

Description Last Download

latest_donation_date

Type string

Description Latest Donation Date

locked_at

Type string

Description Locked At

remote_id

Type string

Description Remote Id

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.

username

Type string

Description Username

Relationships

organization.data

Type Organization

Description Organization this account belongs to

person.data

Type Person

Description Person this account belongs to

Organization Account [PUT]

Organization Account [PUT]

Request

Endpoint

PUT /api/v2/user/organization_accounts/862b3b72-5c5f-4302-8ebf-42d49058ead5
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "organization_accounts",
    "attributes": {
      "password": "bar",
      "updated_in_db_at": "2022-01-12 17:17:58 UTC",
      "username": "foo"
    },
    "relationships": {
      "person": {
        "data": {
          "type": "people",
          "id": "9af7c3a5-ff8e-4d76-b9b5-925d002cd35c"
        }
      },
      "organization": {
        "data": {
          "type": "organizations",
          "id": "8cbe5aa1-334c-43b2-b3f7-4e2cf49e7602"
        }
      }
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

disable_downloads

Type string

Description Disable Downloads

Required No

last_download

Type string

Description Last Download

Required No

latest_donation_date

Type string

Description Latest Donation Date

Required No

locked_at

Type string

Description Locked At

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

password

Type string

Description Password for organization account

Required No

remote_id

Type string

Description Remote Id

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

username

Type string

Description Username

Required No

Relationships

organization.data

Type Organization

Description Organization this account belongs to

Required No

person.data

Type Person

Description Person this account belongs to

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "862b3b72-5c5f-4302-8ebf-42d49058ead5",
    "type": "organization_accounts",
    "attributes": {
      "created_at": "2022-01-12T17:17:58Z",
      "disable_downloads": false,
      "last_download": "2022-01-12T17:17:58Z",
      "latest_donation_date": null,
      "locked_at": null,
      "remote_id": "cc0db6db-e55d-4e36-bc1e-20b21ebfada5",
      "updated_at": "2022-01-12T17:17:58Z",
      "updated_in_db_at": "2022-01-12T17:17:58Z",
      "username": "foo"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "8cbe5aa1-334c-43b2-b3f7-4e2cf49e7602",
          "type": "organizations"
        }
      },
      "person": {
        "data": {
          "id": "9af7c3a5-ff8e-4d76-b9b5-925d002cd35c",
          "type": "people"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

disable_downloads

Type string

Description Disable Downloads

last_download

Type string

Description Last Download

latest_donation_date

Type string

Description Latest Donation Date

locked_at

Type string

Description Locked At

remote_id

Type string

Description Remote Id

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.

username

Type string

Description Username

Relationships

organization.data

Type Organization

Description Organization this account belongs to

person.data

Type Person

Description Person this account belongs to

Organization Account [DELETE]

Organization Account [DELETE]

Request

Endpoint

DELETE /api/v2/user/organization_accounts/4d1bf3f8-d866-48c1-99bf-b5e793dfce26
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body

Organization Account [SYNC]

Organization Account [SYNC]

Request

Endpoint

GET /api/v2/user/organization_accounts/90e20a10-4368-4cec-a96d-b3d138bc765c/sync
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: text/html
200 OK

Body

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

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.

PreviousOptions

Last updated