Military Affiliation API

Owned by Jason Elwood
Last updated: Feb 02, 2013Version comment
2 min read

Get All Military Affiliations

GET /ssp/api/1/reference/militaryAffiliation

Security

SERVICE_REFERENCE_READ

Returns

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Active Duty",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Active Duty",
 "objectStatus" : "ACTIVE"}

 

Get Military Affiliations by parameter

GET /ssp/api/1/reference/militaryAffiliation/{id}

Security

SERVICE_REFERENCE_READ

Returns

Military Affiliation

{ "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "createdBy" : 
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstName" : "John",
      "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "modifiedBy" : 
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstName" : "John",
      "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Naturalized Citizen",
 "description" : "Naturalized Citizen.",
 "objectStatus" : "ACTIVE"}

 

Create a Military Affiliation

POST /ssp/api/1/reference/militaryAffiliation

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"description" : "Active Duty",
 "name" : "Active Duty Service Member"}

Returns

Military Affiliation

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Active Duty Service Member.",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Active Duty",
 "objectStatus" : "ACTIVE"}

 

Save a Military Affiliation

PUT /ssp/api/1/reference/militaryAffiliation/{id}

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Active Duty Service Member.",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Active Duty",
 "objectStatus" : "ACTIVE"}

Returns

Military Affiliation

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Active Duty Service Member.",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Active Duty",
 "objectStatus" : "ACTIVE"}

 

Delete a Citizenship

DELETE /ssp/api/1/reference/militaryAffiliation/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}