GET

Description

Retrieves a list of article URL connections or a single article URL connection.

URL structure

https://api.fortnox.se/3/articleurlconnections/{Id}

Method

GET

Version

3

Response

The article URL connections collection can return a list of records or a single record. By specifying an Id in the URL, a single record will be returned. Not specifying an Id will return a list of records.

<?xml version="1.0" encoding="UTF-8"?>
<ArticleUrlConnections>
    <ArticleURLConnection url="https://api.fortnox.se/3/articleurlconnections/1">
        <Id>1</Id>
        <ArticleNumber>0001</ArticleNumber>
        <URLConnection>https://example.com/images/article-0001.jpg</URLConnection>
    </ArticleURLConnection>

    [...]

    <ArticleURLConnection url="https://api.fortnox.se/3/articleurlconnections/3">
        <Id>3</Id>
        <ArticleNumber>1052</ArticleNumber>
        <URLConnection>https://example.com/images/article-1052.jpg</URLConnection>
    </ArticleURLConnection>
</ArticleUrlConnections>
<?xml version="1.0" encoding="UTF-8"?>
<ArticleUrlConnection url="https://api.fortnox.se/3/articleurlconnections/1">
    <Id>1</Id>
    <ArticleNumber>0001</ArticleNumber>
    <URLConnection>https://example.com/images/article-0001.jpg</URLConnection>
</ArticleUrlConnection>
{
  "ArticleUrlConnections": [
    {
      "@url": "https://api.fortnox.se/3/articleurlconnections/1",
      "Id": 1,
      "ArticleNumber": "0001",
      "URLConnection": "https://example.com/images/article-0001.jpg"
    },

    [...]

    {
      "@url": "https://api.fortnox.se/3/articleurlconnections/3",
      "Id": 3,
      "ArticleNumber": "1052",
      "URLConnection": "https://example.com/images/article-1052.jpg"
    }
  ]
}
{
  "ArticleUrlConnection": {
    "@url": "https://api.fortnox.se/3/articleurlconnections/1",
    "Id": 1,
    "ArticleNumber": "0001",
    "URLConnection": "https://example.com/images/article-0001.jpg"
  }
}

POST

Description

Creates an article URL connection.

URL structure

https://api.fortnox.se/3/articleurlconnections

Method

POST

Version

3

Request

The request body should contain a structure of an article URL connection, either in JSON or XML.
<ArticleURLConnection>
	<ArticleNumber>1010</ArticleNumber>
    <URLConnection>https://example.com/images/article-1010.jpg</URLConnection>
</ArticleURLConnection>
{
  "ArticleURLConnection": {
    "ArticleNumber": "1010",
    "URLConnection": "https://example.com/images/article-1010.jpg"
  }
}

Response

The response should contain the created article URL connection in either JSON or XML.
<?xml version="1.0" encoding="UTF-8"?>
<ArticleUrlConnection url="https://api.fortnox.se/3/articleurlconnections/4">
    <Id>4</Id>
    <ArticleNumber>1010</ArticleNumber>
    <URLConnection>https://example.com/images/article-1010.jpg</URLConnection>
</ArticleUrlConnection>
{
  "ArticleUrlConnection": {
    "@url": "https://api.fortnox.se/3/articleurlconnections/4",
    "Id": 4,
    "ArticleNumber": "1010",
    "URLConnection": "https://example.com/images/article-1010.jpg"
  }
}

PUT

Description

Updates an article URL connection.

URL structure

https://api.fortnox.se/3/articleurlconnections/{Id}

Method

PUT

Version

3

Request

The request body should contain a structure of an article URL connection, either in JSON or XML.
<ArticleURLConnection>
    <ArticleNumber>1010</ArticleNumber>
    <URLConnection>https://example.com/images/article-1010-A.jpg</URLConnection>
</ArticleURLConnection>
{
  "ArticleURLConnection": {
    "ArticleNumber": "1010",
    "URLConnection": "https://example.com/images/article-1010-A.jpg"
  }
}

Response

The response should contain the updated article URL connection in either JSON or XML.
<?xml version="1.0" encoding="UTF-8"?>
<ArticleUrlConnection url="https://api.fortnox.se/3/articleurlconnections/4">
    <Id>4</Id>
    <ArticleNumber>1010</ArticleNumber>
    <URLConnection>https://example.com/images/article-1010-A.jpg</URLConnection>
</ArticleUrlConnection>
{
  "ArticleUrlConnection": {
    "@url": "https://api.fortnox.se/3/articleurlconnections/4",
    "Id": 4,
    "ArticleNumber": "1010",
    "URLConnection": "https://example.com/images/article-1010-A.jpg"
  }
}

DELETE

Description

Removes an article URL connection.

URL structure

https://api.fortnox.se/3/articleurlconnections/{Id}

Method

DELETE

Version

3

Request

The request body should be empty.

Response

The response body should be empty.

Fields

Field Description Limits Type Searchable Sortable Required R/W
Url Direct URL to the record String R
Id Id of the connection Integer R
ArticleNumber Article number String Yes Yes R/W
URLConnection The external URL .JPG, .PNG, .TIF, .PDF String Yes R/W

* Only writable during POST.