Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Portfolio Address

Viewing all portfolio addresses

get

To view all portfolio addresses:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
portfolioIdstringRequired
Responses
200

Successful response

application/json
portfolioAddressIdstringOptional
portfolioIdstringOptional
firstNamestringOptional
lastNamestringOptional
companyNamestringOptional
friendlyNameanyOptional
addressTypestringOptional
addressLine1stringOptional
addressLine2anyOptional
townOrCitystringOptional
countyOrStatestringOptional
countryCodestringOptional
postCodestringOptional
mobileNumberintegerOptional
landLineNumberanyOptional
emailAddressstringOptional
statusstringOptional
get/api/v2/portfolio/{portfolioId}/portfolioAddress
GET /api/v2/portfolio/{portfolioId}/portfolioAddress HTTP/1.1
Host: portfolio.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

[
  {
    "portfolioAddressId": "f20bc36623274be6a73fa62a5b9b354c",
    "portfolioId": "a628ebc659f7dac01f9fdcbd1116307a",
    "firstName": "Rachel",
    "lastName": "Smith",
    "companyName": "Simple IoT Solutions",
    "friendlyName": null,
    "addressType": "billing",
    "addressLine1": "123 Test Street",
    "addressLine2": null,
    "townOrCity": "Exampleton",
    "countyOrState": "Test Valley",
    "countryCode": "GB",
    "postCode": "XX12 6ZZ",
    "mobileNumber": 7912345678,
    "landLineNumber": null,
    "emailAddress": "accounts@simpleIoTsolutions.com",
    "status": "active",
    "attributes": [
      {
        "portfolioAddressAttributeId": 38625,
        "portfolioAddressId": "f20bc36623274be6a73fa62a5b9b354c",
        "attribute": "defaultAddress",
        "value": "yes",
        "status": "active"
      },
      {
        "portfolioAddressAttributeId": 38626,
        "portfolioAddressId": "f20bc36623274be6a73fa62a5b9b354c",
        "attribute": "taxReference",
        "value": "12345 67890",
        "status": "active"
      }
    ]
  },
  {
    "portfolioAddressId": "ebdc7678a1404f2c856a6a0b7ecbb186",
    "portfolioId": "a628ebc659f7dac01f9fdcbd1116307a",
    "firstName": "Harrison",
    "lastName": "Lopez",
    "companyName": "Simple IoT Solutions",
    "friendlyName": "Logistics",
    "addressType": "shipping",
    "addressLine1": "456 Dockyards",
    "addressLine2": null,
    "townOrCity": "Exampleton",
    "countyOrState": "Test Valley",
    "countryCode": "GB",
    "postCode": "XX15 3ZZ",
    "mobileNumber": 7987654321,
    "landLineNumber": null,
    "emailAddress": "logistics@simpleIoTsolutions.com",
    "status": "setup"
  }
]

Creating a new portfolio address

post

To create a new portfolio address:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
portfolioIdstringRequired
Body
firstNamestringRequired
lastNamestringRequired
companyNamestringRequired
friendlyNamestringOptional
addressTypestringRequired
addressLine1stringRequired
addressLine2stringOptional
townOrCitystringRequired
countyOrStatestringRequired
countryCodeIdstringRequired
postCodestringRequired
mobileNumberstringRequired
landLineNumberstringOptional
emailAddressstringRequired
statusstringOptional
Responses
200

Successful response

No content
post/api/v2/portfolio/{portfolioId}/portfolioAddress
POST /api/v2/portfolio/{portfolioId}/portfolioAddress HTTP/1.1
Host: portfolio.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "firstName": "text",
  "lastName": "text",
  "companyName": "text",
  "friendlyName": "text",
  "addressType": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "townOrCity": "text",
  "countyOrState": "text",
  "countryCodeId": "text",
  "postCode": "text",
  "mobileNumber": "text",
  "landLineNumber": "text",
  "emailAddress": "text",
  "status": "text"
}
200

Successful response

No content

Viewing a specific portfolio address

get

To view details for a specific portfolio address:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
portfolioIdstringRequired
portfolioAddressIdstringRequired
Responses
200

Successful response

