Platform | Company Access Restriction

Service to manage entities of type 'CompanyAccessRestriction'.

This service extends Companies.

Overview

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions

URL	api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
- PUT Set IsActive CompanyAccessRestriction
- PUT Set Group RestrictedGroup
DELETE:

All Resources

This service uses the following resources:

ApiBaseCompanyAccessRestrictionResource
ApiBaseCompanyAccessRestrictionRestrictedGroupsResource
ApiCompanyAccessRestrictionResource
ApiCompanyAccessRestrictionRestrictedGroupsResource
BaseCompanyAccessRestrictionResource
BaseCompanyAccessRestrictionRestrictedGroupsResource
CompanyAccessRestrictionResource

GET Operations

GET CompanyAccessRestrictions (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See CompanyAccessRestrictionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/extension/odata

GET /identity/companyAccessRestrictions/extension/odata

GET CompanyAccessRestriction by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See CompanyAccessRestrictionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{id}/extension

GET /identity/companyAccessRestrictions/{id}/extension

GET CompanyAccessRestriction by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey

(string) The key for de company.

Response:

When successful, the response body contains the entity record. See CompanyAccessRestrictionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{companyKey}/extension

GET /identity/companyAccessRestrictions/{companyKey}/extension

GET CompanyAccessRestrictions (with Company)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

When successful, the response body contains the list of records available. See BaseCompanyAccessRestrictionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions

GET /identity/companyAccessRestrictions

GET CompanyAccessRestrictions (with Company) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See BaseCompanyAccessRestrictionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions?page={page}&pageSize={pageSize}

GET /identity/companyAccessRestrictions?page={page}&pageSize={pageSize}

GET CompanyAccessRestriction (with Company) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See BaseCompanyAccessRestrictionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{id}

GET /identity/companyAccessRestrictions/{id}

GET CompanyAccessRestriction (with Company) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

The following elements are required:

companyKey

(string) The key for de company.

Response:

When successful, the response body contains the entity record. See BaseCompanyAccessRestrictionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{companyKey}

GET /identity/companyAccessRestrictions/{companyKey}

POST Operations

POST CompanyAccessRestrictions

Creates a new entity record.

The following elements are required:

companyAccessRestrictionResource

(ApiCompanyAccessRestrictionResource) The request body should contain the entity record that should be created.
See ApiCompanyAccessRestrictionResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCompanyAccessRestrictionResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/extension

POST /identity/companyAccessRestrictions/extension

POST CompanyAccessRestrictions (with ApiBaseCompanyAccessRestriction)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

companyAccessRestrictionResource

(ApiCompanyAccessRestrictionResource) The request body should contain the entity record that should be created.
See ApiCompanyAccessRestrictionResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBaseCompanyAccessRestrictionResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions

POST /identity/companyAccessRestrictions

POST Restricted Group

Inserts a new 'Restricted Group' in the 'Company Access Restriction'.

The following elements are required:

companyKey	(string) The key for de company.
value	(ApiCompanyAccessRestrictionRestrictedGroupsResource) The ApiCompanyAccessRestrictionRestrictedGroupsResource instance. See ApiCompanyAccessRestrictionRestrictedGroupsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{companyKey}/restrictedGroups

POST /identity/companyAccessRestrictions/{companyKey}/restrictedGroups

PUT Operations

PUT Set Group RestrictedGroup

Updates the value of attribute 'Group' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{companyKey}/restrictedGroups/{lineId}/group

PUT /identity/companyAccessRestrictions/{companyKey}/restrictedGroups/{lineId}/group

PUT Set IsActive CompanyAccessRestriction

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{companyKey}/isActive

PUT /identity/companyAccessRestrictions/{companyKey}/isActive

DELETE Operations

DELETE Restricted Group by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

companyKey	(string) The key for de company.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{companyKey}/restrictedGroups/{lineId}

DELETE /identity/companyAccessRestrictions/{companyKey}/restrictedGroups/{lineId}

DELETE CompanyAccessRestriction by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{id}

DELETE /identity/companyAccessRestrictions/{id}

DELETE CompanyAccessRestriction by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey

(string) The key for de company.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/companyAccessRestrictions/{companyKey}

DELETE /identity/companyAccessRestrictions/{companyKey}

Resources

ApiBaseCompanyAccessRestrictionResource

The following elements are required:

companyKey	(string) The key for de company.
name	(string) The company's name.
companyTaxID	(string) The company's tax identifier.
country	(string) The company's country.
baseCurrency	(string) The company's base currency.

The following elements are optional:

restrictedGroups	(List of ApiBaseCompanyAccessRestrictionRestrictedGroupsResource) Restricted Groups. See ApiBaseCompanyAccessRestrictionRestrictedGroupsResource.
isExternal	(bool) Is External.
showExchangeRateReversed	(bool) Indicates wheter the exchange rate for the base currency is presented with reversed logic.
searchTerm	(string) Search Term.
telephone	(string) The company's telephone.
teleFax	(string) The company's telefax.
mobile	(string) The company's mobile.
electronicMail	(string) The company's electronic mail.
equityCapital	(string) The equity capital is defined as the amount of capital provided by the company's owner(s).
registrationOffice	(string) The company's registration office.
registrationNumber	(string) The company's registration number.
buildingNumber	(string) The company's building number.
streetName	(string) The company's street name.
cityName	(string) The company's city name.
postalZone	(string) The company's postal code.
address	(string) The company's address.
logo	(string) The company's image.
forceFromOrganizationConfiguration	(bool) Force From Configuration.
companyRegistrationData	(string) Company Registration Data.

ApiBaseCompanyAccessRestrictionRestrictedGroupsResource

The following elements are required:

group

(string) Group.

ApiCompanyAccessRestrictionResource

The following elements are required:

companyKey

(string) The key for de company.

The following elements are optional:

restrictedGroups

(List of ApiCompanyAccessRestrictionRestrictedGroupsResource) Restricted Groups.
See ApiCompanyAccessRestrictionRestrictedGroupsResource.

ApiCompanyAccessRestrictionRestrictedGroupsResource

The following elements are required:

group

(string) Group.

BaseCompanyAccessRestrictionResource

The following elements are required:

companyKey	(string) The key for de company.
name	(string) The company's name.
companyTaxID	(string) The company's tax identifier.
country	(string) The company's country.
baseCurrency	(string) The company's base currency.

The following elements are optional:

restrictedGroups	(List of BaseCompanyAccessRestrictionRestrictedGroupsResource) Restricted Groups. See BaseCompanyAccessRestrictionRestrictedGroupsResource.
isExternal	(bool) Is External.
showExchangeRateReversed	(bool) Indicates wheter the exchange rate for the base currency is presented with reversed logic.
searchTerm	(string) Search Term.
telephone	(string) The company's telephone.
teleFax	(string) The company's telefax.
mobile	(string) The company's mobile.
electronicMail	(string) The company's electronic mail.
equityCapital	(string) The equity capital is defined as the amount of capital provided by the company's owner(s).
registrationOffice	(string) The company's registration office.
registrationNumber	(string) The company's registration number.
buildingNumber	(string) The company's building number.
streetName	(string) The company's street name.
cityName	(string) The company's city name.
postalZone	(string) The company's postal code.
address	(string) The company's address.
logo	(string) The company's image.
forceFromOrganizationConfiguration	(bool) Force From Configuration.
companyRegistrationData	(string) Company Registration Data.

BaseCompanyAccessRestrictionRestrictedGroupsResource

The following elements are required:

group

(string) Group.

CompanyAccessRestrictionResource

The following elements are required:

companyKey

(string) The key for de company.

The following elements are optional:

restrictedGroups

(List of RestrictedGroupResource) Restricted Groups.
See RestrictedGroupResource.