Other endpoints

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

GET/

curl 'https://api-playground.loady.com/public/loadingPoints/v1?referenceNumber=<string>&siteReferenceNumber=<string>' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Loading Point by Reference Number

PUT

https://api-playground.loady.com/public/loadingPoints/v1

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update a Loading Point by Reference Number

Update Loading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of a Loading Point

siteReferenceNumber

string · required

Reference number of a Site to which a Loading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which a Loading Point belongs

Update Loading Point by Reference Number › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Update Loading Point by Reference Number › Request Body

name

string · minLength: 1 · required

Name of the Loading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Loading Point

address

Address of the Loading Point

contacts

Contacts of the Loading Point

Update Loading Point by Reference Number › Responses

The updated Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

publicCreateLoadingPointCommand

Contacts of the Loading Point

PUT/

curl 'https://api-playground.loady.com/public/loadingPoints/v1?referenceNumber=<string>&siteReferenceNumber=<string>' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Create Loading Point

POST

https://api-playground.loady.com/public/loadingPoints/v1

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to create a Loading Point

Create Loading Point › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Create Loading Point › Request Body

name

string · minLength: 1 · required

Name of the Loading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Loading Point

siteId

string | null

ID of the Site for which the Loading Point should be created

siteReferenceNumber

string | null

Reference number of the Site for which the Loading Point should be created. Either SiteId or SiteReferenceNumber must be present. SiteId takes precedence.

businessPartnerReferenceNumber

string | null

Reference number of the Business Partner for which the Loading Point should be created

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

Create Loading Point › Responses

The created Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

POST/

curl https://api-playground.loady.com/public/loadingPoints/v1 \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Delete Loading Point by Reference Number

DELETE

https://api-playground.loady.com/public/loadingPoints/v1

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to delete a Loading Point by Reference Number

Delete Loading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of a Loading Point

siteReferenceNumber

string · required

Reference number of a Site to which a Loading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which a Loading Point belongs

Delete Loading Point by Reference Number › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Delete Loading Point by Reference Number › Responses

The Loading Point was successfully deleted

No data returned

Get Loading Point by ID

GET

https://api-playground.loady.com/public/loadingPoints/v1

/{loadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to get a Loading Point by ID

Get Loading Point by ID › path Parameters

loadingPointId

string · required

ID of the Loading Point

Get Loading Point by ID › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Get Loading Point by ID › Responses

The requested Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

GET/{loadingPointId}

curl https://api-playground.loady.com/public/loadingPoints/v1/:loadingPointId \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Loading Point by ID

PUT

https://api-playground.loady.com/public/loadingPoints/v1

/{loadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update a Loading Point by ID

Update Loading Point by ID › path Parameters

loadingPointId

string · required

ID of a Loading Point

Update Loading Point by ID › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Update Loading Point by ID › Request Body

name

string · minLength: 1 · required

Name of the Loading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Loading Point

address

Address of the Loading Point

contacts

Contacts of the Loading Point

Update Loading Point by ID › Responses

The updated Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

PUT/{loadingPointId}

curl https://api-playground.loady.com/public/loadingPoints/v1/:loadingPointId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Delete Loading Point by ID

DELETE

https://api-playground.loady.com/public/loadingPoints/v1

/{loadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to delete a Loading Point by ID

Delete Loading Point by ID › path Parameters

loadingPointId

string · required

ID of a Loading Point

Delete Loading Point by ID › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Delete Loading Point by ID › Responses

The Loading Point was successfully deleted

No data returned

Try this APIPGCredentials required

Requests run against https://api-playground.loady.com/public and can change real PG data. You are responsible for every request you send.

Values stay in this tab's memory only and are cleared when the page reloads. They are sent directly to the configured Loady authentication and API endpoints.

Loading Points API

Other endpoints

Download schema

Get Loading Point by Reference Number

GET

https://api-playground.loady.com/public/loadingPoints/v1

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to get a Loading Point by Reference Number

Get Loading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of a Loading Point

siteReferenceNumber

string · required

Reference number of a Site to which a Loading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which a Loading Point belongs

Get Loading Point by Reference Number › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Get Loading Point by Reference Number › Responses

The requested Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

GET/

curl 'https://api-playground.loady.com/public/loadingPoints/v1?referenceNumber=<string>&siteReferenceNumber=<string>' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Loading Point by Reference Number

PUT

https://api-playground.loady.com/public/loadingPoints/v1

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update a Loading Point by Reference Number

Update Loading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of a Loading Point

siteReferenceNumber

string · required

Reference number of a Site to which a Loading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which a Loading Point belongs

Update Loading Point by Reference Number › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Update Loading Point by Reference Number › Request Body

name

string · minLength: 1 · required

Name of the Loading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Loading Point

address

Address of the Loading Point

contacts

Contacts of the Loading Point

Update Loading Point by Reference Number › Responses

The updated Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

publicCreateLoadingPointCommand

Contacts of the Loading Point

PUT/

curl 'https://api-playground.loady.com/public/loadingPoints/v1?referenceNumber=<string>&siteReferenceNumber=<string>' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Create Loading Point

POST

https://api-playground.loady.com/public/loadingPoints/v1

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to create a Loading Point

Create Loading Point › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Create Loading Point › Request Body

name

string · minLength: 1 · required

Name of the Loading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Loading Point

siteId

string | null

ID of the Site for which the Loading Point should be created

siteReferenceNumber

string | null

Reference number of the Site for which the Loading Point should be created. Either SiteId or SiteReferenceNumber must be present. SiteId takes precedence.

businessPartnerReferenceNumber

string | null

Reference number of the Business Partner for which the Loading Point should be created

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

Create Loading Point › Responses

The created Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

POST/

curl https://api-playground.loady.com/public/loadingPoints/v1 \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Delete Loading Point by Reference Number

DELETE

https://api-playground.loady.com/public/loadingPoints/v1

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to delete a Loading Point by Reference Number

Delete Loading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of a Loading Point

siteReferenceNumber

string · required

Reference number of a Site to which a Loading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which a Loading Point belongs

Delete Loading Point by Reference Number › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Delete Loading Point by Reference Number › Responses

The Loading Point was successfully deleted

No data returned

Get Loading Point by ID

GET

https://api-playground.loady.com/public/loadingPoints/v1

/{loadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to get a Loading Point by ID

Get Loading Point by ID › path Parameters

loadingPointId

string · required

ID of the Loading Point

Get Loading Point by ID › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Get Loading Point by ID › Responses

The requested Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts

Contacts of the Loading Point

GET/{loadingPointId}

curl https://api-playground.loady.com/public/loadingPoints/v1/:loadingPointId \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Loading Point by ID

PUT

https://api-playground.loady.com/public/loadingPoints/v1

/{loadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update a Loading Point by ID

Update Loading Point by ID › path Parameters

loadingPointId

string · required

ID of a Loading Point

Update Loading Point by ID › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Update Loading Point by ID › Request Body

name

string · minLength: 1 · required

Name of the Loading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Loading Point

address

Address of the Loading Point

contacts

Contacts of the Loading Point

Update Loading Point by ID › Responses

The updated Loading Point

id

string

ID of the Loading Point

name

string

Name of the Loading Point

referenceNumber

string

ERP reference number of the Loading Point

siteId

string | null

ID of the Site to which the Loading Point belongs

siteName

string | null

Name of the Site to which the Loading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Loading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Loading Point

contacts