application/json
portfolioAddressIdstringOptional
portfolioIdstringOptional
firstNamestringOptional
lastNamestringOptional
companyNamestringOptional
friendlyNameanyOptional
addressTypestringOptional
addressLine1stringOptional
addressLine2anyOptional
townOrCitystringOptional
countyOrStatestringOptional
countryCodestringOptional
postCodestringOptional
mobileNumberintegerOptional
landLineNumberanyOptional
emailAddressstringOptional
statusstringOptional
get/api/v2/portfolio/{portfolioId}/portfolioAddress/{portfolioAddressId}
GET /api/v2/portfolio/{portfolioId}/portfolioAddress/{portfolioAddressId} HTTP/1.1
Host: portfolio.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

{
  "portfolioAddressId": "f20bc36623274be6a73fa62a5b9b354c",
  "portfolioId": "a628ebc659f7dac01f9fdcbd1116307a",
  "firstName": "Rachel",
  "lastName": "Smith",
  "companyName": "Simple IoT Solutions",
  "friendlyName": null,
  "addressType": "billing",
  "addressLine1": "123 Test Street",
  "addressLine2": null,
  "townOrCity": "Exampleton",
  "countyOrState": "Test Valley",
  "countryCode": "GB",
  "postCode": "XX12 6ZZ",
  "mobileNumber": 7912345678,
  "landLineNumber": null,
  "emailAddress": "accounts@simpleIoTsolutions.com",
  "status": "active",
  "attributes": [
    {
      "portfolioAddressAttributeId": 38625,
      "portfolioAddressId": "f20bc36623274be6a73fa62a5b9b354c",
      "attribute": "defaultAddress",
      "value": "yes",
      "status": "active"
    },
    {
      "portfolioAddressAttributeId": 38626,
      "portfolioAddressId": "f20bc36623274be6a73fa62a5b9b354c",
      "attribute": "taxReference",
      "value": "12345 67890",
      "status": "active"
    }
  ]
}

Updating a specific portfolio address

patch

To update a specific portfolio address:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
portfolioIdstringRequired
portfolioAddressIdstringRequired
Body
firstNamestringOptional
lastNamestringOptional
companyNamestringOptional
friendlyNamestringOptional
addressTypestringOptional
addressLine1stringOptional
addressLine2stringOptional
townOrCitystringOptional
countyOrStatestringOptional
countryCodeIdstringOptional
postCodestringOptional
mobileNumberstringOptional
landLineNumberstringOptional
emailAddressstringOptional
statusstringOptional
Responses
200

Successful response

application/json
portfolioAddressIdstringOptional
portfolioIdstringOptional
firstNamestringOptional
lastNamestringOptional
companyNamestringOptional
friendlyNamestringOptional
addressTypestringOptional
addressLine1stringOptional
addressLine2anyOptional
townOrCitystringOptional
countyOrStatestringOptional
countryCodestringOptional
postCodestringOptional
mobileNumberintegerOptional
landLineNumberanyOptional
emailAddressstringOptional
statusstringOptional
patch/api/v2/portfolio/{portfolioId}/portfolioAddress/{portfolioAddressId}
PATCH /api/v2/portfolio/{portfolioId}/portfolioAddress/{portfolioAddressId} HTTP/1.1
Host: portfolio.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "firstName": "text",
  "lastName": "text",
  "companyName": "text",
  "friendlyName": "text",
  "addressType": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "townOrCity": "text",
  "countyOrState": "text",
  "countryCodeId": "text",
  "postCode": "text",
  "mobileNumber": "text",
  "landLineNumber": "text",
  "emailAddress": "text",
  "status": "text"
}
200

Successful response

{
  "portfolioAddressId": "ebdc7678a1404f2c856a6a0b7ecbb186",
  "portfolioId": "a628ebc659f7dac01f9fdcbd1116307a",
  "firstName": "Harrison",
  "lastName": "Lopez",
  "companyName": "Simple IoT Solutions",
  "friendlyName": "Logistics",
  "addressType": "shipping",
  "addressLine1": "456 Dockyards",
  "addressLine2": null,
  "townOrCity": "Exampleton",
  "countyOrState": "Test Valley",
  "countryCode": "GB",
  "postCode": "XX15 3ZZ",
  "mobileNumber": 7987654321,
  "landLineNumber": null,
  "emailAddress": "logistics@simpleIoTsolutions.com",
  "status": "active"
}
PreviousPortfolio Address Attribute
NextPortfolio Attribute

Last updated

Was this helpful?