Body Content-Type POST JSON 200 (OK) application/json JSON Object <QueryURI>/segment Object (SegmentData) Error code application/json JSON Object (Reason) Content of the request body JSON object: Key Type Description Required A Pseudonymous Key representing the ConsumerID requesting Consumer who is the subject of the Yes String segment data request. A Pseudonymous Key representing the OperatorID Yes String Consumer’s Operator. Content of the response body JSON object when a 200 (OK) status code is returned: Key Type Description Required An object containing residential time zone and latitude, gender, and year of birth. The field SegmentData Object No names are ResidentTimeZone, ResidentLatitude, Gender and YearOfBirth. The time zone in which the Consumer generally ResidentTimeZone String resides, as a string indicating +/-hh:mm from No UTC (e.g "-05:00"). The latitude (rounded to an integer) at which the ResidentLatitude Number No Consumer generally resides. Integer representing the gender of the Consumer, Gender Number No 0 = not known; 1 = male; 2 = female; 9 = not applicable. Year in which the Consumer was born as an YearOfBirth Number No integer. The Gender parameter SHALL have enumerated fields reserved for compliance with [ISO/IEC 5218]. Content of the response body JSON object in the case of an Key Type Description Required An OPTIONAL description of why the request Reason String No failed. Example Example request messages: POST segment {"ConsumerID" : "ed58fc40-a866-11e4-bcd8-0800200c9a66", "OperatorID" : "fd58dc41-a856-31d4-5558-6534237776ac"}
Body Content-Type POST <QueryURI>/segment JSON Object 200 (OK) application/json JSON Object (SegmentData) Error code application/json JSON Object (Reason) Content of the request body JSON object: Key Type Description Required ConsumerID String A Pseudonymous Key representing the requesting Consumer who is the subject of the segment data request. Yes OperatorID String A Pseudonymous Key representing the Consumer’s Operator. Yes Content of the response body JSON object when a 200 (OK) status code is returned: Key Type Description Required SegmentData Object An object containing residential time zone and latitude, gender, and year of birth. The field names are ResidentTimeZone, ResidentLatitude, Gender and YearOfBirth. No ResidentTimeZone String The time zone in which the Consumer generally resides, as a string indicating +/-hh:mm from UTC (e.g "-05:00"). No ResidentLatitude Number The latitude (rounded to an integer) at which the Consumer generally resides. No Gender Number Integer representing the gender of the Consumer, 0 = not known; 1 = male; 2 = female; 9 = not applicable. No YearOfBirth Number Year in which the Consumer was born as an integer. No The Gender parameter SHALL have enumerated fields reserved for compliance with [ISO/IEC 5218]. Content of the response body JSON object in the case of an Key Type Description Required Reason String An OPTIONAL description of why the request failed. No Example Example request messages: POST segment {"ConsumerID" : "ed58fc40-a866-11e4-bcd8-0800200c9a66", "OperatorID" : "fd58dc41-a856-31d4-5558-6534237776ac"}
COEL-v1.0-csprd02.docx