Get Customer Detail
Retrieves the customer detail by ID.
Request
Request-Line
GET /sfd/v2.0/customers/{customerId} HTTP/1.1
Request Parameters
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
customerId | Integer | Mandatory | Unique identifier of the customer record. |
Response
Response Body
Property name | Type | Required | Description |
---|---|---|---|
id | Integer | Mandatory | Unique identifier of the customer record. |
name | String | Mandatory | Name of the customer. |
parentId | Integer | Mandatory | Parent ID. |
type | Short | Mandatory | Customer type. 1 - Partner. 2 - Customer. |
partnership | Short | Optional | Ignore this field. |
region | String | Optional | Region. |
industry | String | Optional | Industry. |
Status Codes, Error Codes and Error Messages
Status Code | Error Code | Error Message |
---|---|---|
400 | CustomerId.Invalid | Customer ID is empty or invalid. |
Examples
Get Customer Detail
Request
GET /sfd/v2.0/customers/1 HTTP/1.1
Successful Response Body
{
"id": 1,
"name": "swiftFederation",
"parentId": 0,
"type": 1,
"partnership": 1,
"region": "SG",
"industry": "Cloud Service Providers"
}