You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Definition

Organization API can perform functions to interact or exchange data for Organization.


NameDescription
1

Add organization

Add a new organization.

Name

Description
URL/organization
HTTP MethodPOST
Body Parameters
ParameterDescription
idOrganization ID.
nameOrganization name.
descriptionDescription of organization.
Sample Response
{
  "id": "apiTestOrg",
  "name": "API Test Org",
  "description": "This is an organization created by API."
}
2

Delete organization

Delete a organization via organization ID.

Name

Description
URL/organization/{id}
HTTP MethodDELETE
Path Parameters
ParameterDescription
idOrganization ID.
Sample Response
{
  "date": "Wed Aug 28 15:43:58 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
3

Find organization

Gets all organizations by default.

Able to filter or sort the returned results via parameters.

Name

Description
URL/organization/find
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterFilters the response via organization ID.
sort

Organization data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response


4
Get organization by ID


Get details of a organization via organization ID.


Name
Description
URL/organization/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
idOrganization ID.
Sample Response




5
Update organization


Update the details of a organization.


Name
Description
URL/organization
HTTP MethodPUT
Body Parameters
ParameterDescription
idOrganization ID.
nameOrganization name.
descriptionDescription of organization.
Sample Response


{
  "id": "apiTestOrg",
  "name": "API Test Org",
  "description": "This organization is updated via API."
}







                
        
    
        


                        
    





    

	

		
    
    
            
  • 
            No labels
        
    •