SJAM Records

SJAM record management operations

Get SJAM record

get

https://api.example.com/v1https://staging-api.example.com/v1

/sjam/record

Retrieve SJAM record by ID and full name

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sjamIdstringRequired

SJAM member ID

fullNamestringRequired

Full name of the member

Responses

200

SJAM record retrieved successfully

application/json

400

Validation error

application/json

404

SJAM record not found

application/json

500

Internal server error

application/json

get

/sjam/record

HTTPcURLJavaScriptPython

GET /v1/sjam/record?sjamId=text&fullName=text HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "SJAM record found",
  "data": {
    "sjamId": "text",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "memberState": "text",
    "area": "text",
    "section": "text",
    "membershipType": "text",
    "dateOfIssue": "2025-12-16",
    "position": "text",
    "rankMarking": "text",
    "dateOfAssignment": "2025-12-16",
    "status": "text",
    "unit": "text",
    "rank": "text",
    "comment": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:57:22.612Z",
    "updatedAt": "2025-12-16T02:57:22.612Z"
  }
}

Add SJAM record

post

https://api.example.com/v1https://staging-api.example.com/v1

/sjam/record

Add a new SJAM record

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

sjamIdstringRequired

SJAM member ID

Example: SJAM001

fullNamestringRequired

Full name of the member

Example: John Doe

Responses

201

SJAM record added successfully

application/json

400

Validation error

application/json

409

Duplicate member code

application/json

500

Internal server error

application/json

post

/sjam/record

HTTPcURLJavaScriptPython

POST /v1/sjam/record HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "sjamId": "SJAM001",
  "fullName": "John Doe"
}

{
  "success": true,
  "message": "SJAM record added successfully",
  "data": {
    "sjamId": "text",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "memberState": "text",
    "area": "text",
    "section": "text",
    "membershipType": "text",
    "dateOfIssue": "2025-12-16",
    "position": "text",
    "rankMarking": "text",
    "dateOfAssignment": "2025-12-16",
    "status": "text",
    "unit": "text",
    "rank": "text",
    "comment": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:57:22.612Z",
    "updatedAt": "2025-12-16T02:57:22.612Z"
  }
}

Update SJAM record

put

https://api.example.com/v1https://staging-api.example.com/v1

/sjam/record

Update an existing SJAM record

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

sjamIdstringRequired

SJAM member ID

Example: SJAM001

fullNamestringRequired

Full name of the member

Example: John Doe

Responses

200

SJAM record updated successfully

application/json

400

Validation error

application/json

404

Record not found

application/json

500

Internal server error

application/json

put

/sjam/record

HTTPcURLJavaScriptPython

PUT /v1/sjam/record HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "sjamId": "SJAM001",
  "fullName": "John Doe"
}

{
  "success": true,
  "message": "Record updated successfully",
  "data": {
    "sjamId": "text",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "memberState": "text",
    "area": "text",
    "section": "text",
    "membershipType": "text",
    "dateOfIssue": "2025-12-16",
    "position": "text",
    "rankMarking": "text",
    "dateOfAssignment": "2025-12-16",
    "status": "text",
    "unit": "text",
    "rank": "text",
    "comment": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:57:22.612Z",
    "updatedAt": "2025-12-16T02:57:22.612Z"
  }
}

Delete SJAM record

delete

https://api.example.com/v1https://staging-api.example.com/v1

/sjam/record

Delete a SJAM record

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

sjamIdstringRequired

SJAM member ID

Example: SJAM001

fullNamestringRequired

Full name of the member

Example: John Doe

Responses

200

SJAM record deleted successfully

application/json

400

Validation error

application/json

404

Record not found

application/json

500

Internal server error

application/json

delete

/sjam/record

HTTPcURLJavaScriptPython

DELETE /v1/sjam/record HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "sjamId": "SJAM001",
  "fullName": "John Doe"
}

{
  "success": true,
  "message": "SJAM record deleted successfully",
  "data": {
    "sjamId": "text",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "memberState": "text",
    "area": "text",
    "section": "text",
    "membershipType": "text",
    "dateOfIssue": "2025-12-16",
    "position": "text",
    "rankMarking": "text",
    "dateOfAssignment": "2025-12-16",
    "status": "text",
    "unit": "text",
    "rank": "text",
    "comment": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:57:22.612Z",
    "updatedAt": "2025-12-16T02:57:22.612Z"
  }
}

Get all SJAM records

get

https://api.example.com/v1https://staging-api.example.com/v1

/sjam/records

Retrieve all SJAM records with filtering and pagination

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sjamIdstringOptional

Filter by SJAM ID

fullNamestringOptional

Filter by full name

statestringOptional

Filter by state

statusstringOptional

Filter by status

rankstringOptional

Filter by rank

unitstringOptional

Filter by unit

positionstringOptional

Filter by position

areastringOptional

Filter by area

startDatestring · dateOptional

Start date filter

endDatestring · dateOptional

End date filter

commentstringOptional

Filter by comment

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

Responses

200

SJAM records retrieved successfully

application/json

404

No SJAM records found

application/json

500

Internal server error

application/json

get

/sjam/records

HTTPcURLJavaScriptPython

GET /v1/sjam/records HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "SJAM records retrieved successfully",
  "data": [
    {
      "sjamId": "text",
      "fullName": "text",
      "memberCode": "text",
      "title": "text",
      "gender": "text",
      "occupation": "text",
      "icNo": "text",
      "dateOfBirth": "2025-12-16",
      "race": "text",
      "address1": "text",
      "postcode": "text",
      "state": "text",
      "memberState": "text",
      "area": "text",
      "section": "text",
      "membershipType": "text",
      "dateOfIssue": "2025-12-16",
      "position": "text",
      "rankMarking": "text",
      "dateOfAssignment": "2025-12-16",
      "status": "text",
      "unit": "text",
      "rank": "text",
      "comment": "text",
      "createdBy": "text",
      "updatedBy": "text",
      "createdAt": "2025-12-16T02:57:22.612Z",
      "updatedAt": "2025-12-16T02:57:22.612Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 10,
    "totalItems": 100,
    "itemsPerPage": 10,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}