Master Data Business Entities | Serie

The Serie represents a set of rules for grouping commercial document type numbers in a sequential and time-bound frame.

Overview

api/{tenantKey}/{orgKey}/businessCore/series

URL	api/{tenantKey}/{orgKey}/businessCore/series
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Series
PUT:
DELETE:
- DELETE Serie by identifier
- DELETE Serie by key

All Resources

This service uses the following resources:

ApiSerieResource
SerieResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET Series

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/series

GET /businessCore/series

GET Series (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 SerieResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/series?page={page}&pageSize={pageSize}

GET /businessCore/series?page={page}&pageSize={pageSize}

GET Serie 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 SerieResource.

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}/businessCore/series/{id}

GET /businessCore/series/{id}

GET Serie by key

Returns the entity record that matches the specified key.

The following elements are required:

serieKey

(string) The key for the serie. Uniquely identifies the serie within the organization.

Response:

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

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}/businessCore/series/{serieKey}

GET /businessCore/series/{serieKey}

GET Print Serie 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:

api/{tenantKey}/{orgKey}/businessCore/series/{id}/print?template={template}

GET /businessCore/series/{id}/print?template={template}

GET Print Serie by key

Prints the specified entity record.

The following elements are required:

serieKey

(string) The key for the serie. Uniquely identifies the serie within the organization.

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:

api/{tenantKey}/{orgKey}/businessCore/series/{serieKey}/print

GET /businessCore/series/{serieKey}/print

GET Original Print SerieOriginal 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:

api/{tenantKey}/{orgKey}/businessCore/series/{id}/printOriginal?template={template}

GET /businessCore/series/{id}/printOriginal?template={template}

GET Original Print Serie by key

Prints the specified entity record.

The following elements are required:

serieKey

(string) The key for the serie. Uniquely identifies the serie within the organization.

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:

api/{tenantKey}/{orgKey}/businessCore/series/{serieKey}/printOriginal

GET /businessCore/series/{serieKey}/printOriginal

GET The service is used to get an EntitySet of Serie, for the given Series ID's

The service is used to get an EntitySet of Serie, for the given Series ID's.

The following elements are required:

serviceOperationParameter1

(string) Comma separated Guids as strings.

Response:

When successful, the response body contains a list of resources of type 'SerieResource'. See SerieResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/series/getSeriesForRequestedIDs

GET /businessCore/series/getSeriesForRequestedIDs

POST Operations

POST Series

Creates a new entity record.

The following elements are required:

serieResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/series

POST /businessCore/series

PUT Operations

PUT Set Description Serie

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

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
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}/businessCore/series/{serieKey}/description

PUT /businessCore/series/{serieKey}/description

PUT Set EndDate Serie

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

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
value	(DateTime) 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}/businessCore/series/{serieKey}/endDate

PUT /businessCore/series/{serieKey}/endDate

PUT Set EndNumber Serie

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

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
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:

api/{tenantKey}/{orgKey}/businessCore/series/{serieKey}/endNumber

PUT /businessCore/series/{serieKey}/endNumber

PUT Set IsActive Serie

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

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
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}/businessCore/series/{serieKey}/isActive

PUT /businessCore/series/{serieKey}/isActive

PUT Set SerieKey Serie

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

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
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}/businessCore/series/{serieKey}/serieKey

PUT /businessCore/series/{serieKey}/serieKey

PUT Set StartDate Serie

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

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
value	(DateTime) 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}/businessCore/series/{serieKey}/startDate

PUT /businessCore/series/{serieKey}/startDate

PUT Set StartNumber Serie

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

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
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:

api/{tenantKey}/{orgKey}/businessCore/series/{serieKey}/startNumber

PUT /businessCore/series/{serieKey}/startNumber

PUT Set Custom Attribute Serie

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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}/businessCore/series/{serieKey}/{customAttributeName}

PUT /businessCore/series/{serieKey}/{customAttributeName}

DELETE Operations

DELETE Serie 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}/businessCore/series/{id}

DELETE /businessCore/series/{id}

DELETE Serie by key

Deletes the entity record that matches the specified key.

The following elements are required:

serieKey

(string) The key for the serie. Uniquely identifies the serie within the organization.

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}/businessCore/series/{serieKey}

DELETE /businessCore/series/{serieKey}

Resources

ApiSerieResource

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
startNumber	(int) The start number for the serie.
endNumber	(int) The end number for the serie.
startDate	(DateTime) The start date for the serie.
endDate	(DateTime) The end date for the serie.

The following elements are optional:

description

(string) The description for the serie.

SerieResource

The following elements are required:

serieKey	(string) The key for the serie. Uniquely identifies the serie within the organization.
startNumber	(int) The start number for the serie.
endNumber	(int) The end number for the serie.
startDate	(DateTime) The start date for the serie.
endDate	(DateTime) The end date for the serie.
isVisible	(bool) Is Visible.

The following elements are optional:

description

(string) The description for the serie.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.