Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Customer Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Customer Management RESTful Web Services.

Get All Customers (Version 1)

This request is used to collect all the customer details in version 1 format, which denote the end-users associated with different services configured, provisioned, and administered using the Connectivity Services Director application.

URI

api/space/nsas/customer-management/customers

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.customer-

management.customers+xml

Produces

Collects the set of configured customers

Output

Sample XML Output

Get All Customers (Version 2)

This request is used to collect all the customer details in version 2 format, which denote the end-users associated with different services configured, provisioned, and administered using the Connectivity Services Director application.

URI

api/space/nsas/customer-management/customers

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.customer-

management.customers+xml;version=2

Produces

Collects the set of configured customers

Output

Sample XML Output

Get All Customers with Pagination

This request is used to collect all the customer details with pagination applied for easy-readability and viewing of a large volume of data.

URI

api/space/nsas/customer-

management/customers?start=3&limit=2

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.customer-

management.customers+xml

Produces

Collects the set of configured customers with pagination applied.

Note

For service orders, you can sort with “sortedby=CreatedDate” and “sortedby=State”.

For Start and Limit attributes, you can provide integer values based on your requirement to sort and filter the API output. Sortorder can be “asc” and “desc”. The SortedBy attribute differs based on the APIs. For service orders, the SortedBy option can be “CtreatedDate”, “State”. For services, the SortedBy option can be “Name”, “LastModifiedDate”. The FilteredBy attribute differs based on the APIs. For service orders, the FilteredBy option can be “Name” and “State”. For services, the FilteredBy option can be “Name”.

If you enter “paging=(starteq 2, limit eq 3)”, which is not a single integer value, the display is according to index of records. In this case, it shows from the first indexed record to the third indexed record. If you enter "start=2&limit=3", it starts from the second record and displays the next three records in all.

You can specify multiple key:value pairs with the FilteredBy attribute. For example, to get service orders, you can use Get ServiceOrders with Name and State as “filteredby=Name::L3VPN@@State::Invalid”. Similarly, to get service orders, you can use with Name OR state “filteredby=Name::L3VPN!! State::Invalid”.

Output

Sample XML Output

Get All Customers with Pagination, Search, and Filter

This request is used to collect all the customer details with paging behavior applied on the output, and with the customers sorted and segregated depending on the search criteria.

URI

api/space/nsas/customer-management/customers?

start=1&limit=2&sortorder=asc

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.

customer-management.customers+xml;version=3

Produces

Retrieves the filtered list of customers with pagination, based on the search criteria

Output

Sample XML Output

Get Customer Details By Account Number (Version 1)

This request is used to collect the customer information based on the account number in version 1 format.

URI

api/space/nsas/customer-management/customers?

accountNo={Account-id}

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.customer-management.

customers+xml

Produces

Retrieves the details of a customer based on the account ID.

Output

Sample XML Output

Get Customer Details By Account Number (Version 2)

This request is used to collect the customer information based on the account number in version 2format.

URI

api/space/nsas/customer-management/

customers?accountNo={Account-id}

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2

Produces

Retrieves the details of a customer based on the account ID.

Output

Sample XML Output

Get Customer Details By Customer ID (Version 1)

This request is used to collect the customer information based on the unique customer ID in version 1 format.

URI

api/space/nsas/customer-management/

customers/<customerId>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.customer-management.

customers+xml

Produces

Retrieves the details of a customer based on the customer ID.

Output

Sample XML Output

Get Customer Details By Customer ID (Version 2)

This request is used to collect the customer information based on the unique customer ID in version 2 format.

URI

api/space/nsas/customer-management/

customers/<customerId>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2

Produces

Retrieves the details of a customer based on the customer ID.

Output

Sample XML Output

Create a Customer (Version 1)

This request is used to create a customer using the version 1 format.

URI

api/space/nsas/customer-management/customers

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.customer-management.

customers-status+xml;version=2

Produces

Creates a customer that can be used to associate with the services.

Input

Sample XML Input

Output

Sample XML Output

Create a Customer (Version 2)

This request is used to create a customer using the version 2 format.

URI

api/space/nsas/customer-management/customers

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.customer-management.

customers-status+xml;version=2

Produces

Creates a customer that can be used to associate with the services.

Input

Sample XML Input

Output

Sample XML Output

Modify a Customer (Version 1)

This request is used to edit the attributes of a customer in version 1 format.

URI

api/space/nsas/customer-management/

customers/<customerId>

HTTP Method

PUT

Consumes

application/vnd.net.juniper.space.customer-management.

customers+xml

Produces

Modify the details of the specified customer.

Input

Sample XML Input

Output

Sample XML Output

Modify a Customer (Version 2)

This request is used to edit the attributes of a customer in version 2 format.

URI

api/space/nsas/customer-management/

customers/<customerId>

HTTP Method

PUT

Consumes

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2

Produces

Modify the details of the specified customer.

Input

Sample XML Input

Output

Sample XML Output

Delete a Customer

This request is used to delete an existing customer.

URI

api/space/nsas/customer-management/

customers/<customerId>

HTTP Method

DELETE

Content-Type

application/vnd.net.juniper.space.customer-management.

customers+xml

Consumes

application/vnd.net.juniper.space.customer-management.

customer-status+xml

Produces

Deletes the specified customer from the application database.

Output

Sample XML Output

Bulk Creation of Customers (Version 1)

This request is used to perform a bulk creation of several customers using the version 1 format.

URI

api/space/nsas/customer-management/customers

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.customer-management.

customers-status+xml

Produces

Creates a set of customers in a bulk operation.

Input

Sample XML Input

Output

Sample XML Output

Bulk Creation of Customers (Version 2)

This request is used to perform a bulk creation of a set of customers using the version 2 format.

URI

api/space/nsas/customer-management/customers

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.customer-management.

customers-status+xml;version=2

Produces

Creates a set of customers in a bulk operation.

Input

Sample XML Input

Output

Sample XML Output

Bulk Edit of Customers (Version 1)

This request is used to perform a wholesale, bulk modification of the attributes of customers in version 1 format.

URI

api/space/nsas/customer-management/customers/

HTTP Method

PUT

Content-Type

application/vnd.net.juniper.space.customer-management.

customers+xml

Consumes

application/vnd.net.juniper.space.customer-management.

customers-status+xml

Produces

Modify the details of several customers in a single, one-step operation.

Input

Sample XML Input

Output

Sample XML Output

Bulk Edit of Customers (Version 2)

This request is used to perform a wholesale, bulk modification of the attributes of customers in version 2 format.

URI

api/space/nsas/customer-management/customers/

HTTP Method

PUT

Content-Type

application/vnd.net.juniper.space.customer-management.

customers+xml;version=2

Consumes

application/vnd.net.juniper.space.customer-management.

customers-status+xml

Produces

Modify the details of the customers in a bulk operation.

Input

Sample XML Input

Output

Sample XML Output

Bulk Deletion of Customers

This request is used to perform a bulk deletion of existing customers.

URI

api/space/nsas/customer-management/customers/

HTTP Method

DELETE

Content-Type

application/vnd.net.juniper.space.customer-management.customers+xml

Consumes

application/vnd.net.juniper.space.customer-management.customers-status+xml

Produces

Deletes the customers from the application database in a bulk operation.

Input

Sample XML Input

Output

Sample XML Output