Get list of products
get
/PASService/rest/services/v1/products
Gets a list of latest 100 companies. Also, define expand attributes to expand a company by its sub-resources, such as products and plans.
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "the name of the child resource". More than one child can be specified using comma as a separator. Example:?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers). More than one child can be specified using comma as a separator. For example: "?expand=Employees,Localizations". Nested children can also be provided following the format: "Child.NestedChild" For example:"?expand=Employees.Managers" If a nested child is provided (Example:Employees.Managers), the missing children will be processed implicitly i.e.,"?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers", which will expand both Employees and Managers.
-
limit: integer(int32)
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer(int32)
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;loc!="NY.
There's no request body for this operation.
Back to TopResponse
200 Response
This operation fetches a list of prodcuts successfully.
Examples
This example describes how to get a list of latest 100 products and to define expand attributes to expand a product by its sub-resources such as plans.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl \
-X GET \
-H "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/v1/products" Example Response Body
The following shows an example of the response body in JSON format:
{
"count": 18,
"offset": 0,
"limit": 100,
"products": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/06B2036D-6CBD-45C6-9997-58D6E17D395C",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/06B2036D-6CBD-45C6-9997-58D6E17D395C/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "TestProduct_5",
"productDescription": "",
"effectiveFrom": "2014-12-23T00:00:00Z",
"effectiveTo": "2015-12-23T00:00:00Z",
"ancestorId": null,
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/06B2036D-6CBD-45C6-9997-58D6E17D395C/plans/78EB7DD1-329F-4143-9EFE-E42496103B0A",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "06B2036D-6CBD-45C6-9997-58D6E17D395C",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/41C2C5EF-E385-423B-AE30-5B9856AB7BB0",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/41C2C5EF-E385-423B-AE30-5B9856AB7BB0/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "TestProduct_2",
"productDescription": "",
"effectiveFrom": "2014-12-23T00:00:00Z",
"effectiveTo": "2015-12-23T00:00:00Z",
"ancestorId": null,
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/41C2C5EF-E385-423B-AE30-5B9856AB7BB0/plans/E5124A0D-15A6-4435-9EED-5A14FBE902FA",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "41C2C5EF-E385-423B-AE30-5B9856AB7BB0",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/9DBECC11-FC96-4260-8BD5-CDD8B7263446",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/9DBECC11-FC96-4260-8BD5-CDD8B7263446/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "TestProduct",
"productDescription": "",
"effectiveFrom": "2014-12-23T00:00:00Z",
"effectiveTo": "2015-12-23T00:00:00Z",
"ancestorId": null,
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/9DBECC11-FC96-4260-8BD5-CDD8B7263446/plans/947B47BD-230A-4BA8-8FC6-7CBE85844C9A",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "9DBECC11-FC96-4260-8BD5-CDD8B7263446",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/0E332D9E-E64B-408E-A827-1C9B567BBF2E",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/0E332D9E-E64B-408E-A827-1C9B567BBF2E/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Child product B",
"productDescription": "",
"effectiveFrom": "2014-12-22T00:00:00Z",
"effectiveTo": null,
"ancestorId": "2CB7ED70-B22C-460B-A9A0-15DDB40E1FE2",
"plans": null,
"productId": "0E332D9E-E64B-408E-A827-1C9B567BBF2E",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/22B64DD7-E933-4FD6-A2EC-1A8D2A2394F4",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/22B64DD7-E933-4FD6-A2EC-1A8D2A2394F4/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Child Product A",
"productDescription": "",
"effectiveFrom": "2014-12-22T00:00:00Z",
"effectiveTo": null,
"ancestorId": "2CB7ED70-B22C-460B-A9A0-15DDB40E1FE2",
"plans": null,
"productId": "22B64DD7-E933-4FD6-A2EC-1A8D2A2394F4",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/2CB7ED70-B22C-460B-A9A0-15DDB40E1FE2",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/2CB7ED70-B22C-460B-A9A0-15DDB40E1FE2/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Test Product",
"productDescription": "",
"effectiveFrom": "2014-12-22T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": null,
"productId": "2CB7ED70-B22C-460B-A9A0-15DDB40E1FE2",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/40C9F9AF-229A-48E4-AC5B-25074A9F61B2",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/40C9F9AF-229A-48E4-AC5B-25074A9F61B2/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Product 2",
"productDescription": "Test Production",
"effectiveFrom": "2014-12-22T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": null,
"productId": "40C9F9AF-229A-48E4-AC5B-25074A9F61B2",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/6ABD3734-73CF-4DF2-AD81-31201CF54FEC",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/6ABD3734-73CF-4DF2-AD81-31201CF54FEC/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Edit Child Product C",
"productDescription": "",
"effectiveFrom": "2014-12-22T00:00:00Z",
"effectiveTo": null,
"ancestorId": "2CB7ED70-B22C-460B-A9A0-15DDB40E1FE2",
"plans": null,
"productId": "6ABD3734-73CF-4DF2-AD81-31201CF54FEC",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/9738F003-B805-4B7E-92B2-E2B4F3451A3B",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/9738F003-B805-4B7E-92B2-E2B4F3451A3B/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Edit Product",
"productDescription": "",
"effectiveFrom": "2014-12-22T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": null,
"productId": "9738F003-B805-4B7E-92B2-E2B4F3451A3B",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/4848C86E-9582-42A5-9CB0-7DA0261557E6",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/4848C86E-9582-42A5-9CB0-7DA0261557E6/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Disability Products",
"productDescription": "Disability Products",
"effectiveFrom": "2010-03-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": "0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1",
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/4848C86E-9582-42A5-9CB0-7DA0261557E6/plans/C3B5382C-4A05-49A9-A69A-BFD3D55C94FD",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "4848C86E-9582-42A5-9CB0-7DA0261557E6",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/9B79777A-C984-4ADB-9DEB-11EF15B1F19F",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/9B79777A-C984-4ADB-9DEB-11EF15B1F19F/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "newproduct",
"productDescription": "newproduct877",
"effectiveFrom": "1990-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": null,
"productId": "9B79777A-C984-4ADB-9DEB-11EF15B1F19F",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Group Prototype Product",
"productDescription": "Group Prototype Product",
"effectiveFrom": "1980-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1/plans/3496675B-C87C-40E0-986A-B518DA2B5144",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1/plans/9F5507A5-B7EC-4637-BD86-5168A1864408",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1/plans/98F05107-233B-45D8-9EE0-CDD515B2B888",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1/plans/FC48B30A-5CEF-49D3-8B8B-F50DB6F7823C",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1/plans/388E9D8A-FFC5-4697-9CE3-FF49EAD9A4D3",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/1117EE7E-BEB8-4DA7-BC31-5997B767F4E6",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/1117EE7E-BEB8-4DA7-BC31-5997B767F4E6/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Individual Valuation Product",
"productDescription": "Individual Valuation Product",
"effectiveFrom": "1980-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": null,
"productId": "1117EE7E-BEB8-4DA7-BC31-5997B767F4E6",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/1B8EBC08-33FD-484E-BD60-831B03421ADA",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/1B8EBC08-33FD-484E-BD60-831B03421ADA/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Valuation Annuity Products",
"productDescription": "Valuation Annuity Products",
"effectiveFrom": "1980-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": "1117EE7E-BEB8-4DA7-BC31-5997B767F4E6",
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/1B8EBC08-33FD-484E-BD60-831B03421ADA/plans/389E1379-69CD-48DC-BEAE-38758156B469",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/1B8EBC08-33FD-484E-BD60-831B03421ADA/plans/3CD8F7B3-0928-43F9-8483-0AF739B4F36C",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/1B8EBC08-33FD-484E-BD60-831B03421ADA/plans/51673985-8606-4ABF-9EEE-85328BE03DA5",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/1B8EBC08-33FD-484E-BD60-831B03421ADA/plans/8528EFFA-F207-49F2-942A-447167744E86",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "1B8EBC08-33FD-484E-BD60-831B03421ADA",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Individual Prototype Product",
"productDescription": "Individual Prototype Product",
"effectiveFrom": "1980-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F/plans/01616C8F-4430-4F11-9257-B23626C50E99",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F/plans/575F5902-AE18-4279-9A3B-73679CFE769E",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F/plans/74C46F3A-7816-471A-BAC8-AECCD18E985C",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F/plans/8CAD77E4-8F72-401C-AA28-F7562756BDA3",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/3FE40262-1669-413E-ACBA-8615DD7DAA6F/plans/C5EE0DA4-3003-42C1-9468-D91DA546B79F",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "3FE40262-1669-413E-ACBA-8615DD7DAA6F",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/9C7D3B95-D690-4DDF-A113-A0B0243C1E65",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/9C7D3B95-D690-4DDF-A113-A0B0243C1E65/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Group Valuation Product",
"productDescription": "Group Valuation Product",
"effectiveFrom": "1980-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": null,
"plans": null,
"productId": "9C7D3B95-D690-4DDF-A113-A0B0243C1E65",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/AF346954-C02C-4091-BEB0-FED8CFBC2B38",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/AF346954-C02C-4091-BEB0-FED8CFBC2B38/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "TERM Products",
"productDescription": "TERM Products",
"effectiveFrom": "1980-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": "0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1",
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/AF346954-C02C-4091-BEB0-FED8CFBC2B38/plans/21546862-B921-429E-9B02-57C0CA62E375",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/AF346954-C02C-4091-BEB0-FED8CFBC2B38/plans/2E22F22A-1714-4CD1-8619-385A00CED1D4",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/AF346954-C02C-4091-BEB0-FED8CFBC2B38/plans/DE7CB128-68A1-41E2-A870-32528CD3C55A",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/AF346954-C02C-4091-BEB0-FED8CFBC2B38/plans/FF04A024-51D1-4DD8-BD48-F86901F29A84",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "AF346954-C02C-4091-BEB0-FED8CFBC2B38",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/B29A11E8-A787-48EE-9D4E-8435298763EE",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/products/B29A11E8-A787-48EE-9D4E-8435298763EE/plans",
"rel": "plans",
"mediaType": "application/json",
"method": "GET"
}
],
"productName": "Valuation Life Products",
"productDescription": "Valuation Life Products",
"effectiveFrom": "1980-01-01T00:00:00Z",
"effectiveTo": null,
"ancestorId": "1117EE7E-BEB8-4DA7-BC31-5997B767F4E6",
"plans": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/products/B29A11E8-A787-48EE-9D4E-8435298763EE/plans/3904A440-E035-40A1-9905-D544F7A6C093",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"productId": "B29A11E8-A787-48EE-9D4E-8435298763EE",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
}
]
}