Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    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

    				
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    		<Customers size="3">
    			<Customer href="/api/space/nsas/customer-management/customers/327680" uri="/api/space/nsas/customer-management/customers/327680" key="327680">
    			<Common>
    				<Name>Customer_001</Name>
    				<Identity>327680</Identity>
    				<CreatedDate>2012-06-28T15:17:56.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-06-28T15:17:56.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324001</AccountNo>
    			<ContactName>customer001</ContactName>
    			<ContactEmail>customer001@juniper.net</ContactEmail>
    			</Customer>
    			<Customer href="/api/space/nsas/customer-management/customers/327681" uri="/api/space/nsas/customer-management/customers/327681" key="327681">
    			<Common>
    				<Name>Customer_002</Name>
    				<Identity>327681</Identity>
    				<CreatedDate>2012-06-28T15:18:20.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-06-28T15:18:20.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324002</AccountNo>
    			<ContactName>customer002</ContactName>
    			<ContactEmail>customer002@juniper.net</ContactEmail>
    			</Customer>
    			<Customer href="/api/space/nsas/customer-management/customers/6193152"	uri="/api/space/nsas/customer-management/customers/6193152" key="6193152">
    			<Common>
    				<Name>Customer_003</Name>
    				<Identity>6193152</Identity>
    				<CreatedDate>2012-07-27T19:46:51.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-07-27T19:46:51.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324003</AccountNo>
    			<ContactName>customer003</ContactName>
    			<ContactEmail>customer003@juniper.net</ContactEmail>
    			</Customer>
    		</Customers>
    </Data>
    				

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    		<Customers size="3">
    			<Customer href="/api/space/nsas/customer-management/customers/327680" uri="/api/space/nsas/customer-management/customers/327680" key="327680">
    			<Common>
    				<CustomerName>Customer 001</CustomerName>
    				<Identity>327680</Identity>
    				<CreatedDate>2012-06-28T15:17:56.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-06-28T15:17:56.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324001</AccountNo>
    			<ContactName>customer 001</ContactName>
    			<ContactEmail>customer001@juniper.net</ContactEmail>
    			</Customer>
    			<Customer href="/api/space/nsas/customer-management/customers/327681" uri="/api/space/nsas/customer-management/customers/327681" key="327681">
    			<Common>
    				<CustomerName>Customer 002</CustomerName>
    				<Identity>327681</Identity>
    				<CreatedDate>2012-06-28T15:18:20.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-06-28T15:18:20.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324002</AccountNo>
    			<ContactName>customer 002</ContactName>
    			<ContactEmail>customer002@juniper.net</ContactEmail>
    			</Customer>
    			<Customer href="/api/space/nsas/customer-management/customers/6193152"	uri="/api/space/nsas/customer-management/customers/6193152" key="6193152">
    			<Common>
    				< CustomerName>Customer 003</CustomerName>
    				<Identity>6193152</Identity>
    				<CreatedDate>2012-07-27T19:46:51.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-07-27T19:46:51.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324003</AccountNo>
    			<ContactName>customer 003</ContactName>
    			<ContactEmail>customer003@juniper.net</ContactEmail>
    			</Customer>
    		</Customers>
    </Data>
    
    
    

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers size="3">
    		<Customer href="/api/space/nsas/customer-management/customers/327680"
    		uri="/api/space/nsas/customer-management/customers/327680" key="327680">
    		<Common>
    			<Name>Customer_001</Name>
    			<Identity>327680</Identity>
    			<CreatedDate>2012-06-28T15:17:56.000+05:30</CreatedDate>
    			<LastUpdatedDate>2012-06-28T15:17:56.000+05:30</LastUpdatedDate>
    		</Common>
    		<AccountNo>40132324001</AccountNo>
    		<ContactName>customer001</ContactName>
    		<ContactEmail>customer001@juniper.net</ContactEmail>
    	</Customer>
    	<Customer href="/api/space/nsas/customer-management/customers/327681" uri="/api/space/nsas/customer-management/customers/327681" key="327681">
    		<Common>
    			<Name>Customer_002</Name>
    			<Identity>327681</Identity>
    			<CreatedDate>2012-06-28T15:18:20.000+05:30</CreatedDate>
    			<LastUpdatedDate>2012-06-28T15:18:20.000+05:30</LastUpdatedDate>
    		</Common>
    		<AccountNo>40132324002</AccountNo>
    		<ContactName>customer002</ContactName>
    		<ContactEmail>customer002@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>
    				

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    				    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers size="2">
    		<Customer key="2555905"
    			uri="/api/space/nsas/customer-management/customers/2555905" href="/api/space/nsas/customer-management/customers/2555905">
    			<Common>
    				<Name>air</Name>
    				<Identity>2555905</Identity>
    				<CreatedDate>2014-12-05T15:34:41.000+05:30</CreatedDate>
    				<LastUpdatedDate>2014-12-05T15:34:41.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>44</AccountNo>
    			<ContactName>juasdf</ContactName>
    			<ContactEmail>kag@yuu.com</ContactEmail>
    		</Customer>
    		<Customer key="2555904"
    			uri="/api/space/nsas/customer-management/customers/2555904" href="/api/space/nsas/customer-management/customers/2555904">
    			<Common>
    				<Name>Test</Name>
    				<Identity>2555904</Identity>
    				<CreatedDate>2014-12-05T15:33:53.000+05:30</CreatedDate>
    				<LastUpdatedDate>2014-12-05T15:33:53.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>454658</AccountNo>
    			<ContactName>546827</ContactName>
    			<ContactEmail>test@jag.com</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>
    
    				
    				

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers size="1">
    		<Customer href="/api/space/nsas/customer-management/customers/1015808" uri="/api/space/nsas/customer-management/customers/1015808" key="1015808">
    			<Common>
    				<Name>Customer_001</Name>
    				<Identity>1015808</Identity>
    				<CreatedDate>2012-08-13T15:09:48.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-08-13T15:09:48.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324001</AccountNo>
    			<ContactName>customer001</ContactName>
    			<ContactEmail>customer001@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>
    				

    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

      <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers size="1">
    		<Customer href="/api/space/nsas/customer-management/customers/1015808" uri="/api/space/nsas/customer-management/customers/1015808" key="1015808">
    			<Common>
    				<CustomerName>Customer 001</CustomerName>
    				<Identity>1015808</Identity>
    				<CreatedDate>2012-08-13T15:09:48.000+05:30</CreatedDate>
    				<LastUpdatedDate>2012-08-13T15:09:48.000+05:30</LastUpdatedDate>
    			</Common>
    			<AccountNo>40132324001</AccountNo>
    			<ContactName>customer 001</ContactName>
    			<ContactEmail>customer001@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>	
    
    

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers>
    		<Customer href="/api/space/nsas/customer-management/customers/327680" uri="/api/space/nsas/customer-management/customers/327680" key="327680">
    		<Common>
    			<Name>Customer_001</Name>
    			<Identity>327680</Identity>
    			<CreatedDate>2012-06-28T15:17:56.000+05:30</CreatedDate>
    			<LastUpdatedDate>2012-06-28T15:17:56.000+05:30</LastUpdatedDate>
    		</Common>
    		<AccountNo>40132324001</AccountNo>
    		<ContactName>customer001</ContactName>
    		<ContactEmail>customer001@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>					
    				

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers>
    		<Customer href="/api/space/nsas/customer-management/customers/327680" uri="/api/space/nsas/customer-management/customers/327680" key="327680">
    		<Common>
    			<CustomerName>Customer 001</CustomerName>
    			<Identity>327680</Identity>
    			<CreatedDate>2012-06-28T15:17:56.000+05:30</CreatedDate>
    			<LastUpdatedDate>2012-06-28T15:17:56.000+05:30</LastUpdatedDate>
    		</Common>
    		<AccountNo>40132324001</AccountNo>
    		<ContactName>customer 001</ContactName>
    		<ContactEmail>customer001@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>		
    
    
    

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers>
    		<Customer>
    			<Common>
    				<Name>Customer_005</Name>
    			</Common>
    			<AccountNo>40132324005</AccountNo>
    			<ContactName>customer005</ContactName>
    			<ContactEmail>customer005@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>	
    				

    Output

    Sample XML Output

    				
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    	<Code>200</Code>
    	<Message>Customer Created Successfully.</Message>
    	<Identity>
    		<Type>Customer</Type>
    		<Value>6488064</Value>
    	</Identity>
    	</Status>
    </Data>	
    				

    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

     <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers>
    		<Customer>
    			<Common>
    				<CustomerName>Customer 005</CustomerName>
    			</Common>
    			<AccountNo>40132324005</AccountNo>
    			<ContactName>customer 005</ContactName>
    			<ContactEmail>customer005@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>
    		
    
    
    

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    	<Code>200</Code>
    	<Message>Customer Created Successfully.</Message>
    	<Identity>
    		<Type>Customer</Type>
    		<Value>6488064</Value>
    	</Identity>
    	</Status>
    </Data>
    	
    
    
    

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers>
    		<Customer>
    			<Common>
    				<Name>Customer_005</Name>
    				<Identity>6488064</Identity>
    			</Common>
    			<AccountNo>40132324005</AccountNo>
    			<ContactName>customer005_mod</ContactName>
    			<ContactEmail>customer005_mod@juniper.net</ContactEmail>
    			<ContactInfo>customerInfo_mod</ContactInfo>
    		</Customer>
    	</Customers>
    </Data>
    				

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    	<Code>200</Code>
    	<Message>Customer Modified Successfully.</Message>
    	<Identity>
    		<Type>Customer</Type>
    		<Value>3768322<</Value>
    	</Identity>
    	</Status>
    </Data>	
    				

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers>
    		<Customer>
    			<Common>
    				<CustomerName>Customer 005</CustomerName>
    				<Identity>6488064</Identity>
    			</Common>
    			<AccountNo>40132324005</AccountNo>
    			<ContactName>customer005 mod</ContactName>
    			<ContactEmail>customer005_mod@juniper.net</ContactEmail>
    			<ContactInfo>customerInfo_mod</ContactInfo>
    		</Customer>
    	</Customers>
    </Data>
    
    
    

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    	<Code>200</Code>
    	<Message>Customer Modified Successfully.</Message>
    	<Identity>
    		<Type>Customer</Type>
    		<Value>3768322<</Value>
    	</Identity>
    	</Status>
    </Data>	
    
    
    
    

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    	<Code>200</Code>
    	<Message>Customer Deleted Successfully.</Message>
    	<Identity>
    		<Type>Customer</Type>
    		<Value>6488064</Value>
    	</Identity>
    	</Status>
    </Data>	
    				

    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

      
      <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Customers>
    <Customer>
    <Common>
    <Name>Customer1</Name>
    </Common>
    <AccountNo>40000001</AccountNo>
    <ContactName>Customer1</ContactName>
    <ContactEmail>Customer1@juniper.net</ContactEmail>
    <Customer>
    <Common>
    <Name>Customer2</Name>
    </Common>
    <AccountNo>40000002</AccountNo>
    <ContactName>Customer2</ContactName>
    <ContactEmail>Customer2@juniper.net</ContactEmail>
    </Customer>
    <Customer>
    <Common>
    <Name>Customer3</Name>
    </Common>
    <AccountNo>40000003</AccountNo>
    <ContactName>Customer3</ContactName>
    <ContactEmail>Customer3@juniper.net</ContactEmail>
    </Customer>
    </Customers>
    </Data>
    </Customer>
     

    Output

    Sample XML Output

    <Data>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959528</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Created Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959529</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Created Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959530</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Created Successfully.</Message>
    </Status>
    </Data>
     
     
    

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Customers>
    		<Customer>
    			<Common>
    				<CustomerName>Customer 006</CustomerName>
    			</Common>
    			<AccountNo>40132324006</AccountNo>
    			<ContactName>customer006</ContactName>
    			<ContactEmail>customer006@juniper.net</ContactEmail>
    		</Customer>
                    <Customer>
    			<Common>
    				<CustomerName>Customer 007</CustomerName>
    			</Common>
    			<AccountNo>40132324007</AccountNo>
    			<ContactName>customer007</ContactName>
    			<ContactEmail>customer007@juniper.net</ContactEmail>
    		</Customer>
                    <Customer>
    			<Common>
    				<CustomerName>Customer 008</CustomerName>
    			</Common>
    			<AccountNo>40132324008</AccountNo>
    			<ContactName>customer 008</ContactName>
    			<ContactEmail>customer008@juniper.net</ContactEmail>
    		</Customer>
    	</Customers>
    </Data>		
    
    

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Identity>
    			<Type>Customer</Type>
    			<Value>5177351</Value>
    		</Identity>
    		<Code>200</Code>
    		<Message>Customer Created Successfully.</Message>
    	</Status>
    	<Status>
    		<Identity>
    			<Type>Customer</Type>
    			<Value>5177352</Value>
    		</Identity>
    		<Code>200</Code>
    		<Message>Customer Created Successfully.</Message>
    	</Status>
    	<Status>
    		<Identity>
    			<Type>Customer</Type>
    			<Value>5177353</Value>
    		</Identity>
    		<Code>200</Code>
    		<Message>Customer Created Successfully.</Message>
    	</Status>
    </Data>	
    
    
    
    
    

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Customers>
    <Customer>
    <Common>
    <Name>Customer1</Name>
    <Identity>959528</Identity>
    </Common>
    <AccountNo>40000001</AccountNo>
    <ContactName>Customer1_mod</ContactName>
    <ContactEmail>Customer1_mod@juniper.net</ContactEmail>
    </Customer>
    <Customer>
    <Common>
    <Name>Customer2</Name>
    <Identity>959529</Identity>
    </Common>
    <AccountNo>40000002</AccountNo>
    <ContactName>Customer2_mod</ContactName>
    <ContactEmail>Customer2_mod@juniper.net</ContactEmail>
    </Customer>
    <Customer>
    <Common>
    <Name>Customer3</Name>
    <Identity>959530</Identity>
    </Common>
    <AccountNo>40000003</AccountNo>
    <ContactName>Customer3_mod</ContactName>
    <ContactEmail>Customer3_mod@juniper.net</ContactEmail>
    </Customer>
    </Customers>
    </Data>
    

    Output

    Sample XML Output

      <Data>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959528</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Modified Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959529</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Modified Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959530</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Modified Successfully.</Message>
    </Status>
    </Data>
      
     

    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

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Customers>
    <Customer>
    <Common>
    <CustomerName>Customer 01</CustomerName>
    <Identity>959528</Identity>
    </Common>
    <AccountNo>40000001</AccountNo>
    <ContactName>Customer 1_mod</ContactName>
    <ContactEmail>Customer1_mod@juniper.net</ContactEmail>
    </Customer>
    <Customer>
    <Common>
    <CustomerName>Customer 2</CustomerName>
    <Identity>959529</Identity>
    </Common>
    <AccountNo>40000002</AccountNo>
    <ContactName>Customer 2_mod</ContactName>
    <ContactEmail>Customer2_mod@juniper.net</ContactEmail>
    </Customer>
    <Customer>
    <Common>
    <CustomerName>Customer 3</CustomerName>
    <Identity>959530</Identity>
    </Common>
    <AccountNo>40000003</AccountNo>
    <ContactName>Customer 3_mod</ContactName>
    <ContactEmail>Customer3_mod@juniper.net</ContactEmail>
    </Customer>
    </Customers>
    </Data>	
    
    
    

    Output

    Sample XML Output

    <Data>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959528</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Modified Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959529</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Modified Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959530</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Modified Successfully.</Message>
    </Status>
    </Data>	
    
    
    
    

    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

      <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Identity>
    <Type>Customer</Type>
    <Value>959528</Value>
    </Identity>
    <Identity>
    <Type>Customer</Type>
    <Value>959529</Value>
    </Identity>
    <Identity>
    <Type>Customer</Type>
    <Value>959530</Value>
    </Identity>
    </Data>
      
     

    Output

    Sample XML Output

      <Data>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959528</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Deleted Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959529</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Deleted Successfully.</Message>
    </Status>
    <Status>
    <Identity>
    <Type>Customer</Type>
    <Value>959530</Value>
    </Identity>
    <Code>200</Code>
    <Message>Customer Deleted Successfully.</Message>
    </Status>
    </Data>
      
     

    Modified: 2016-01-27