Expedition site

Endpoints

Create new expedition site

/expedition-sites

Description

Returns created expedition site.

Parameters

Type Name Description Schema

Body

body
required

ExpeditionSite

Responses

HTTP Code Description Schema

201

Successfully created

ExpeditionSite

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/expedition-sites

Description

Returns entities.

Parameters

Type Name Description Schema

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< ExpeditionSite > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/expedition-sites/import

Parameters

Type Name Description Schema

Body

body
required

ImportExpeditionSiteList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get one expedition site

/expedition-sites/{code}

operation.deprecated

Description

Returns retrieved expedition site.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

10 characters max

Responses

HTTP Code Description Schema

200

Successful

ExpeditionSite

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete expedition site

/expedition-sites/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

10 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

ExpeditionSite

Description of an expedition site.

Name Description Value Business Values

code
required

Expedition site code

string

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

companyCode
optional

Current company code

string

2 characters max

depositCode
required

Expedition site deposit code

string

establishmentCode
optional (required - if companyCode filled)

Current establishment code

string

2 characters max

label
required

Expedition site label

string

50 characters max

publicUuid
optional
read-only

Expedition site public uuid

string

validityEndDate
optional

datetime

YYYY-MM-DDTHH:MM:SSZ
Set a passed date to make the entity inactive.

ImportExpeditionSiteList

Name Value

callback
optional

string

data
optional

ExpeditionSite list