Eksternt Manifest API

Transkript

1 Eksternt Manifest API URL TRANSPORTATION COMPANY /transportation-company /transportation-company/{transportationcompanyid} MANIFEST /manifest /manifest /manifest/{manifestid} /manifest/{manifestid} /manifest/{manifestid} /manifest/{id}/validation TYPE OF MEANS OF TRANSPORT /type-of-means-of-transport/ HTTP METODE Beskrivelse ENG: Get all transportation companies for which the logged in user is a customs representative NOR: Hent alle transportfirmaer som du eller du på vegne av har adgang til ENG:Get specified transportation company among those the user is representative for NOR:Hent et spesifikt transportfirma ENG: Create manifest and supply initial values, with reference to previously created active means of transport (see Active means of transport API) NOR: Innsending av hele eller deler av et manifest. Kan ferdigstilles i Tollvesenets klient eller med nye API-kall (se /manifest/(manifestid)) ENG: Get all manifests. Use parameters to filter on manifest status, release status, and / or departure status and specifying an optional offset and optional limit. NOR: Hent ut alle manifestene du har tilgang på. Kan filtreres på en del URL-parametere (se detaljert API-dokumentasjon) ENG: Fetch a specified previously created manifest by manifest ID. NOR: Hent et spesifikt manifest ENG: Delete a specified previously created manifest by manifest ID. NOR: Slett manifest med id =? ENG: Update a previously created manifest with new values. NOR: Oppdater manifest med id =? ENG: Validate a manifest NOR: Valider manifest ENG: Get valid types of means of transport represented by a list of code values and descriptions NOR: Hent alle transport-typer som er gyldige (Eksempelvis: Kjøretøy uten henger, med henger osv..)

