Base URL: /tenants/{tenantName}/organizations

 

Get organisation by id

Get specific organisation by integer ID. 

 

URL: /tenants/{tenantName}/organizations/{orgId}

Method: GET

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Response body

{
id: integer (int32)
type: string (Organisation type in Aptem Enum: Employer, Referrer, Training, Other)
companyName: string
noOfEmployees: integer
EDRS: string
}

 

Create organisation

Creates a new organisation.

 

URL: /tenants/{tenantName}/organizations

Method: POST

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant

 

Request body

{
type: string (Organisation type in Aptem Enum: Employer, Referrer, Training, Other)
companyName: string
noOfEmployees: integer
EDRS: string
}

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied

 

Response body

{
id: integer (int32)
type: string (Organisation type in Aptem Enum: Employer, Referrer, Training, Other)
companyName: string
noOfEmployees: integer
EDRS: string
}

 

Update organisation

Updates an existing organisation.

 

URL: /tenants/{tenantName}/organizations/{orgId}

Method: PUT

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to update

 

Request body

{
type: string (Organisation type in Aptem Enum: Employer, Referrer, Training, Other)
companyName: string
noOfEmployees: integer
EDRS: string
}

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Response body

{
id: integer (int32)
type: string (Organisation type in Aptem Enum: Employer, Referrer, Training, Other)
companyName: string
noOfEmployees: integer
EDRS: string
}

 

Delete organisation

Deletes an existing organisation where found.

 

URL: /tenants/{tenantName}/organizations/{orgId}

Method: DELETE

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to delete

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Get organisation address by id

Get specific organisation address by integer ID. 

 

URL: /tenants/{tenantName}/organizations/{orgId}/addresses/{addressId}

Method: GET

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve
addressId	Integer (int32)	Yes	The id of the address to retrieve

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Response body

{
id: integer (int32)
address1: string
address2: string
townCity: string
countyState: string
postCode: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Create organisation address

Creates a new organisation address.

 

URL: /tenants/{tenantName}/organizations/{orgId}/addresses

Method: POST

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve

 

Request body

{
address1: string
address2: string
townCity: string
countyState: string
postCode: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied

 

Response body

{
id: integer (int32)
address1: string
address2: string
townCity: string
countyState: string
postCode: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Update organisation address

Updates an existing organisation address.

 

URL: /tenants/{tenantName}/organizations/{orgId}/addresses/{addressId}

Method: PUT

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve
addressId	Integer (int32)	Yes	The id of the address to retrieve

 

Request body

{
address1: string
address2: string
townCity: string
countyState: string
postCode: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Response body

{
id: integer (int32)
address1: string
address2: string
townCity: string
countyState: string
postCode: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Delete organisation address

Deletes an existing organisation address where found.

 

URL: /tenants/{tenantName}/organizations/{orgId}/addresses/{addressId}

Method: DELETE

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve
addressId	Integer (int32)	Yes	The id of the address to retrieve

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Get organisation contact by id

Get specific organisation contact by integer ID. 

 

URL: /tenants/{tenantName}/organizations/{orgId}/contacts/{contactId}

Method: GET

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve
contactId	Integer (int32)	Yes	The id of the contact to retrieve

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Response body

{
id: integer (int32)
contactName: string
contactEmail: string
contactPhone: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Create organisation contact

Creates a new organisation contact.

 

URL: /tenants/{tenantName}/organizations/{orgId}/contacts

Method: POST

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve

 

Request body

{
contactName: string
contactEmail: string
contactPhone: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied

 

Response body

{
contactName: string
contactEmail: string
contactPhone: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Update organisation contact

Updates an existing organisation contact.

 

URL: /tenants/{tenantName}/organizations/{orgId}/contacts/{contactId}

Method: PUT

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve
contactId	Integer (int32)	Yes	The id of the contact to update

 

Request body

{
id: integer (int32)
contactName: string
contactEmail: string
contactPhone: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found

 

Response body

{
id: integer (int32)
contactName: string
contactEmail: string
contactPhone: string
isPrimary: boolean
organizationId: integer (int32)
}

 

Delete organisation contact

Deletes an existing organisation contact where found.

 

URL: /tenants/{tenantName}/organizations/{orgId}/contacts/{contactId}

Method: DELETE

Parameters:

Name	Type	Required	Description
tenantName	String	Yes	The name of the tenant
orgId	Integer (int32)	Yes	The id of the organisation to retrieve
contactId	Integer (int32)	Yes	The id of the contact to delete

 

Responses:

Status code	Status Description
200	Successful operations
400	Invalid input
401	Unauthorised
403	Permission denied
404	Not found