Method Request Response Status Response Response Body Body Content-Type POST JSON 200 (OK) None None <ManagementURI>/ Object 410 (Gone) application/json JSON Object operator/consumer Error code application/json JSON Object Content of the request body JSON object: Key Type Description Required A Pseudonymous Key associated with OperatorID Yes String the Operator and generated by an IDA. A Pseudonymous Key associated with ConsumerID the Consumer and generated by an Yes String IDA. Time stamp, in DateTime format, of the TimeStamp ConsumerID indicating when the IDA Yes String created this Pseudonymous Key. Signature proving that an IDA created Signature Yes String this ConsumerID. An OPTIONAL object containing (OPTIONALLY) residential time zone and latitude, gender, and year of birth. SegmentData No Object The field names are: ResidentTimeZone; ResidentLatitude; Gender; and YearOfBirth. The time zone in which the Consumer ResidentTimeZone generally resides, as a string indicating No String +/-hh:mm from UTC (e.g "-05:00"). The latitude (rounded to an integer) at ResidentLatitude No Number the Consumer generally resides. Integer representing the gender of the Consumer, where: Gender No Number 0 = not known; 1 = male; 2 = female; 9 = not applicable. Year in which the Consumer was born YearOfBirth No Number as an 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 error: Key Type Description Required An OPTIONAL description of why the request Reason String No failed. Example Example request message: POST operator/consumer
Method Request Body Response Status Response Content-Type Response Body POST <ManagementURI>/ operator/consumer JSON Object 200 (OK) None None 410 (Gone) application/json JSON Object Error code application/json JSON Object Content of the request body JSON object: Key Type Description Required OperatorID String A Pseudonymous Key associated with the Operator and generated by an IDA. Yes ConsumerID String A Pseudonymous Key associated with the Consumer and generated by an IDA. Yes TimeStamp String Time stamp, in DateTime format, of the ConsumerID indicating when the IDA created this Pseudonymous Key. Yes Signature String Signature proving that an IDA created this ConsumerID. Yes SegmentData Object An OPTIONAL object containing (OPTIONALLY) 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 the Consumer generally resides. No Gender Number Integer representing the gender of the Consumer, where: 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 error: Key Type Description Required Reason String An OPTIONAL description of why the request failed. No Example Example request message: POST operator/consumer
COEL-v1.0-cs02.docx