HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /jsv/reply/SlotDistrictRequest HTTP/1.1
Host: api3.appreciationfinancial.com
Content-Type: text/jsv
Content-Length: length
{
SlotDistrict:
{
ID: 0,
Name: String,
County: String,
DistrictId: 0,
DistrictName: String,
Address_Physical: String,
Address_Mailing: String,
City: String,
Zip: String,
Zip_4: String,
StateId: 0,
State: String,
Phone: String,
NumEmployees: 0,
NumSchools: 0,
Type: String,
Status_NLG: False,
Status_Midland: False,
Status_Great_American: False,
Status_VOYA: False,
Status_Other: False,
OtherVendors: String,
IsClosed: False,
ModifiedBy: String,
DateModified: 0001-01-01,
MVP: 0,
RVP: 0,
Schools:
[
{
SchoolId: 0,
SchoolName: String,
AgentList:
[
{
AgentId: 0,
AgentName: String,
SlotDistrictApprovalID: 0
}
]
}
],
MilesAway: 0,
HasComments: False,
TPADocuments:
[
{
ID: 0,
DocumentUID: 00000000000000000000000000000000,
TPAID: 0,
TPATypeID: 0,
FileName: String,
FilePath: String,
FileSizeInKB: 0,
CreatedDate: 0001-01-01,
CreatedBy: String,
TPAName: String,
TPAType: String
}
],
TPA_403B: 0,
TPA_403B_Name: String,
TPA_403B_URL: String,
Website: String,
Notes: String,
Other403Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
],
Other457Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
],
OtherRoth403Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
],
OtherRoth457Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
]
},
ID: 0,
DistrictId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String
}
]
},
SlotDistrict:
[
{
ID: 0,
Name: String,
County: String,
DistrictId: 0,
DistrictName: String,
Address_Physical: String,
Address_Mailing: String,
City: String,
Zip: String,
Zip_4: String,
StateId: 0,
State: String,
Phone: String,
NumEmployees: 0,
NumSchools: 0,
Type: String,
Status_NLG: False,
Status_Midland: False,
Status_Great_American: False,
Status_VOYA: False,
Status_Other: False,
OtherVendors: String,
IsClosed: False,
ModifiedBy: String,
DateModified: 0001-01-01,
MVP: 0,
RVP: 0,
Schools:
[
{
SchoolId: 0,
SchoolName: String,
AgentList:
[
{
AgentId: 0,
AgentName: String,
SlotDistrictApprovalID: 0
}
]
}
],
MilesAway: 0,
HasComments: False,
TPADocuments:
[
{
ID: 0,
DocumentUID: 00000000000000000000000000000000,
TPAID: 0,
TPATypeID: 0,
FileName: String,
FilePath: String,
FileSizeInKB: 0,
CreatedDate: 0001-01-01,
CreatedBy: String,
TPAName: String,
TPAType: String
}
],
TPA_403B: 0,
TPA_403B_Name: String,
TPA_403B_URL: String,
Website: String,
Notes: String,
Other403Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
],
Other457Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
],
OtherRoth403Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
],
OtherRoth457Vendors:
[
{
ID: 0,
CommonName: String,
FullName: String,
Phone: String,
URL: String,
VendorType: String,
Name: String
}
]
}
]
}