Get Customer Children

Get Customer children by customer id without recursive.

Note: If there is no ${customerId} in URI, it will derive ${customerId} from accessKeyId.

1. Request Definition

  • API URL
https://base-api.swiftfederation.com/v1.1/customerChildren/${customerId}
  • Request Protocol
GET
  • Request Header

Request Header

  • Request Body

No request body for this API.

  • Request Example
GET /v1.1/customerChildren/1 HTTP/1.1
Host: base-api.swiftfederation.com

Authorization:HMAC-SHA256 V265i4K31j991E19:bc051d2e520a462e36455dc75b2bc68e9a135bbf4d2fefbf6d2fc1f28c5aa5dc
Content-Type:application/json; charset=utf-8
X-SFD-Date:20180926T131000Z
X-SFD-Nonce:69527

2. Response Definition

This section is intended to describe response header and body data definition.

2.1. Success Response

  • Success Response Body
Field Data Type
customer Customer[]

Customer

Field Data Type Description
id Integer customer id
name String customer name
parentId Integer parent id
type Short 1 partner; 2 customer
  • Success Response Body Example
{
  "customer": [
    {
    "id": 2,
    "name": "Conversant",
    "parentId": 1,
    "type": 1,
    "region": "SG"
  },
  {
    "id": 30002,
    "name": "Conversant_QA",
    "parentId": 1,
    "type": 1,
    "region": "SG"
 }
  ]
}

2.2. Error Response

  • Error Response Code

Error Code

  • Error Response Example
HTTP/1.1 403
{
"code":"Permission.Forbidden",
"message":"Can't access according to this access key id."
}
© 2019 Conversant Solutions Pte Ltd. All rights reserved.            Updated 2019-06-06 15:24:05

results matching ""

    No results matching ""