2 /type-of-means-of-transport/{code} COUNTRY /country /country/{id} ACTIVE MEANS OF TRANSPORT / / / PASSiVE MEANS OF TRANSPORT /passive-means-of-transport /passive-means-of-transport ENG: Get a the description of a type of means of transport represented by a specified code value. NOR: Hent beskrivelse og antall eventuelle lastbærere for transport-type ENG: Fetch all countries supported by the API, note that the supplied response is just a sample and does not reflect all the actual countries supported NOR: Hent alle gyldige land ENG: Fetch a single country by it s 2 digit unique country code id (ISO alpha-2) NOR: Hent land med lankode (landkoden består av to bokstaver (følger ISO alpha-2) ENG: Create active means of transport and supply initial values NOR: Opprett trekkvogn for manifest med id =? ENG: Get a specified previously created active means of transport by active means of transport ID. NOR: Hent trekkvogn for manifest ENG: Delete a specified previously created active means of transport by active means of transport ID. NOR: Slett trekkvogn for manifest med id =? ENG: Update a previously created active means of transport with new values for provided fields. NOR: Oppdater trekkvogn for manifest med id =? ENG: Create passive-means-of-transport and supply initial values NOR: Opprett lastbærer for manifest ENG: Get a all previously created passive-means-of-transports for active means of transport registered on manifest. NOR: Hent alle lastbærere for gitt trekkvogn på manifest

3 /passive-means-of-transport/{id} /passive-means-of-transport/{id} /passive-means-of-transport/{id} CARGO LINES /manifest/{manifestid}/cargo-line /manifest/{manifestid}/cargo-line /manifest/{manifestid}/cargo-line/{cargolineid} /manifest/{manifestid}/cargo-line/{cargolineid} /manifest/{manifestid}/cargo-line/{cargolineid} EXPORTS /manifest/{manifestid}/cargo-line/{cargolineid}/export ENG: Get a specified previously created passive-means-of-transport for active means of transport registered on manifest. NOR: Hent en spesifikk lastbærer f or gitt trekkvogn på manifest med id =? ENG: Delete a specified previously created passive-means-of-transport by passive-means-of-transport ID. NOR: Slett en spesifikk lastbærer fo r gitt trekkvogn på manifest med id=? ENG: Update a previously created passive means of transport with new values for provided fields. NOR: Oppdater en spesifikk lastbærer for gitt trekkvogn på manifest ENG: Create a cargo line with a complete declaration ID (number, date and sequence number). Gross mass, number of packages and consignee pertaining to the declaration will be populated for the cargo line, given that the declaration exists in the declaration system. NOR: Opprett en lastelinje med en gyldig deklarasjons-id (deklarasjonsnummer, dato og sekvensnummer). Deklarasjons-id må finnes i TVINN ENG: Get all cargo lines for a given manifest NOR: Hent alle lastelinjer for ett manifest med id =? ENG: Get a specific cargo line for a given manifest NOR: Hent en spesifikk lastelinje med id =? for ett manifest med id =? ENG: Patch a cargo line for a given manifest NOR: Oppdater en spesifikk lastelinje med id =? for ett manifest med id =? ENG: Delete a cargo line NOR: Slett en spesifikk lastelinje med id =? for ett manifest ENG: Create an export for cargo line with id on manifest with id NOR: Opprett en eksport for id=?

4 /manifest/{manifestid}/cargo-line/{cargolineid}/export /manifest/{manifestid}/cargo-line/{cargolineid}/export/{exportid} /manifest/{manifestid}/cargo-line/{cargolineid}/export/{exportid} /manifest/{manifestid}/cargo-line/{cargolineid}/export/{exportid} MODE OF TRANSPORTS /mode-of-transport/ /mode-of-transport/{code} ORGANIZATION IDENTIFICATION TYPE /organization-id-type/ /organization-id-type/{code} USER /user PLACE OF ENTRY /place-of-entry/ ENG: Get all exports for a given manifest and cargo line NOR: Hent alle eksporter for id =? ENG: Fetch a single export for a given manifest and cargo line NOR: Hent en eksport med id for id =? ENG: Patch a single export given a manifest and cargo line NOR: Oppdater en eksport med id for lastelinje med id =? for manifest ENG: Delete an export for a given manifest and cargo line NOR: Slett en eksport med id for id =? ENG: Get valid types of transportation represented by a list of code values and descriptions NOR: Hent alle gyldige transportmetoder (Kun BIL - (30) Bil veitransport er gyldig i dag) ENG: Get a the description of a mode of transportation represented by a specified code value. NOR: Hent beskrivelse for transportmetode med kode =? ENG: Get valid types of organization id represented by a list of code values and descriptions NOR: Hent alle gyldige organisasjons-id-typer ENG: Get a the description of a type of organization id represented by a specified code value. NOR: Hent beskrivelse for organisasjonstype med code=? ENG: Gets information about the authenticated user based on the token in the Authorization header. NOR: Hent ut brukerinformasjon for autentisert bruker (fra token) ENG: Gets all valid places of entry. NOR: Hent ut alle gyldige innpasseringssteder (i dag er kun Ørje (0206) gyldig)

5 /place-of-entry/{code} SUMMARY /summary /summary-preview ENG: Gets a place of entry represented by a specified code. NOR: Hent beskrivelse for innpasseringssted med kode =? ENG: Send summary of submitted or completed manifest to recipients NOR: Send oppsummering som PDF til listen med mailadresser ENG: Get a summary preview of submitted or completed manifest that would be sent to recipients NOR: Hent forhåndsvisning av soppsummering for PDF som kan sendes til mailadresser Felt Type Beskrivelse ENG TRANSPORTATION COMPANY transportationcompanies[].id Number The id of the transportation company. transportationcompanies[].name String The name of the transportation company. MANIFEST placeofentrycode String The place at which the transport carrying the declared goods belonging to the manifest will cross the border. estimatedtimeofarrival String An ISO-8601 formatted date time string representing the time at which the transport carrying the declared goods belonging to the manifest will cross the border. modeoftransportcode String Code value for mode of transport used when crossing the border. name String The name given to the manifest to help identifying it status String The current status of the manifest, where DRAFT only requires transportationcompanyid, otherwise all fields are required. Valid status values are: [DRAFT, SUBMITTED, COMPLETED] transportationcompanyid Number (Required) The id of the transportation company legally responsible for the manifest. manifestid Number The unique manifest identifier. timeofregistration String The time at which the manifest was created. timeofsubmission String The time at which the manifest was submitted for processing. timeofdeparture String The time at which the active means of transport pertaining to the manifest crossed the border. If the active means of transport has yet to cross the border, this property is not defined. timeofrelease String The time at which the declarations pertaining to the manifest have been processed and released. lastchanged String The time at which any field(s) associated with the manifest was last updated. _embedded.transportationcompany Object The embedded transportation company responsible for the manifest. _embedded.cargolines Object The embedded cargo lines of the manifest

6 _embedded.modeoftransport Object The embedded transportatin type of the manifest TYPE OF MEANS OF TRANSPORT code String The code (ID) for this type of means of transport description String The description of this type of means of transport numberofpassivemeansoftransports Number The number of load passive_means_of_transports allowed for this type of means of transport ACTIVE MEANS OF TRANSPORT typeofmeansoftransport String This is a code identifying type of means of transport used. identificationcode String This is the identification code of the active means of transport used. countrycode String This is the country code of the active means of transport. ownerofmeansoftransport Object The owner of the active means of transport registered on the manifest. driver Object The driver of the active means of transport registered on the manifest. _embedded.country Object The passive means of transport s country of origin PASSIVE MEANS OF TRANSPORT identificationcode String This is the registration number (shown on the number plate) of the passive means of transport used. countrycode String This is the country the passive-means-of-transport is registered. _embedded.country Object The load passive_means_of_transport s country of origin CARGO LINES cargolineid Number The ID of the cargo line descriptionofgoods String The description of this cargo line grossmass Number The gross mass of the cargo numberofpackages Number The number of packages the cargo contains placeofloading String The place the cargo was loaded countryofloading String The country code of the country where the cargo was loaded placeofunloading String The place where the cargo will be unloaded import Object The import information of the given cargo line _embedded.importdeclaration Object The embedded import declaratin of the cargo line _embedded.exports Object The embedded exports of the cargo line EXPORT typeofexport String The code of the type of the export exportid String The id of the export exportcertificate Boolean Wether or not the export should result in an export certificate being sent to Swedish Customs MODE OF TRANSPORT code String The code (ID) for this type of transportation

7 description String The description of this type of transportation ORGANIZATION IDENTIFICATION TYPE code String The code (ID) value for this type of identification description String The description of this type of identification _embedded.organizationidtypes Array List of identification types _embedded.organizationidtypes[].code String The code (ID) value for this type of identification _embedded.organizationidtypes[].description String The description of this type of identification USER userid Number The user s identificator username String The user s username name String The user s name String The user s company String The user s company PLACE OF ENTRY code String The code representing the place of entry name String The name of the place of entry SUMMARY summaryrecipients Array A list of recipients of the summary. (i.e adresses)