Create clients
post
/PASService/rest/services/v1/clients
Creates single or multiple clients.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
stringResponse
201 Response
This response code indicates that the clients were created successfully.
Examples
This example describes how to create a single or multiple clients.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/v1/clients" \
-d '{"Use this placeholder to plug-in the example request body given below"}' Example Request Body
The following shows an example of the request body in JSON format:
{
"clients": [
{
"dateOfBirth": "2020-01-06T00:00:00Z",
"dateOfDeath": "2080-03-06T00:00:00Z",
"updatedGmt": "2020-01-06T00:00:00Z",
"companyName": "2020-01-06T00:00:00Z",
"email": "sea@mail.com",
"prefix": "04",
"sex": "M",
"suffix": "Mr",
"legalResidenceCountryCode": "US",
"additionalPrefix": "Mr",
"additionalSuffix": "John",
"title": "John",
"maritalStatus": "00",
"birthCountryCode": "CA",
"citizenshipCountryCode": "CA",
"birthRegionCode": "CA",
"primaryPhone": "2323-2323",
"textField1": "Shubhakankshi Bhukta",
"textField2": "Shubhakankshi",
"checkBox1": "Yes",
"checkBox2": "Yes",
"radio1": "True",
"radio2": "True",
"combo1": "A",
"combo2": "B",
"entityTypeCode": "CLIENT",
"date1": "2020-01-06T00:00:00Z",
"date2": "2020-01-06T00:00:00Z",
"addresses": [
],
"phones": [
],
"clientId": "695634AC-F8AF-4109-ABA7-E849D08C1049",
"firstName": "OIPA",
"lastName": "QA1",
"middleInitial": "Mr",
"taxId": "923846729",
"type": "02",
"taxIdType": "A",
"status": "Active",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
}
]
}
Example Response Body
The following shows an example of the response body in JSON format:
{
"clients": [
"695634AC-F8AF-4109-ABA7-E849D08C1049"
]
}