Jasmin Developers - Web API Reference

Logistics | Memo Reason

Service to manage entities of type 'MemoReason'.

Overview


URL api/{tenantKey}/{orgKey}/logisticsCore/memoReasons
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET MemoReasons (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 MemoReasonResource.

Response status codes:

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

Resource URL:

GET /logisticsCore/memoReasons/odata

GET MemoReason 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 MemoReasonResource.

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 /logisticsCore/memoReasons/{id}

GET MemoReason by key

Returns the entity record that matches the specified key.

The following elements are required:

memoReasonKey (string) The key for the memo reason.

Response:

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

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 /logisticsCore/memoReasons/{memoReasonKey}

POST Operations

POST MemoReasons

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /logisticsCore/memoReasons

PUT Operations

PUT Set Description MemoReason

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

The following elements are required:

memoReasonKey (string) The key for the memo reason.
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 /logisticsCore/memoReasons/{memoReasonKey}/description

PUT Set FiscalIssueReason MemoReason

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

The following elements are required:

memoReasonKey (string) The key for the memo reason.
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 /logisticsCore/memoReasons/{memoReasonKey}/fiscalIssueReason

PUT Set IsActive MemoReason

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

The following elements are required:

memoReasonKey (string) The key for the memo reason.
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 /logisticsCore/memoReasons/{memoReasonKey}/isActive

PUT Set MemoReasonKey MemoReason

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

The following elements are required:

memoReasonKey (string) The key for the memo reason.
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 /logisticsCore/memoReasons/{memoReasonKey}/memoReasonKey

DELETE Operations

DELETE MemoReason 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 /logisticsCore/memoReasons/{id}

DELETE MemoReason by key

Deletes the entity record that matches the specified key.

The following elements are required:

memoReasonKey (string) The key for the memo reason.

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 /logisticsCore/memoReasons/{memoReasonKey}

Resources


ApiMemoReasonResource

The following elements are required:

memoReasonKey (string) The key for the memo reason.
description (string) The description for the memo reason.

The following elements are optional:

fiscalIssueReason (string) Tax Issue Reason.


MemoReasonResource

The following elements are required:

memoReasonKey (string) The key for the memo reason.
description (string) The description for the memo reason.

The following elements are optional:

fiscalIssueReason (string) Tax Issue Reason.
(fk) Allowed value: the natural key of a record of type FiscalIssueReason. These records are accessibly through the FiscalIssueReasons service.