{ "swagger":"2.0", "info":{ "version":"v1", "title":"My.Store" }, "host":"api.me.com", "basePath":"/MyStore", "schemes":[ "http" ], "paths":{ "/Health/Status":{ "get":{ "tags":[ "Health" ], "operationId":"Health_Status", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/OutputHealthModel" } } } } }, "/Mys/Contacts/NonAddresses":{ "get":{ "tags":[ "MyContacts" ], "summary":"Get my contacts except address", "operationId":"MyContacts_GetAllNonAddressesAsync", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/OutputMyContactModel" } } } } } }, "/Mys/Contacts/NonAddresses/Active":{ "get":{ "tags":[ "MyContacts" ], "summary":"Get active my contacts except address", "operationId":"MyContacts_GetActiveNonAddressesAsync", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/OutputMyContactModel" } } } } } }, "/Mys/Contacts/Addresses":{ "get":{ "tags":[ "MyContacts" ], "summary":"Get all address for the My", "operationId":"MyContacts_GetAllAddressesAsync", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/OutputMyContactAddressModel" } } } } } }, "/Mys/Contacts/Addresses/Active":{ "get":{ "tags":[ "MyContacts" ], "summary":"Get all active address for the My", "operationId":"MyContacts_GetActiveAddressesAsync", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/OutputMyContactAddressModel" } } } } } }, "/Mys/Contacts/ByType/{contactType}":{ "get":{ "tags":[ "MyContacts" ], "summary":"Get My contacts by contact type", "operationId":"MyContacts_GetByTypeAsync", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "parameters":[ { "name":"contactType", "in":"path", "description":"\r\n1 = Website ,\r\n2 = Email,", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2 ] } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/OutputMyContactModel" } } } } } }, "/Mys/Contacts/Status/{category}/{contactType}":{ "get":{ "tags":[ "MyContacts" ], "summary":"Get My contact status type by contact category type and contact type", "operationId":"MyContacts_GetStatusByCategoryAndTypeAsync", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "parameters":[ { "name":"category", "in":"path", "description":"The ContactCategory you want the status for\r\n1 = Home ,\r\n2 = Office ,\r\n3 = Business ,\r\n4 = Other ,", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2, 3, 4 ] }, { "name":"contactType", "in":"path", "description":"The contactType you want the status for\r\n1 = Website ,\r\n2 = Email,", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2 ] } ], "responses":{ "200":{ "description":"OK", "schema":{ "format":"int32", "enum":[ 1, 2, 3, 4, 5 ], "type":"integer" } } } } }, "/Mys/Contacts/{MyID}/History":{ "get":{ "tags":[ "MyContacts" ], "summary":"Get My contact history", "operationId":"MyContacts_GetContactHistoryByMyAsync", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "parameters":[ { "name":"MyID", "in":"path", "description":"", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/OutputMyContactHistoryModel" } } } } } }, "/Mys/Contacts/Verify/{category}/{contactType}":{ "put":{ "tags":[ "MyContacts" ], "summary":"Sets the contact verified for a particular contact type and contact category type.", "operationId":"MyContacts_VerifyAsync", "consumes":[ ], "produces":[ ], "parameters":[ { "name":"category", "in":"path", "description":"\r\n1 = Home ,\r\n2 = Office ,\r\n3 = Business ,\r\n4 = Other ,", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2, 3, 4 ] }, { "name":"contactType", "in":"path", "description":"\r\n1 = Website ,\r\n2 = Email ,", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2 ] } ], "responses":{ "204":{ "description":"No Content" } } } }, "/Mys/Contacts":{ "put":{ "tags":[ "MyContacts" ], "summary":"Updates list of contact details for a My.", "operationId":"MyContacts_UpdateAsync", "consumes":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded", "application/bson" ], "produces":[ ], "parameters":[ { "name":"MyContactModels", "in":"body", "description":"", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ModifyMyContactModel" } } } ], "responses":{ "204":{ "description":"No Content" } } }, "post":{ "tags":[ "MyContacts" ], "summary":"Create list of contact details for a My.", "operationId":"MyContacts_CreateAsync", "consumes":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded", "application/bson" ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "parameters":[ { "name":"MyContactModels", "in":"body", "description":"The My contacts to be created", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/InputMyContactModel" } } } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/OutputMyContactModel" } } } } } }, "/Mys/Contacts/Deactivate/{category}/{contactType}":{ "put":{ "tags":[ "MyContacts" ], "summary":"UnSubscribes the My contact information of the My based on contact type and contact category type.", "operationId":"MyContacts_DeactivateAsync", "consumes":[ ], "produces":[ ], "parameters":[ { "name":"category", "in":"path", "description":"\r\n1 = Home ,\r\n2 = Office ,\r\n3 = Business ,\r\n4 = Other ,", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2, 3, 4 ] }, { "name":"contactType", "in":"path", "description":"\r\n1 = Website ,\r\n2 = Email ,", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2 ] } ], "responses":{ "204":{ "description":"No Content" } } } }, "/Mys/Contacts/{MyContactInformationID}":{ "delete":{ "tags":[ "MyContacts" ], "summary":"Deletes specific contact information for the My.", "operationId":"MyContacts_DeleteMyContact", "consumes":[ ], "produces":[ ], "parameters":[ { "name":"MyContactInformationID", "in":"path", "description":"", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "204":{ "description":"No Content" } } } }, "/Mys/Contacts/{category}/{contactType}":{ "delete":{ "tags":[ "MyContacts" ], "summary":"Deletes specific contact information by contact type and contact category type for the My.", "operationId":"MyContacts_DeleteAsync", "consumes":[ ], "produces":[ ], "parameters":[ { "name":"category", "in":"path", "description":"", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2, 3, 4 ] }, { "name":"contactType", "in":"path", "description":"", "required":true, "type":"integer", "format":"int32", "enum":[ 1, 2 ] } ], "responses":{ "204":{ "description":"No Content" } } } }, "/{authenticationKey}/{version}/MyContacts/HeartBeat":{ "get":{ "tags":[ "MyContacts" ], "operationId":"MyContacts_HeartBeat", "consumes":[ ], "produces":[ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/bson" ], "parameters":[ { "name":"authenticationKey", "in":"path", "required":true, "type":"string" }, { "name":"version", "in":"path", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"object" } } } } } }, "definitions":{ "OutputHealthModel":{ "type":"object", "properties":{ "SystemEntity":{ "type":"string" }, "EnvironmentName":{ "type":"string" }, "MachineName":{ "type":"string" }, "ApplicationName":{ "type":"string" }, "ApplicationVersion":{ "$ref":"#/definitions/Version" }, "ApplicationBuildDate":{ "format":"date-time", "type":"string" }, "BuildNumber":{ "$ref":"#/definitions/Version" }, "BuildNumberInfo":{ "type":"string" }, "BuildCommitSHA":{ "type":"string" }, "FrameworkVersion":{ "$ref":"#/definitions/Version" }, "FrameworkVersionInfo":{ "type":"string" } } }, "Version":{ "type":"object", "properties":{ "_Major":{ "format":"int32", "type":"integer" }, "_Minor":{ "format":"int32", "type":"integer" }, "_Build":{ "format":"int32", "type":"integer" }, "_Revision":{ "format":"int32", "type":"integer" } } }, "OutputMyContactModel":{ "required":[ "ContactType", "ContactCategoryType", "IsPrimary", "IsActive" ], "type":"object", "properties":{ "ContactValue":{ "type":"string" }, "MyID":{ "format":"int32", "type":"integer" }, "ContactStatusType":{ "format":"int32", "description":"\r\n1 = Verified ,\r\n2 = NotVerified ,", "enum":[ 1, 2 ], "type":"integer" }, "LastContactDate":{ "format":"date-time", "type":"string" }, "VerificationDate":{ "format":"date-time", "type":"string" }, "InitialVerificationDate":{ "format":"date-time", "type":"string" }, "ActiveDate":{ "format":"date-time", "type":"string" }, "LastModifyDate":{ "format":"date-time", "type":"string" }, "MyContactInformationID":{ "format":"int32", "type":"integer" }, "ContactType":{ "format":"int32", "description":"\r\n1 = Website ,\r\n2 = Email ,", "enum":[ 1, 2 ], "type":"integer" }, "ContactCategoryType":{ "format":"int32", "description":"\r\n1 = Home ,\r\n2 = Office ,\r\n3 = Business ,\r\n4 = Other ,", "enum":[ 1, 2, 3, 4 ], "type":"integer" }, "SurveyFrequencyIntervalHours":{ "format":"int32", "type":"integer" }, "IsPrimary":{ "type":"boolean" }, "IsActive":{ "type":"boolean" } } }, "OutputMyContactAddressModel":{ "required":[ "ContactType", "ContactCategoryType", "IsPrimary", "IsActive" ], "type":"object", "properties":{ "MyQuestionAnswerResponseModel":{ "type":"array", "items":{ "$ref":"#/definitions/OutputQuestionResponsesModel" } }, "MyID":{ "format":"int32", "type":"integer" }, "ContactStatusType":{ "format":"int32", "description":"\r\n1 = Verified ,\r\n2 = NotVerified ,", "enum":[ 1, 2 ], "type":"integer" }, "LastContactDate":{ "format":"date-time", "type":"string" }, "VerificationDate":{ "format":"date-time", "type":"string" }, "InitialVerificationDate":{ "format":"date-time", "type":"string" }, "ActiveDate":{ "format":"date-time", "type":"string" }, "LastModifyDate":{ "format":"date-time", "type":"string" }, "MyContactInformationID":{ "format":"int32", "type":"integer" }, "ContactType":{ "format":"int32", "description":"\r\n1 = Website ,\r\n2 = Email ,", "enum":[ 1, 2 ], "type":"integer" }, "ContactCategoryType":{ "format":"int32", "description":"\r\n1 = Home ,\r\n2 = Office ,\r\n3 = Business ,\r\n4 = Other ,", "enum":[ 1, 2, 3, 4 ], "type":"integer" }, "SurveyFrequencyIntervalHours":{ "format":"int32", "type":"integer" }, "IsPrimary":{ "type":"boolean" }, "IsActive":{ "type":"boolean" } } }, "OutputQuestionResponsesModel":{ "type":"object", "properties":{ "QuestionID":{ "format":"int32", "type":"integer" }, "AnswerID":{ "format":"int32", "type":"integer" }, "AnswerValue":{ "type":"string" }, "AnswerExpirationDate":{ "format":"date-time", "type":"string" }, "BlockedForPii":{ "type":"boolean" } } }, "OutputMyContactHistoryModel":{ "required":[ "ContactType", "ContactCategoryType", "IsPrimary", "IsActive" ], "type":"object", "properties":{ "HistoryCreationDate":{ "format":"date-time", "type":"string" }, "ContactStatusDate":{ "format":"date-time", "type":"string" }, "ContactValue":{ "type":"string" }, "MyID":{ "format":"int32", "type":"integer" }, "ContactStatusType":{ "format":"int32", "description":"\r\n1 = Verified ,\r\n2 = NotVerified ,", "enum":[ 1, 2 ], "type":"integer" }, "LastContactDate":{ "format":"date-time", "type":"string" }, "VerificationDate":{ "format":"date-time", "type":"string" }, "InitialVerificationDate":{ "format":"date-time", "type":"string" }, "ActiveDate":{ "format":"date-time", "type":"string" }, "LastModifyDate":{ "format":"date-time", "type":"string" }, "MyContactInformationID":{ "format":"int32", "type":"integer" }, "ContactType":{ "format":"int32", "description":"\r\n1 = Website ,\r\n2 = Email ,", "enum":[ 1, 2 ], "type":"integer" }, "ContactCategoryType":{ "format":"int32", "description":"\r\n1 = Home ,\r\n2 = Office ,\r\n3 = Business ,\r\n4 = Other ,", "enum":[ 1, 2, 3, 4 ], "type":"integer" }, "SurveyFrequencyIntervalHours":{ "format":"int32", "type":"integer" }, "IsPrimary":{ "type":"boolean" }, "IsActive":{ "type":"boolean" } } }, "InputMyContactModel":{ "required":[ "ContactType", "ContactCategoryType", "IsPrimary", "IsActive" ], "type":"object", "properties":{ "ContactType":{ "format":"int32", "description":"\r\n1 = Website ,\r\n2 = Email ,", "enum":[ 1, 2 ], "type":"integer" }, "ContactCategoryType":{ "format":"int32", "description":"\r\n1 = Home ,\r\n2 = Office ,\r\n3 = Business ,\r\n4 = Other ,", "enum":[ 1, 2, 3, 4 ], "type":"integer" }, "SurveyFrequencyIntervalHours":{ "format":"int32", "type":"integer" }, "IsPrimary":{ "type":"boolean" }, "IsActive":{ "type":"boolean" } } }, "ModifyMyContactModel":{ "required":[ "InputMyContactModel" ], "type":"object", "properties":{ "InputMyContactModel":{ "$ref":"#/definitions/BaseInputMyContactModel" }, "MyContactInformationID":{ "format":"int32", "type":"integer" } } }, "BaseInputMyContactModel":{ "required":[ "IsPrimary", "IsActive" ], "type":"object", "properties":{ "SurveyFrequencyIntervalHours":{ "format":"int32", "type":"integer" }, "IsPrimary":{ "type":"boolean" }, "IsActive":{ "type":"boolean" } } } }, "securityDefinitions":{ "Token":{ "type":"apiKey", "description":"Token Authentication", "name":"Token", "in":"Authentication" } } }