POST api/BillCom/TestConnection

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BillComClientID	string	None.
BillComClientSecret	string	None.
BillComOrgID	string	None.
BillComAPIKey	string	None.

Request Formats

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

Sample:

{
  "billComClientID": "sample string 1",
  "billComClientSecret": "sample string 2",
  "billComOrgID": "sample string 3",
  "billComAPIKey": "sample string 4"
}

application/xml, text/xml

Sample:

<BillComConfigRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.BillCom">
  <BillComAPIKey>sample string 4</BillComAPIKey>
  <BillComClientID>sample string 1</BillComClientID>
  <BillComClientSecret>sample string 2</BillComClientSecret>
  <BillComOrgID>sample string 3</BillComOrgID>
</BillComConfigRequestModel>

multipart/form-data

Sample:

<BillComConfigRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.BillCom"><BillComAPIKey>sample string 4</BillComAPIKey><BillComClientID>sample string 1</BillComClientID><BillComClientSecret>sample string 2</BillComClientSecret><BillComOrgID>sample string 3</BillComOrgID></BillComConfigRequestModel>

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/Arrow.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/Arrow.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>