Create FileReceived
post
/PASService/rest/services/v1/fileReceived
Creates entities as supported by FileReceived web service
Request
Header Parameters
-
Content-Type: string
Describes the content type of the current request/response. The content-type can be application/JSON or application/XML.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
stringRoot Schema : schema
Type:
stringResponse
201 Response
This response code indicates that the operation has been completed successfully.
Examples
This example describes how to create entities as supported by FileReceived Web Service in both JSON and XML format.
Example cURL Command in JSON format
Use the following cURL command to submit a request on the REST resource:
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/v1/fileReceived" \
-d '{"Use this placeholder to plug-in the example request body given below"}'
Note:
The request example given below is dependent on file configuration in the rulespalette. This request expects data to be sent as body which has its respective file configured in the palette.Example Request Body in JSON format
The following shows an example of the request body in JSON format:
{
"fileReceived":
{
"fileId": "AI",
"companyGuid": "7204C2FE-13B1-4A48-8CDA-DE8386C60EF9",
"NewActivity":
{
"PlanName": "Guaranteed Level Premium Term",
"PlanDate": "7/10/2006",
"PolicyNumber": "Glpt_9185",
"SuspenseNumber": 41388,
"ClientNumber": "qatester3",
"Transaction":
[
{
"TransactionName": "CoverageCalculation",
"TransactionGuid": "28821370-0B58-458A-BBF3-A8D8DBC4F08E",
"ProcessingOrder": 1000,
"ActivityGuid": "6A8CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "01",
"StatusCode": "02",
"EffectiveDate": "7/10/2006",
"ActivityFields": {
"Field": {
"ActivityGuid": "6A8CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "01",
"Name": "IssueDate",
"Value": "7/10/2006"
}
}
},
{
"TransactionName": "Premium",
"TransactionGuid": "A99B6861-72A4-47FF-8001-D7A73114A098",
"SuspenseCode": "01",
"SpecifiedAmount": 6256,
"ProcessingOrder": 4580,
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "01",
"StatusCode": "02",
"EffectiveDate": "7/10/2006",
"ActivityFields": {
"Field": [
{
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "03",
"Name": "MonthsToAdvancePaidToDate",
"Value": 0
},
{
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "04",
"Name": "PaymentAmount",
"Value": 1997.34,
"CurrencyCode": "USD"
},
{
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "04",
"Name": "ValidAmount",
"Value": 1997.34,
"CurrencyCode": "USD"
}
]
}
},
{
"TransactionName": "Issue",
"TransactionGuid": "1FA8B005-C8AA-4058-9F72-027CC03DC651",
"ProcessingOrder": 5000,
"ActivityGuid": "2B2CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "01",
"StatusCode": "02",
"EffectiveDate": "7/10/2006",
"ActivityFields": {
"Field": [
{
"ActivityGuid": "2B2CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "01",
"Name": "IssueDate",
"Value": "7/10/2006"
},
{
"ActivityGuid": "2B2CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TypeCode": "01",
"Name": "ActiveDate",
"Value": "7/10/2006"
}
]
}
}
]
}
}
}
Example Response Body in JSON format
The following shows an example of the response body in JSON format:
{
"AsXml": {
"AsActivity": [
{
"ActivityGuid": "6A8CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TransactionGuid": "28821370-0B58-458A-BBF3-A8D8DBC4F08E",
"PolicyGuid": "AFFFA1F9-362D-40F1-B0C8-509522A1501F",
"TypeCode": "01",
"StatusCode": "02",
"EffectiveDate": "7/10/2006",
"ActiveFromDate": "07/31/2015",
"ClientNumber": "qatester3",
"ProcessingOrder": "1000",
"EntryGmt": "2021-04-15 11:51:13.985",
"CreationGmt": "2021-04-15 11:51:13.985",
"ErrorStatusCode": "01",
"SuspenseStatusCode": "01",
"ActivityFields": {
"AsActivityField": {
"ActivityGuid": "6A8CD2D9-B91D-4C4F-A903-91FA41D972EC",
"FieldName": "IssueDate",
"FieldTypeCode": "01",
"DateValue": "7/10/2006",
"CurrencyCode": {
"-self-closing": "true"
},
"BigTextValue": {
"-self-closing": "true"
}
}
}
},
{
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TransactionGuid": "A99B6861-72A4-47FF-8001-D7A73114A098",
"PolicyGuid": "AFFFA1F9-362D-40F1-B0C8-509522A1501F",
"TypeCode": "01",
"StatusCode": "02",
"EffectiveDate": "7/10/2006",
"ActiveFromDate": "07/31/2015",
"ClientNumber": "qatester3",
"ProcessingOrder": "4580",
"EntryGmt": "2021-04-15 11:51:13.985",
"CreationGmt": "2021-04-15 11:51:13.985",
"ErrorStatusCode": "01",
"SuspenseStatusCode": "01",
"ActivityFields": {
"AsActivityField": [
{
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"FieldName": "MonthsToAdvancePaidToDate",
"FieldTypeCode": "03",
"IntValue": "0",
"CurrencyCode": {
"-self-closing": "true"
},
"BigTextValue": {
"-self-closing": "true"
}
},
{
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"FieldName": "PaymentAmount",
"FieldTypeCode": "04",
"FloatValue": "1997.34",
"CurrencyCode": "USD",
"BigTextValue": {
"-self-closing": "true"
}
},
{
"ActivityGuid": "7A1CD2D9-B91D-4C4F-A903-91FA41D972EC",
"FieldName": "ValidAmount",
"FieldTypeCode": "04",
"FloatValue": "1997.34",
"CurrencyCode": "USD",
"BigTextValue": {
"-self-closing": "true"
}
}
]
}
},
{
"ActivityGuid": "2B2CD2D9-B91D-4C4F-A903-91FA41D972EC",
"TransactionGuid": "1FA8B005-C8AA-4058-9F72-027CC03DC651",
"PolicyGuid": "AFFFA1F9-362D-40F1-B0C8-509522A1501F",
"TypeCode": "01",
"StatusCode": "02",
"EffectiveDate": "7/10/2006",
"ActiveFromDate": "07/31/2015",
"ClientNumber": "qatester3",
"ProcessingOrder": "5000",
"EntryGmt": "2021-04-15 11:51:13.987",
"CreationGmt": "2021-04-15 11:51:13.987",
"ErrorStatusCode": "01",
"SuspenseStatusCode": "01",
"ActivityFields": {
"AsActivityField": [
{
"ActivityGuid": "2B2CD2D9-B91D-4C4F-A903-91FA41D972EC",
"FieldName": "IssueDate",
"FieldTypeCode": "01",
"DateValue": "7/10/2006",
"CurrencyCode": {
"-self-closing": "true"
},
"BigTextValue": {
"-self-closing": "true"
}
},
{
"ActivityGuid": "2B2CD2D9-B91D-4C4F-A903-91FA41D972EC",
"FieldName": "ActiveDate",
"FieldTypeCode": "01",
"DateValue": "7/10/2006",
"CurrencyCode": {
"-self-closing": "true"
},
"BigTextValue": {
"-self-closing": "true"
}
}
]
}
}
],
"AsErrorDetail": {
"Result": {
"Process": "Success",
"PolicyNumber": "Glpt_9185"
}
}
}
}
Example cURL Command for XML
Use the following cURL command to submit a request on the REST resource:
curl -X POST
-H "Accept: application/xml"
-H "Content-Type: application/xml" \
-u username:password \
"http://server:port/PASService/rest/services/v1/fileReceived" \ Example Request Body in XML format
The following shows an example of the request body in XML format:
<FileReceived> <FileId>AI</FileId> <CompanyGuid>7204C2FE-13B1-4A48-8CDA-DE8386C60EF9</CompanyGuid> <NewActivity> <PlanName>Guaranteed Level Premium Term</PlanName> <PlanDate>7/10/2006</PlanDate> <PolicyNumber>Glpt_9185</PolicyNumber> <SuspenseNumber>34987</SuspenseNumber> <ClientNumber>qatester3</ClientNumber> <Transaction> <TransactionName>CoverageCalculation</TransactionName> <TransactionGuid>28821370-0B58-458A-BBF3-A8D8DBC4F08E</TransactionGuid> <ProcessingOrder>1000</ProcessingOrder> <ActivityGuid>2B8CD2D9-B92D-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>01</TypeCode> <StatusCode>02</StatusCode> <EffectiveDate>7/10/2006</EffectiveDate> <ActivityFields> <Field> <ActivityGuid>2B8CD2D9-B92D-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>01</TypeCode> <Name>IssueDate</Name> <Value>7/10/2006</Value> </Field> </ActivityFields> </Transaction> <Transaction> <TransactionName>Premium</TransactionName> <TransactionGuid>A99B6861-72A4-47FF-8001-D7A73114A098</TransactionGuid> <SuspenseCode>01</SuspenseCode> <SpecifiedAmount>6256</SpecifiedAmount> <ProcessingOrder>4580</ProcessingOrder> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>01</TypeCode> <StatusCode>02</StatusCode> <EffectiveDate>7/10/2006</EffectiveDate> <ActivityFields> <Field> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>03</TypeCode> <Name>MonthsToAdvancePaidToDate</Name> <Value>0</Value> </Field> <Field> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>04</TypeCode> <Name>PaymentAmount</Name> <Value>1997.34</Value> <CurrencyCode>USD</CurrencyCode> </Field> <Field> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>04</TypeCode> <Name>ValidAmount</Name> <Value>1997.34</Value> <CurrencyCode>USD</CurrencyCode> </Field> </ActivityFields> </Transaction> <Transaction> <TransactionName>Issue</TransactionName> <TransactionGuid>1FA8B005-C8AA-4058-9F72-027CC03DC651</TransactionGuid> <ProcessingOrder>5000</ProcessingOrder> <ActivityGuid>3A4CA2D9-B91D-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>01</TypeCode> <StatusCode>02</StatusCode> <EffectiveDate>7/10/2006</EffectiveDate> <ActivityFields> <Field> <ActivityGuid>3A4CA2D9-B91D-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>01</TypeCode> <Name>IssueDate</Name> <Value>7/10/2006</Value> </Field> <Field> <ActivityGuid>3A4CA2D9-B91D-4C4F-A903-91FA41D972EC</ActivityGuid> <TypeCode>01</TypeCode> <Name>ActiveDate</Name> <Value>7/10/2006</Value> </Field> </ActivityFields> </Transaction> </NewActivity> </FileReceived>
Example Response Body in XML format
The following shows an example of the response body in XML format:
<AsXml> <AsActivity> <ActivityGuid>2B8CD2D9-B92D-4C4F-A903-91FA41D972EC</ActivityGuid> <TransactionGuid>28821370-0B58-458A-BBF3-A8D8DBC4F08E</TransactionGuid> <PolicyGuid>AFFFA1F9-362D-40F1-B0C8-509522A1501F</PolicyGuid> <TypeCode>01</TypeCode> <StatusCode>02</StatusCode> <EffectiveDate>7/10/2006</EffectiveDate> <ActiveFromDate>07/31/2015</ActiveFromDate> <ClientNumber>qatester3</ClientNumber> <ProcessingOrder>1000</ProcessingOrder> <EntryGmt>2021-04-15 11: 56: 33.602</EntryGmt> <CreationGmt>2021-04-15 11: 56: 33.602</CreationGmt> <ErrorStatusCode>01</ErrorStatusCode> <SuspenseStatusCode>01</SuspenseStatusCode> <XmlData><Activity></Activity></XmlData> <ActivityFields> <AsActivityField> <ActivityGuid>2B8CD2D9-B92D-4C4F-A903-91FA41D972EC</ActivityGuid> <FieldName>IssueDate</FieldName> <FieldTypeCode>01</FieldTypeCode> <DateValue>7/10/2006</DateValue> <CurrencyCode></CurrencyCode> <BigTextValue></BigTextValue> </AsActivityField> </ActivityFields> </AsActivity> <AsActivity> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <TransactionGuid>A99B6861-72A4-47FF-8001-D7A73114A098</TransactionGuid> <PolicyGuid>AFFFA1F9-362D-40F1-B0C8-509522A1501F</PolicyGuid> <TypeCode>01</TypeCode> <StatusCode>02</StatusCode> <EffectiveDate>7/10/2006</EffectiveDate> <ActiveFromDate>07/31/2015</ActiveFromDate> <ClientNumber>qatester3</ClientNumber> <ProcessingOrder>4580</ProcessingOrder> <EntryGmt>2021-04-15 11: 56: 33.602</EntryGmt> <CreationGmt>2021-04-15 11: 56: 33.602</CreationGmt> <ErrorStatusCode>01</ErrorStatusCode> <SuspenseStatusCode>01</SuspenseStatusCode> <XmlData><Activity></Activity></XmlData> <ActivityFields> <AsActivityField> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <FieldName>MonthsToAdvancePaidToDate</FieldName> <FieldTypeCode>03</FieldTypeCode> <IntValue>0</IntValue> <CurrencyCode></CurrencyCode> <BigTextValue></BigTextValue> </AsActivityField> <AsActivityField> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <FieldName>PaymentAmount</FieldName> <FieldTypeCode>04</FieldTypeCode> <FloatValue>1997.34</FloatValue> <CurrencyCode>USD</CurrencyCode> <BigTextValue></BigTextValue> </AsActivityField> <AsActivityField> <ActivityGuid>6A2CD2D9-B92A-4C4F-A903-91FA41D972EC</ActivityGuid> <FieldName>ValidAmount</FieldName> <FieldTypeCode>04</FieldTypeCode> <FloatValue>1997.34</FloatValue> <CurrencyCode>USD</CurrencyCode> <BigTextValue></BigTextValue> </AsActivityField> </ActivityFields> </AsActivity> <AsActivity> <ActivityGuid>3A4CA2D9-B91D-4C4F-A903-91FA41D972EC</ActivityGuid> <TransactionGuid>1FA8B005-C8AA-4058-9F72-027CC03DC651</TransactionGuid> <PolicyGuid>AFFFA1F9-362D-40F1-B0C8-509522A1501F</PolicyGuid> <TypeCode>01</TypeCode> <StatusCode>02</StatusCode> <EffectiveDate>7/10/2006</EffectiveDate> <ActiveFromDate>07/31/2015</ActiveFromDate> <ClientNumber>qatester3</ClientNumber> <ProcessingOrder>5000</ProcessingOrder> <EntryGmt>2021-04-15 11: 56: 33.603</EntryGmt> <CreationGmt>2021-04-15 11: 56: 33.604</CreationGmt> <ErrorStatusCode>01</ErrorStatusCode> <SuspenseStatusCode>01</SuspenseStatusCode> <XmlData><Activity></Activity></XmlData> <ActivityFields> <AsActivityField> <ActivityGuid>3A4CA2D9-B91D-4C4F-A903-91FA41D972EC</ActivityGuid> <FieldName>IssueDate</FieldName> <FieldTypeCode>01</FieldTypeCode> <DateValue>7/10/2006</DateValue> <CurrencyCode></CurrencyCode> <BigTextValue></BigTextValue> </AsActivityField> <AsActivityField> <ActivityGuid>3A4CA2D9-B91D-4C4F-A903-91FA41D972EC</ActivityGuid> <FieldName>ActiveDate</FieldName> <FieldTypeCode>01</FieldTypeCode> <DateValue>7/10/2006</DateValue> <CurrencyCode></CurrencyCode> <BigTextValue></BigTextValue> </AsActivityField> </ActivityFields> </AsActivity> <AsErrorDetail> <Result> <Process>Success</Process> <PolicyNumber>Glpt_9185</PolicyNumber> </Result> </AsErrorDetail> </AsXml>