Skip to content

Pearl of the Orient API Docs (1.0.0)

Quick Overview

  • API Version: 1.0.0
  • Developer: Kyle Andre Lim
  • Base Path: /api/v1

Comprehensive API documentation for authentication, users, members, branch services, and offices endpoints.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://docs-api.pearl-chaplaincy.com
License
Apache-2.0
Languages
Servers
Mock server
https://api-docs.pearlchaplaincy.org/_mock/openapi
Version 1 API base path
https://api-docs.pearlchaplaincy.org/api/v1

System

Health and root metadata endpoints

Operations

Auth

Authentication and account recovery

Operations

Users

User profile and admin user management

Operations

Members

Member application and management

Operations

Branch Service

Branch of service management

Operations

Create branch service (admin only)

Request

Security
BearerAuth
Bodyapplication/jsonrequired
titlestring[ 1 .. 100 ] charactersrequired
descriptionstring[ 1 .. 1000 ] charactersrequired
sectionsArray of objects(Section)[ 1 .. 20 ] itemsrequired
sections[].​idstring(uuid)
sections[].​titlestring[ 1 .. 100 ] charactersrequired
sections[].​typestringrequired
Enum"list""richtext"
sections[].​itemsArray of objects(SectionItem)<= 50 items
sections[].​contentstring<= 20000 characters
curl -i -X POST \
  https://api-docs.pearlchaplaincy.org/_mock/openapi/branch-service/create \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "string",
    "sections": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "title": "string",
        "type": "list",
        "items": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "content": "string"
          }
        ],
        "content": "string"
      }
    ]
  }'

Responses

Branch service created

Bodyapplication/json
codestringrequired
messagestringrequired
dataobject(BranchServiceResource)required
data.​idstring(uuid)required
data.​titlestringrequired
data.​descriptionstringrequired
data.​sectionsArray of objects(Section)required
data.​sections[].​idstring(uuid)
data.​sections[].​titlestring[ 1 .. 100 ] charactersrequired
data.​sections[].​typestringrequired
Enum"list""richtext"
data.​sections[].​itemsArray of objects(SectionItem)<= 50 items
data.​sections[].​contentstring<= 20000 characters
data.​memberIdstring or null
Any of:
string(uuid)
data.​createdAtstring(date-time)required
data.​updatedAtstring(date-time)required
Response
application/json
{
  "code": "string",
  "message": "string",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "description": "string",
    "sections": [ … ],
    "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Get all branch services

Request

Security
BearerAuth
Query
pageinteger>= 1
Default 1
limitinteger[ 1 .. 100 ]
Default 10
searchstring[ 1 .. 100 ] characters
sortBystring
Enum"createdAt""updatedAt""title"
sortOrderstring
Default "desc"
Enum"asc""desc"
curl -i -X GET \
  'https://api-docs.pearlchaplaincy.org/_mock/openapi/branch-service?page=1&limit=10&search=string&sortBy=createdAt&sortOrder=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Branch service list

Bodyapplication/json
codestringrequired
Example: "OK"
messagestringrequired
dataArray of objects(BranchServiceResource)required
data[].​idstring(uuid)required
data[].​titlestringrequired
data[].​descriptionstringrequired
data[].​sectionsArray of objects(Section)required
data[].​sections[].​idstring(uuid)
data[].​sections[].​titlestring[ 1 .. 100 ] charactersrequired
data[].​sections[].​typestringrequired
Enum"list""richtext"
data[].​sections[].​itemsArray of objects(SectionItem)<= 50 items
data[].​sections[].​contentstring<= 20000 characters
data[].​memberIdstring or null
Any of:
string(uuid)
data[].​createdAtstring(date-time)required
data[].​updatedAtstring(date-time)required
paginationobject(Pagination)required
pagination.​currentPageintegerrequired
pagination.​totalPagesintegerrequired
pagination.​totalCountintegerrequired
pagination.​limitintegerrequired
pagination.​hasNextPagebooleanrequired
pagination.​hasPreviousPagebooleanrequired
Response
application/json
{
  "code": "OK",
  "message": "string",
  "data": [
    { … }
  ],
  "pagination": {
    "currentPage": 0,
    "totalPages": 0,
    "totalCount": 0,
    "limit": 0,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Get branch service by ID

Request

Security
BearerAuth
Path
idstring(uuid)required
curl -i -X GET \
  'https://api-docs.pearlchaplaincy.org/_mock/openapi/branch-service/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Branch service details

Bodyapplication/json
codestringrequired
Example: "OK"
messagestringrequired
dataobject(BranchServiceResource)required
data.​idstring(uuid)required
data.​titlestringrequired
data.​descriptionstringrequired
data.​sectionsArray of objects(Section)required
data.​sections[].​idstring(uuid)
data.​sections[].​titlestring[ 1 .. 100 ] charactersrequired
data.​sections[].​typestringrequired
Enum"list""richtext"
data.​sections[].​itemsArray of objects(SectionItem)<= 50 items
data.​sections[].​contentstring<= 20000 characters
data.​memberIdstring or null
Any of:
string(uuid)
data.​createdAtstring(date-time)required
data.​updatedAtstring(date-time)required
Response
application/json
{
  "code": "OK",
  "message": "string",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "description": "string",
    "sections": [ … ],
    "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Update branch service (admin only)

Request

Security
BearerAuth
Path
idstring(uuid)required
Bodyapplication/jsonrequired
titlestring[ 1 .. 100 ] characters
descriptionstring[ 1 .. 1000 ] characters
sectionsArray of objects(Section)[ 1 .. 20 ] items
curl -i -X PUT \
  'https://api-docs.pearlchaplaincy.org/_mock/openapi/branch-service/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "string",
    "sections": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "title": "string",
        "type": "list",
        "items": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "content": "string"
          }
        ],
        "content": "string"
      }
    ]
  }'

Responses

Branch service updated

Bodyapplication/json
codestringrequired
messagestringrequired
dataobject(BranchServiceResource)required
data.​idstring(uuid)required
data.​titlestringrequired
data.​descriptionstringrequired
data.​sectionsArray of objects(Section)required
data.​sections[].​idstring(uuid)
data.​sections[].​titlestring[ 1 .. 100 ] charactersrequired
data.​sections[].​typestringrequired
Enum"list""richtext"
data.​sections[].​itemsArray of objects(SectionItem)<= 50 items
data.​sections[].​contentstring<= 20000 characters
data.​memberIdstring or null
Any of:
string(uuid)
data.​createdAtstring(date-time)required
data.​updatedAtstring(date-time)required
Response
application/json
{
  "code": "string",
  "message": "string",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "description": "string",
    "sections": [ … ],
    "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Delete branch service (admin only)

Request

Security
BearerAuth
Path
idstring(uuid)required
curl -i -X DELETE \
  'https://api-docs.pearlchaplaincy.org/_mock/openapi/branch-service/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Branch service deleted

Response
No content

Offices

Office title management

Operations