Contract Management | Contractual Plan Model

Service to manage entities of type 'ContractualPlanModel'.

Overview

URL	api/{tenantKey}/{orgKey}/contractManagement/contractualPlanModels
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET ContractualPlanModels
  • GET ContractualPlanModels (paged)
  • GET ContractualPlanModel by identifier
  • GET ContractualPlanModel by key
  • GET Print ContractualPlanModel by identifier
  • GET Print ContractualPlanModel by key
  • GET Original Print ContractualPlanModelOriginal by identifier
  • GET Original Print ContractualPlanModel by key
• POST:
  • POST ContractualPlanModels
  • POST Contractual Plan Model
• PUT:
  • PUT Set IsActive ContractualPlanModel
  • PUT Set ContractualPlanModelKey ContractualPlanModel
  • PUT Set Name ContractualPlanModel
  • PUT Set TrialPeriodDays ContractualPlanModel
  • PUT Set WorkTimeDuration ContractualPlanModel
  • PUT Set AppliesTo ContractualPlanModel
  • PUT Set ContractType ContractualPlanModelDetail
  • PUT Set Duration ContractualPlanModelDetail
  • PUT Set EmployeeExpiryPriorNotice ContractualPlanModelDetail
  • PUT Set CompanyExpiryPriorNotice ContractualPlanModelDetail
  • PUT Set TypeContract ContractualPlanModelDetail
  • PUT Set DurationInDays ContractualPlanModelDetail
• DELETE:
  • DELETE Contractual Plan Model Detail by identifier
  • DELETE ContractualPlanModel by identifier
  • DELETE ContractualPlanModel by key

All Resources

This service uses the following resources:

• ApiContractualPlanModelContractualPlanModelDetailsResource
• ApiContractualPlanModelResource
• ContractualPlanModelDetailResource
• ContractualPlanModelResource

All Enumerations

This service uses the following enumerations:

• ContractKind
• TypeContract
• WorkTimeDuration

GET Operations

GET ContractualPlanModels

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET ContractualPlanModels (paged)

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

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 ContractualPlanModelResource.

Response status codes:

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

Resource URL:

GET ContractualPlanModel 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 ContractualPlanModelResource.

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:

GET ContractualPlanModel by key

Returns the entity record that matches the specified key.

The following elements are required:

contractualPlanModelKey

(string) Contractual Plan Model.

Response:

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

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:

GET Print ContractualPlanModel by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Print ContractualPlanModel by key

Prints the specified entity record.

The following elements are required:

contractualPlanModelKey

(string) Contractual Plan Model.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

GET Original Print ContractualPlanModelOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Original Print ContractualPlanModel by key

Prints the specified entity record.

The following elements are required:

contractualPlanModelKey

(string) Contractual Plan Model.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

POST Operations

POST ContractualPlanModels

Creates a new entity record.

The following elements are required:

contractualPlanModelResource

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

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 ApiContractualPlanModelResource.

Response status codes:

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

Resource URL:

POST Contractual Plan Model

Inserts a new 'Contractual Plan Model Detail' in the 'Contractual Plan Model'.

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
value	(ApiContractualPlanModelContractualPlanModelDetailsResource) The ApiContractualPlanModelContractualPlanModelDetailsResource instance. See ApiContractualPlanModelContractualPlanModelDetailsResource.

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:

PUT Operations

PUT Set AppliesTo ContractualPlanModel

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
value	(enum ContractKind) The request body should contain the new value for the attribute. See ContractKind.

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:

PUT Set CompanyExpiryPriorNotice ContractualPlanModelDetail

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
lineId	(string) The detail identifier.
value	(int) 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:

PUT Set ContractType ContractualPlanModelDetail

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
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:

PUT Set ContractualPlanModelKey ContractualPlanModel

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
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:

PUT Set Duration ContractualPlanModelDetail

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
lineId	(string) The detail identifier.
value	(int) 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:

PUT Set DurationInDays ContractualPlanModelDetail

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
lineId	(string) The detail identifier.
value	(int) 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:

PUT Set EmployeeExpiryPriorNotice ContractualPlanModelDetail

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
lineId	(string) The detail identifier.
value	(int) 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:

PUT Set IsActive ContractualPlanModel

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
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:

PUT Set Name ContractualPlanModel

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
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:

PUT Set TrialPeriodDays ContractualPlanModel

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
value	(int) 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:

PUT Set TypeContract ContractualPlanModelDetail

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
lineId	(string) The detail identifier.
value	(enum TypeContract) The request body should contain the new value for the attribute. See TypeContract.

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:

PUT Set WorkTimeDuration ContractualPlanModel

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

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
value	(enum WorkTimeDuration) The request body should contain the new value for the attribute. See WorkTimeDuration.

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:

DELETE Operations

DELETE Contractual Plan Model Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
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:

DELETE ContractualPlanModel 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:

DELETE ContractualPlanModel by key

Deletes the entity record that matches the specified key.

The following elements are required:

contractualPlanModelKey

(string) Contractual Plan Model.

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:

Resources

ApiContractualPlanModelContractualPlanModelDetailsResource

The following elements are required:

contractType

(string) Stage.

The following elements are optional:

duration	(int) Est. Duration.
employeeExpiryPriorNotice	(int) Emp. EPN.
companyExpiryPriorNotice	(int) Comp. EPN.
typeContract	(enum TypeContract) Type Contract. See TypeContract.
durationInDays	(int) Est. Duration In Days.

ApiContractualPlanModelResource

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
name	(string) Name.
trialPeriodDays	(int) Trial Period Days.
workTimeDuration	(enum WorkTimeDuration) Work Time Duration. See WorkTimeDuration.
appliesTo	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

contractualPlanModelDetails

(List of ApiContractualPlanModelContractualPlanModelDetailsResource) Contractual Plan Model Details. See ApiContractualPlanModelContractualPlanModelDetailsResource.

ContractualPlanModelDetailResource

The following elements are required:

contractType

(string) Stage.

The following elements are optional:

duration	(int) Est. Duration.
employeeExpiryPriorNotice	(int) Emp. EPN.
companyExpiryPriorNotice	(int) Comp. EPN.
typeContract	(enum TypeContract) Type Contract. See TypeContract.
durationInDays	(int) Est. Duration In Days.

ContractualPlanModelResource

The following elements are required:

contractualPlanModelKey	(string) Contractual Plan Model.
name	(string) Name.
trialPeriodDays	(int) Trial Period Days.
workTimeDuration	(enum WorkTimeDuration) Work Time Duration. See WorkTimeDuration.
appliesTo	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

contractualPlanModelDetails

(List of ContractualPlanModelDetailResource) Contractual Plan Model Details. See ContractualPlanModelDetailResource.

Enumerations

ContractKind

1	Employment
2	Service

TypeContract

1	LimitedTerm
2	Permanent
3	OpenTerm

WorkTimeDuration

1	FullTime
2	PartTime