Organization Service

Description

Manage (query, add, update, delete) organization records.

Technique

• Spring Data JPA
• Netflix Feign
• Netflix Eureka
• OAuth2

Available API Calls

OS1: Get an organization record by organizatiion ID.

• URL: http://localhost:8060/v1/organizations/{organizationId}
• Method: GET
• Parameters:
  • organizationId: The organization ID for looking up.
• Headers

KEY	VALUE
Authorization	Bearer {access_token}

• Body
• Notes:
  • Because of the organization service is protected and only be accessible with the valid access token, you need to add a valid access token to the header of this call.

OS2: Update an organization record by organization ID.

• URL: http://localhost:8060/v1/organizations/{organizationId}
• Method: PUT
• Parameters:
  • organizationId: The organization ID for looking up.
• Headers

KEY	VALUE
Authorization	Bearer {access_token}
Content-Type	application/json

• Body

{
   "id": "e254f8c-c442-4ebe-a82a-e2fc1d1ff78a",
   "name": "customer-crm-co",
   "contactName": "Mark Balster",
   "contactEmail": "[email protected]",
   "contactPhone": "832-555-2222"
}

• Notes:
  • Because of the organization service is protected and only be accessible with the valid access token, you need to add a valid access token to the header of this call.
  • After the organization service received this request, it will insert a new message into Kafka message queue to notify the licensing service that there is an update for the organization record.

OS3: Add a new organization record.

• URL: http://localhost:8060/v1/organizations/{organizationId}
• Method: POST
• Parameters
• Headers

KEY	VALUE
Authorization	Bearer {access_token}
Content-Type	application/json

• Body

{
   "id": "e254f8c-c442-4ebe-a82a-e2fc1d1ff78a",
   "name": "customer-crm-co",
   "contactName": "Mark Balster",
   "contactEmail": "[email protected]",
   "contactPhone": "832-555-2222"
}

• Notes:
  • Because of the organization service is protected and only be accessible with the valid access token, you need to add a valid access token to the header of this call.
  • After the organization service received this request, it will insert a new message into Kafka message queue to notify the licensing service that there is an update for the organization record.

OS4: Delete an organization record by organization ID.

• URL: http://localhost:8060/v1/organizations/{organizationId}
• Method: DELETE
• Parameters
  • organizationId: The organization ID for identifying the record needs to be deleted.
• Headers

KEY	VALUE
Authorization	Bearer {access_token}

• Body
• Notes:
  • Because of the organization service is protected and only be accessible with the valid access token, you need to add a valid access token to the header of this call.
  • After the organization service received this request, it will insert a new message into Kafka message queue to notify the licensing service that there is an update for the organization record.

Database Table(s)

• organizations