POST api/ServiceAgreement

Add service agreement to workorder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
AutoServiceMasterID	integer	Required
UserID	integer	Required
ServiceAmount	decimal number	None.
SalePerson	integer	None.
SaleOfDate	string	None.
NextVisitDate	Collection of ServiceAgreementVisitDateRequestModel	None.
NextPaymentDate	Collection of ServiceAgreementPaymentDateRequestModel	None.
ServiceAgreementMasterID	integer	None.
PackageName	string	None.
Amount	string	None.
Savings	string	None.
SpiffPayAmount	string	None.
SpiffPayPercentage	string	None.
MaintenanceType	string	None.
MaintenanceTypeDesc	string	None.
InvoiceMessage	string	None.
TypeOfService	string	None.
NoOfVisit	integer	None.
RepeatsType	integer	None.
RepeatsTime	string	None.
PaymentFrequency	string	None.
NextAmount	string	None.
NoOfPayment	integer	None.
NextRepeatsType	integer	None.
NextRepeatsTime	string	None.
TotalRepeatPackage	string	None.
IsActive	boolean	None.
_objComment	Collection of ServiceAgreementCommentRequestModel	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "apiKey": "sample string 1",
  "autoServiceMasterID": 2,
  "userID": 3,
  "serviceAmount": 4.0,
  "salePerson": 1,
  "saleOfDate": "sample string 5",
  "nextVisitDate": [
    {
      "visitSlNo": 1,
      "nextVisitDate": "sample string 2"
    },
    {
      "visitSlNo": 1,
      "nextVisitDate": "sample string 2"
    }
  ],
  "nextPaymentDate": [
    {
      "paymentSlNo": 1,
      "nextPaymentDate": "sample string 2"
    },
    {
      "paymentSlNo": 1,
      "nextPaymentDate": "sample string 2"
    }
  ],
  "serviceAgreementMasterID": 6,
  "packageName": "sample string 7",
  "amount": "sample string 8",
  "savings": "sample string 9",
  "spiffPayAmount": "sample string 10",
  "spiffPayPercentage": "sample string 11",
  "maintenanceType": "sample string 12",
  "maintenanceTypeDesc": "sample string 13",
  "invoiceMessage": "sample string 14",
  "typeOfService": "sample string 15",
  "noOfVisit": 16,
  "repeatsType": 17,
  "repeatsTime": "sample string 18",
  "paymentFrequency": "sample string 19",
  "nextAmount": "sample string 20",
  "noOfPayment": 21,
  "nextRepeatsType": 22,
  "nextRepeatsTime": "sample string 23",
  "totalRepeatPackage": "sample string 24",
  "isActive": true,
  "_objComment": [
    {
      "serviceAgeentCommetID": 1,
      "message": "sample string 1",
      "competitor": "sample string 2",
      "comment": "sample string 3"
    },
    {
      "serviceAgeentCommetID": 1,
      "message": "sample string 1",
      "competitor": "sample string 2",
      "comment": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<ServiceAgreementWorkOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Amount>sample string 8</Amount>
  <InvoiceMessage>sample string 14</InvoiceMessage>
  <IsActive>true</IsActive>
  <MaintenanceType>sample string 12</MaintenanceType>
  <MaintenanceTypeDesc>sample string 13</MaintenanceTypeDesc>
  <NextAmount>sample string 20</NextAmount>
  <NextRepeatsTime>sample string 23</NextRepeatsTime>
  <NextRepeatsType>22</NextRepeatsType>
  <NoOfPayment>21</NoOfPayment>
  <NoOfVisit>16</NoOfVisit>
  <PackageName>sample string 7</PackageName>
  <PaymentFrequency>sample string 19</PaymentFrequency>
  <RepeatsTime>sample string 18</RepeatsTime>
  <RepeatsType>17</RepeatsType>
  <Savings>sample string 9</Savings>
  <ServiceAgreementMasterID>6</ServiceAgreementMasterID>
  <SpiffPayAmount>sample string 10</SpiffPayAmount>
  <SpiffPayPercentage>sample string 11</SpiffPayPercentage>
  <TotalRepeatPackage>sample string 24</TotalRepeatPackage>
  <TypeOfService>sample string 15</TypeOfService>
  <_objComment>
    <ServiceAgreementCommentRequestModel>
      <Comment>sample string 3</Comment>
      <Competitor>sample string 2</Competitor>
      <Message>sample string 1</Message>
      <ServiceAgeentCommetID>1</ServiceAgeentCommetID>
    </ServiceAgreementCommentRequestModel>
    <ServiceAgreementCommentRequestModel>
      <Comment>sample string 3</Comment>
      <Competitor>sample string 2</Competitor>
      <Message>sample string 1</Message>
      <ServiceAgeentCommetID>1</ServiceAgeentCommetID>
    </ServiceAgreementCommentRequestModel>
  </_objComment>
  <APIKey>sample string 1</APIKey>
  <AutoServiceMasterID>2</AutoServiceMasterID>
  <NextPaymentDate>
    <ServiceAgreementPaymentDateRequestModel>
      <NextPaymentDate>sample string 2</NextPaymentDate>
      <PaymentSlNo>1</PaymentSlNo>
    </ServiceAgreementPaymentDateRequestModel>
    <ServiceAgreementPaymentDateRequestModel>
      <NextPaymentDate>sample string 2</NextPaymentDate>
      <PaymentSlNo>1</PaymentSlNo>
    </ServiceAgreementPaymentDateRequestModel>
  </NextPaymentDate>
  <NextVisitDate>
    <ServiceAgreementVisitDateRequestModel>
      <NextVisitDate>sample string 2</NextVisitDate>
      <VisitSlNo>1</VisitSlNo>
    </ServiceAgreementVisitDateRequestModel>
    <ServiceAgreementVisitDateRequestModel>
      <NextVisitDate>sample string 2</NextVisitDate>
      <VisitSlNo>1</VisitSlNo>
    </ServiceAgreementVisitDateRequestModel>
  </NextVisitDate>
  <SaleOfDate>sample string 5</SaleOfDate>
  <SalePerson>1</SalePerson>
  <ServiceAmount>4</ServiceAmount>
  <UserID>3</UserID>
</ServiceAgreementWorkOrderRequestModel>

multipart/form-data

Sample:

<ServiceAgreementWorkOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Amount>sample string 8</Amount><InvoiceMessage>sample string 14</InvoiceMessage><IsActive>true</IsActive><MaintenanceType>sample string 12</MaintenanceType><MaintenanceTypeDesc>sample string 13</MaintenanceTypeDesc><NextAmount>sample string 20</NextAmount><NextRepeatsTime>sample string 23</NextRepeatsTime><NextRepeatsType>22</NextRepeatsType><NoOfPayment>21</NoOfPayment><NoOfVisit>16</NoOfVisit><PackageName>sample string 7</PackageName><PaymentFrequency>sample string 19</PaymentFrequency><RepeatsTime>sample string 18</RepeatsTime><RepeatsType>17</RepeatsType><Savings>sample string 9</Savings><ServiceAgreementMasterID>6</ServiceAgreementMasterID><SpiffPayAmount>sample string 10</SpiffPayAmount><SpiffPayPercentage>sample string 11</SpiffPayPercentage><TotalRepeatPackage>sample string 24</TotalRepeatPackage><TypeOfService>sample string 15</TypeOfService><_objComment><ServiceAgreementCommentRequestModel><Comment>sample string 3</Comment><Competitor>sample string 2</Competitor><Message>sample string 1</Message><ServiceAgeentCommetID>1</ServiceAgeentCommetID></ServiceAgreementCommentRequestModel><ServiceAgreementCommentRequestModel><Comment>sample string 3</Comment><Competitor>sample string 2</Competitor><Message>sample string 1</Message><ServiceAgeentCommetID>1</ServiceAgeentCommetID></ServiceAgreementCommentRequestModel></_objComment><APIKey>sample string 1</APIKey><AutoServiceMasterID>2</AutoServiceMasterID><NextPaymentDate><ServiceAgreementPaymentDateRequestModel><NextPaymentDate>sample string 2</NextPaymentDate><PaymentSlNo>1</PaymentSlNo></ServiceAgreementPaymentDateRequestModel><ServiceAgreementPaymentDateRequestModel><NextPaymentDate>sample string 2</NextPaymentDate><PaymentSlNo>1</PaymentSlNo></ServiceAgreementPaymentDateRequestModel></NextPaymentDate><NextVisitDate><ServiceAgreementVisitDateRequestModel><NextVisitDate>sample string 2</NextVisitDate><VisitSlNo>1</VisitSlNo></ServiceAgreementVisitDateRequestModel><ServiceAgreementVisitDateRequestModel><NextVisitDate>sample string 2</NextVisitDate><VisitSlNo>1</VisitSlNo></ServiceAgreementVisitDateRequestModel></NextVisitDate><SaleOfDate>sample string 5</SaleOfDate><SalePerson>1</SalePerson><ServiceAmount>4</ServiceAmount><UserID>3</UserID></ServiceAgreementWorkOrderRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>