STORM API
/
Customer Service
/
Contacts

Documentation CustomerService (1.1)

The Customers namespace has Entities and Operations concerned with Customer and Company management.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://demo.storm.io/api/1.1/

Schemas

Accounts

Operations

Address

Operations

Companies

Operations

Contacts

Operations

List contact by company [Obsolete("Will be removed in a future version.")]

Request

Lists Contacts by Company.Id and an optional responsibilityId.

Query
idinteger(int32)required

The internal Id of the Company to fetch Contacts for.

responsibilityIdinteger(int32)required

Contact responsibility. Lookup references in ListContactResponsibilities.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/CustomerService.svc/rest/ListContactByCompany?id=0&responsibilityId=0'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal Id of the Contact.

Keystring(guid)

The system wide unique Key for the Contact.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

ResponsibilityIdinteger(int32)

The ResponsibilityId of the Contact.

Emailstring

The Email of the Contact. MaxLength: 255.

FirstNamestring

The FirstName of the Contact. MaxLength: 50.

LastNamestring

The LastName of the Contact. MaxLength: 50.

Phonestring

The Phone number of the Contact. MaxLength: 50.

CellPhonestring

The CellPhone number of the Contact. MaxLength: 50.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

]
Response
[
  {
    "Id": 0,
    "Key": "string",
    "Code": "string",
    "ResponsibilityId": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "Phone": "string",
    "CellPhone": "string",
    "ImagePath": "string",
    "ImageKey": "string"
  }
]

List contact responsibilities [Obsolete("will be removed in a future version.")]

Request

Reference list of Contact Responsibilities.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://demo.storm.io/api/1.1/CustomerService.svc/rest/ListContactResponsibilities

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring

The Value of the Entity. MaxLength: max.

Codestring

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

]
Response
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations