Get a specific segment by segment Id
get
/PASService/rest/services/v1/segments/{segmentId}
Gets segment based on the specified segment Id.
Request
Path Parameters
-
segmentId(required): string(guid)
Segment Id
There's no request body for this operation.
Back to TopResponse
200 Response
This operation fetches a specific segment by segment Id successfully.
Examples
This example describes how to get a segment based on the specified segment Id.
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/segments/A3046709-CF2E-4AFF-A4B9-D65C4769F838"
Example Response Body
The following shows an example of the response body in JSON format:
{ "segment": { "links": [ { "href": "http://server:port/PASService/rest/services/v1/segments/D01AA0A5-D21E-44ED-8035-D3CBB276F883", "rel": "self", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/v1/codes?codeName=Status&codeValue=24", "rel": "codes/status", "mediaType": "application/json", "method": "GET" } ], "multiFields": {}, "codes": null, "effectiveDate": null, "roles": [ { "links": [ { "href": "http://server:port/PASService/rest/services/v1/roles/0CA1DDA5-7683-42DA-837F-1EE0E45D05B4", "rel": "self", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PercentDollar&codeValue=C", "rel": "codes/percentDollar", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/v1/codes?codeName=Role&codeValue=72", "rel": "codes/role", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/v1/codes?codeName=State&codeValue=CA", "rel": "codes/stateCode", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RoleStatus&codeValue=01", "rel": "codes/status", "mediaType": "application/json", "method": "GET" } ], "fields": {}, "multiFields": {}, "codes": [ { "codeName": "AsCodeRole", "codeValue": "72", "longDescription": "Participant-Primary Member", "shortDescription": "Participant-Member" }, { "codeName": "AsCodeRoleStatus", "codeValue": "01", "longDescription": "Active", "shortDescription": "Active" } ], "roleAmount": 12.0, "rolePercent": 100.0, "stateCode": "CA", "roleId": "0CA1DDA5-7683-42DA-837F-1EE0E45D05B4", "clientId": "37D2EEE3-8624-48C6-981F-2B2891CDB852", "externalclientId": "280D55E1-4BC6-4CA0-9AD2-BE6761DB55FC", "companyId": "7560150B-BA78-45EF-8747-209DCB9BB94D", "percentDollar": "C", "policyId": "F8CC7B38-95F9-4240-A528-B890AF87188C", "role": "72", "segmentId": "D01AA0A5-D21E-44ED-8035-D3CBB276F883", "status": "01" } ], "segmentId": "D01AA0A5-D21E-44ED-8035-D3CBB276F883", "parentSegmentId": null, "policyId": "F8CC7B38-95F9-4240-A528-B890AF87188C", "segmentNameId": "8123E9B1-498C-4A06-A065-5A4D384C2167", "status": "24", "planSegmentNameId": null, "segmentName": { "multiFields": null, "codes": null, "segmentName": "Base Coverage", "activeFromDate": null, "activeToDate": null, "planSegmentName": null, "segmentNameId": "8123E9B1-498C-4A06-A065-5A4D384C2167", "planId": "C5EE0DA4-3003-42C1-9468-D91DA546B79F", "productId": null, "type": "04", "status": "01" }, "SegmentAmount": { "value": 51000.0, "currency": "USD" } } }