POST api/CustomerSystemSwap

Creates a new Customer Recurring record. Customer, Site, and System records must exist in order to create a Recurring record.

Request Information

URI Parameters

None.

Body Parameters

CustomerSystemSwap

Name	Description	Type	Additional information
ExistingCustomerSystemId	Sedona internal autonumber for the AR Customer System record (AR_Customer_System table)	integer	Required
CustomerId	Foreign key from AR_Customer table	integer	Required
NewCustomerSystemId	Sedona internal autonumber for the AR Customer System record (AR_Customer_System table)	integer	None.
RMRReasonCode	Reason for the RMR change; value from AR_RMR_Reason table (for Tracking record).	string	Required String length: inclusive between 0 and 25
RMRTrackingComments	Additional comments for the RMR Tracking table	string	String length: inclusive between 0 and 1024
ExistingRecurringIds	List of recurring ids associated with the system specified by ExistingCustomerSystemId, do not submit, will be overwritten	Collection of integer	None.
NewRecurringIds	List of new recurring ids associated with the new system specified by ExistingCustomerSystemId, do not submit, will be overwritten	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ExistingCustomerSystemId": 1,
  "CustomerId": 2,
  "NewCustomerSystemId": 3,
  "RMRReasonCode": "sample string 4",
  "RMRTrackingComments": "sample string 5",
  "ExistingRecurringIds": [
    1,
    2
  ],
  "NewRecurringIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<CustomerSystemSwap xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <CustomerId>2</CustomerId>
  <ExistingCustomerSystemId>1</ExistingCustomerSystemId>
  <ExistingRecurringIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ExistingRecurringIds>
  <NewCustomerSystemId>3</NewCustomerSystemId>
  <NewRecurringIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NewRecurringIds>
  <RMRReasonCode>sample string 4</RMRReasonCode>
  <RMRTrackingComments>sample string 5</RMRTrackingComments>
</CustomerSystemSwap>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerSystemSwap'.

Response Information

Resource Description

CustomerSystemSwap

Name	Description	Type	Additional information
ExistingCustomerSystemId	Sedona internal autonumber for the AR Customer System record (AR_Customer_System table)	integer	Required
CustomerId	Foreign key from AR_Customer table	integer	Required
NewCustomerSystemId	Sedona internal autonumber for the AR Customer System record (AR_Customer_System table)	integer	None.
RMRReasonCode	Reason for the RMR change; value from AR_RMR_Reason table (for Tracking record).	string	Required String length: inclusive between 0 and 25
RMRTrackingComments	Additional comments for the RMR Tracking table	string	String length: inclusive between 0 and 1024
ExistingRecurringIds	List of recurring ids associated with the system specified by ExistingCustomerSystemId, do not submit, will be overwritten	Collection of integer	None.
NewRecurringIds	List of new recurring ids associated with the new system specified by ExistingCustomerSystemId, do not submit, will be overwritten	Collection of integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ExistingCustomerSystemId": 1,
  "CustomerId": 2,
  "NewCustomerSystemId": 3,
  "RMRReasonCode": "sample string 4",
  "RMRTrackingComments": "sample string 5",
  "ExistingRecurringIds": [
    1,
    2
  ],
  "NewRecurringIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<CustomerSystemSwap xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <CustomerId>2</CustomerId>
  <ExistingCustomerSystemId>1</ExistingCustomerSystemId>
  <ExistingRecurringIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ExistingRecurringIds>
  <NewCustomerSystemId>3</NewCustomerSystemId>
  <NewRecurringIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NewRecurringIds>
  <RMRReasonCode>sample string 4</RMRReasonCode>
  <RMRTrackingComments>sample string 5</RMRTrackingComments>
</CustomerSystemSwap>